Microsoft.ApiManagement-service/apis/operations 2018-01-01
- meest recente
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview-
- 2023-03-01-preview-
- 2022-09-01-preview-
- 2022-08-01
- 2022-04-01-preview-
- 2021-12-01-preview-
- 2021-08-01
- 2021-04-01-preview-
- 2021-01-01-preview-
- 2020-12-01
- 2020-06-01-preview-
- 2019-12-01
- 2019-12-01-preview-
- 2019-01-01
- 2018-06-01-preview-
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep-resourcedefinitie
Het resourcetype service/apis/operations kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.ApiManagement/service/apis/operations wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2018-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
displayName: 'string'
method: 'string'
policies: 'string'
request: {
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
values: [
'string'
]
}
]
queryParameters: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
formParameters: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
values: [
'string'
]
}
]
sample: 'string'
schemaId: 'string'
typeName: 'string'
}
]
}
responses: [
{
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
formParameters: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
values: [
'string'
]
}
]
sample: 'string'
schemaId: 'string'
typeName: 'string'
}
]
statusCode: int
}
]
templateParameters: [
{
defaultValue: 'string'
description: 'string'
name: 'string'
required: bool
type: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
Eigenschapswaarden
Microsoft.ApiManagement/service/apis/operations
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (vereist) |
| ouder | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie. |
Symbolische naam voor resource van het type: service/api's |
| Eigenschappen | Eigenschappen van het bewerkingscontract. | OperationContractProperties- |
OperationContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. | snaar Beperkingen: Maximale lengte = |
| displayName | Bewerkingsnaam. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
| methode | Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. | tekenreeks (vereist) |
| Beleid | Bewerkingsbeleid | snaar |
| verzoek | Een entiteit met aanvraaggegevens. | RequestContract |
| Reacties | Matrix van bewerkingsreacties. | ResponseContract[] |
| templateParameters | Verzameling url-sjabloonparameters. | ParameterContract[] |
| urlTemplate | Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
ParameterContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| defaultValue | Standaardparameterwaarde. | snaar |
| beschrijving | Parameterbeschrijving. | snaar |
| naam | Parameternaam. | tekenreeks (vereist) |
| Vereist | of parameter vereist is of niet. | Bool |
| type | Parametertype. | tekenreeks (vereist) |
| waarden | Parameterwaarden. | tekenreeks[] |
RepresentationContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| contentType | Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. | tekenreeks (vereist) |
| formParameters | Verzameling formulierparameters. Vereist als de waarde 'contentType' 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | ParameterContract[] |
| monster | Een voorbeeld van de weergave. | snaar |
| schemaId | Schema-id. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | snaar |
| typeName | Typ de naam die is gedefinieerd door het schema. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | snaar |
RequestContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van bewerkingsaanvraag. | snaar |
| Headers | Verzameling aanvraagheaders voor bewerkingen. | ParameterContract[] |
| queryParameters | Verzameling queryparameters voor bewerkingsaanvragen. | ParameterContract[] |
| Vertegenwoordigingen | Verzameling weergaven van bewerkingsaanvragen. | RepresentationContract[] |
ResponseContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van het antwoord van de bewerking. | snaar |
| Headers | Verzameling antwoordheaders voor bewerkingen. | ParameterContract[] |
| Vertegenwoordigingen | Verzameling weergaven van bewerkingsreacties. | RepresentationContract[] |
| statusCode | HTTP-statuscode van het bewerkingsantwoord. | int (vereist) |
Resourcedefinitie van ARM-sjabloon
Het resourcetype service/apis/operations kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.ApiManagement/service/apis/operations wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2018-01-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"method": "string",
"policies": "string",
"request": {
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string",
"values": [ "string" ]
}
],
"queryParameters": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string",
"values": [ "string" ]
}
],
"sample": "string",
"schemaId": "string",
"typeName": "string"
}
]
},
"responses": [
{
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string",
"values": [ "string" ]
}
],
"sample": "string",
"schemaId": "string",
"typeName": "string"
}
],
"statusCode": "int"
}
],
"templateParameters": [
{
"defaultValue": "string",
"description": "string",
"name": "string",
"required": "bool",
"type": "string",
"values": [ "string" ]
}
],
"urlTemplate": "string"
}
}
Eigenschapswaarden
Microsoft.ApiManagement/service/apis/operations
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2018-01-01' |
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (vereist) |
| Eigenschappen | Eigenschappen van het bewerkingscontract. | OperationContractProperties- |
| type | Het resourcetype | 'Microsoft.ApiManagement/service/apis/operations' |
OperationContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. | snaar Beperkingen: Maximale lengte = |
| displayName | Bewerkingsnaam. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
| methode | Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. | tekenreeks (vereist) |
| Beleid | Bewerkingsbeleid | snaar |
| verzoek | Een entiteit met aanvraaggegevens. | RequestContract |
| Reacties | Matrix van bewerkingsreacties. | ResponseContract[] |
| templateParameters | Verzameling url-sjabloonparameters. | ParameterContract[] |
| urlTemplate | Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
ParameterContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| defaultValue | Standaardparameterwaarde. | snaar |
| beschrijving | Parameterbeschrijving. | snaar |
| naam | Parameternaam. | tekenreeks (vereist) |
| Vereist | of parameter vereist is of niet. | Bool |
| type | Parametertype. | tekenreeks (vereist) |
| waarden | Parameterwaarden. | tekenreeks[] |
RepresentationContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| contentType | Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. | tekenreeks (vereist) |
| formParameters | Verzameling formulierparameters. Vereist als de waarde 'contentType' 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | ParameterContract[] |
| monster | Een voorbeeld van de weergave. | snaar |
| schemaId | Schema-id. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | snaar |
| typeName | Typ de naam die is gedefinieerd door het schema. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | snaar |
RequestContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van bewerkingsaanvraag. | snaar |
| Headers | Verzameling aanvraagheaders voor bewerkingen. | ParameterContract[] |
| queryParameters | Verzameling queryparameters voor bewerkingsaanvragen. | ParameterContract[] |
| Vertegenwoordigingen | Verzameling weergaven van bewerkingsaanvragen. | RepresentationContract[] |
ResponseContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van het antwoord van de bewerking. | snaar |
| Headers | Verzameling antwoordheaders voor bewerkingen. | ParameterContract[] |
| Vertegenwoordigingen | Verzameling weergaven van bewerkingsreacties. | RepresentationContract[] |
| statusCode | HTTP-statuscode van het bewerkingsantwoord. | int (vereist) |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype service/apis/operations kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.ApiManagement/service/apis/operations wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/operations@2018-01-01"
name = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
method = "string"
policies = "string"
request = {
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
values = [
"string"
]
}
]
queryParameters = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
formParameters = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
values = [
"string"
]
}
]
sample = "string"
schemaId = "string"
typeName = "string"
}
]
}
responses = [
{
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
formParameters = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
values = [
"string"
]
}
]
sample = "string"
schemaId = "string"
typeName = "string"
}
]
statusCode = int
}
]
templateParameters = [
{
defaultValue = "string"
description = "string"
name = "string"
required = bool
type = "string"
values = [
"string"
]
}
]
urlTemplate = "string"
}
})
}
Eigenschapswaarden
Microsoft.ApiManagement/service/apis/operations
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (vereist) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: service/API's |
| Eigenschappen | Eigenschappen van het bewerkingscontract. | OperationContractProperties- |
| type | Het resourcetype | "Microsoft.ApiManagement/service/apis/operations@2018-01-01" |
OperationContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. | snaar Beperkingen: Maximale lengte = |
| displayName | Bewerkingsnaam. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
| methode | Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. | tekenreeks (vereist) |
| Beleid | Bewerkingsbeleid | snaar |
| verzoek | Een entiteit met aanvraaggegevens. | RequestContract |
| Reacties | Matrix van bewerkingsreacties. | ResponseContract[] |
| templateParameters | Verzameling url-sjabloonparameters. | ParameterContract[] |
| urlTemplate | Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 (vereist) |
ParameterContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| defaultValue | Standaardparameterwaarde. | snaar |
| beschrijving | Parameterbeschrijving. | snaar |
| naam | Parameternaam. | tekenreeks (vereist) |
| Vereist | of parameter vereist is of niet. | Bool |
| type | Parametertype. | tekenreeks (vereist) |
| waarden | Parameterwaarden. | tekenreeks[] |
RepresentationContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| contentType | Hiermee geeft u een geregistreerd of aangepast inhoudstype voor deze weergave, bijvoorbeeld application/xml. | tekenreeks (vereist) |
| formParameters | Verzameling formulierparameters. Vereist als de waarde 'contentType' 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | ParameterContract[] |
| monster | Een voorbeeld van de weergave. | snaar |
| schemaId | Schema-id. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | snaar |
| typeName | Typ de naam die is gedefinieerd door het schema. Alleen van toepassing als de waarde contentType niet 'application/x-www-form-urlencoded' of 'multipart/form-data' is. | snaar |
RequestContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van bewerkingsaanvraag. | snaar |
| Headers | Verzameling aanvraagheaders voor bewerkingen. | ParameterContract[] |
| queryParameters | Verzameling queryparameters voor bewerkingsaanvragen. | ParameterContract[] |
| Vertegenwoordigingen | Verzameling weergaven van bewerkingsaanvragen. | RepresentationContract[] |
ResponseContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van het antwoord van de bewerking. | snaar |
| Headers | Verzameling antwoordheaders voor bewerkingen. | ParameterContract[] |
| Vertegenwoordigingen | Verzameling weergaven van bewerkingsreacties. | RepresentationContract[] |
| statusCode | HTTP-statuscode van het bewerkingsantwoord. | int (vereist) |