Microsoft.ApiManagement service/apis/operations 2022-08-01
Bicep-resursdefinition
Resurstypen service/apis/operations kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/apis/operations-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
method: 'string'
policies: 'string'
request: {
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
queryParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
schemaId: 'string'
typeName: 'string'
}
]
}
responses: [
{
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
schemaId: 'string'
typeName: 'string'
}
]
statusCode: int
}
]
templateParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
Egenskapsvärden
service/apis/operations
Name | Beskrivning | Värde |
---|---|---|
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
parent | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför överordnad resurs. |
Symboliskt namn för resurs av typen: apis |
properties | Egenskaper för åtgärdskontraktet. | OperationContractProperties |
OperationContractProperties
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. | sträng |
displayName | Åtgärdsnamn. | sträng (krävs) |
metod | En giltig HTTP-åtgärdsmetod. Typiska HTTP-metoder som GET, PUT, POST men inte begränsas av bara dem. | sträng (krävs) |
policies | Åtgärdsprinciper | sträng |
Begäran | En entitet som innehåller information om begäran. | RequestContract |
Svaren | Matris med åtgärdssvar. | ResponseContract[] |
templateParameters | Samling url-mallparametrar. | ParameterContract[] |
urlTemplate | Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar. Exempel: /customers/{cid}/orders/{oid}/?date={date} | sträng (krävs) |
RequestContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av åtgärdsbegäran. | sträng |
Headers | Samling av åtgärdsbegärandehuvuden. | ParameterContract[] |
queryParameters | Samling frågeparametrar för åtgärdsbegäran. | ParameterContract[] |
Representationer | Samling av representationer av åtgärdsbegäranden. | RepresentationContract[] |
ParameterContract
Name | Beskrivning | Värde |
---|---|---|
Standardvärde | Standardparametervärde. | sträng |
beskrivning | Parameterbeskrivning. | sträng |
exempel | Exempel som definierats för parametern . | ParameterExamplesContract |
name | Parameternamn. | sträng (krävs) |
krävs | Anger om parametern krävs eller inte. | boolesk |
schemaId | Schemaidentifierare. | sträng |
typ | Parametertyp. | sträng (krävs) |
Typename | Typnamn som definieras av schemat. | sträng |
values | Parametervärden. | string[] |
ParameterExamplesContract
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | ParameterExampleContract | |
{anpassad egenskap} | ParameterExampleContract |
ParameterExampleContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Lång beskrivning av exemplet | sträng |
externalValue | En URL som pekar på literalexemplet | sträng |
sammanfattning | Kort beskrivning av exemplet | sträng |
värde | Exempelvärde. Kan vara ett primitivt värde eller ett objekt. | För Bicep kan du använda funktionen any(). |
RepresentationContract
Name | Beskrivning | Värde |
---|---|---|
Contenttype | Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. application/xml. | sträng (krävs) |
exempel | Exempel som definierats för representationen. | ParameterExamplesContract |
formParametrar | Samling av formulärparametrar. Krävs om värdet för "contentType" antingen är "application/x-www-form-urlencoded" eller "multipart/form-data". | ParameterContract[] |
schemaId | Schemaidentifierare. Gäller endast om "contentType"-värdet varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
Typename | Typnamn som definieras av schemat. Gäller endast om "contentType"-värdet varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
ResponseContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Åtgärdssvarsbeskrivning. | sträng |
Headers | Samling åtgärdssvarshuvuden. | ParameterContract[] |
Representationer | Samling av åtgärdssvarsrepresentationer. | RepresentationContract[] |
statusCode | HTTP-statuskod för åtgärdssvar. | int (obligatoriskt) |
Resursdefinition för ARM-mall
Resurstypen service/apis/operations kan distribueras med åtgärder som mål:
- Resursgrupper – Se kommandon för resursgruppsdistribution
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/apis/operations lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"method": "string",
"policies": "string",
"request": {
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"queryParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"schemaId": "string",
"typeName": "string"
}
]
},
"responses": [
{
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"schemaId": "string",
"typeName": "string"
}
],
"statusCode": "int"
}
],
"templateParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"urlTemplate": "string"
}
}
Egenskapsvärden
service/apis/operations
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/apis/operations" |
apiVersion | Resurs-API-versionen | '2022-08-01' |
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
properties | Egenskaper för åtgärdskontraktet. | OperationContractProperties |
OperationContractProperties
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. | sträng |
displayName | Åtgärdsnamn. | sträng (krävs) |
metod | En giltig HTTP-åtgärdsmetod. Typiska HTTP-metoder som GET, PUT, POST men inte begränsas av bara dem. | sträng (krävs) |
policies | Åtgärdsprinciper | sträng |
Begäran | En entitet som innehåller information om begäran. | RequestContract |
Svaren | Matris med åtgärdssvar. | ResponseContract[] |
templateParameters | Samling url-mallparametrar. | ParameterContract[] |
urlTemplate | Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar. Exempel: /customers/{cid}/orders/{oid}/?date={date} | sträng (krävs) |
RequestContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av åtgärdsbegäran. | sträng |
Headers | Samling av åtgärdsbegärandehuvuden. | ParameterContract[] |
queryParameters | Samling frågeparametrar för åtgärdsbegäran. | ParameterContract[] |
Representationer | Samling av representationer av åtgärdsbegäranden. | RepresentationContract[] |
ParameterContract
Name | Beskrivning | Värde |
---|---|---|
Standardvärde | Standardparametervärde. | sträng |
beskrivning | Parameterbeskrivning. | sträng |
exempel | Exempel som definierats för parametern . | ParameterExamplesContract |
name | Parameternamn. | sträng (krävs) |
krävs | Anger om parametern krävs eller inte. | boolesk |
schemaId | Schemaidentifierare. | sträng |
typ | Parametertyp. | sträng (krävs) |
Typename | Typnamn som definieras av schemat. | sträng |
values | Parametervärden. | string[] |
ParameterExamplesContract
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | ParameterExampleContract | |
{anpassad egenskap} | ParameterExampleContract |
ParameterExampleContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Lång beskrivning av exemplet | sträng |
externalValue | En URL som pekar på literalexemplet | sträng |
sammanfattning | Kort beskrivning av exemplet | sträng |
värde | Exempelvärde. Kan vara ett primitivt värde eller ett objekt. |
RepresentationContract
Name | Beskrivning | Värde |
---|---|---|
Contenttype | Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. application/xml. | sträng (krävs) |
exempel | Exempel som definierats för representationen. | ParameterExamplesContract |
formParametrar | Samling av formulärparametrar. Krävs om värdet för "contentType" antingen är "application/x-www-form-urlencoded" eller "multipart/form-data". | ParameterContract[] |
schemaId | Schemaidentifierare. Gäller endast om "contentType"-värdet varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
Typename | Typnamn som definieras av schemat. Gäller endast om "contentType"-värdet varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
ResponseContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Åtgärdssvarsbeskrivning. | sträng |
Headers | Samling åtgärdssvarshuvuden. | ParameterContract[] |
Representationer | Samling av åtgärdssvarsrepresentationer. | RepresentationContract[] |
statusCode | HTTP-statuskod för åtgärdssvar. | int (obligatoriskt) |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen service/apis/operations kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/apis/operations-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/operations@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
method = "string"
policies = "string"
request = {
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
queryParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
schemaId = "string"
typeName = "string"
}
]
}
responses = [
{
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
schemaId = "string"
typeName = "string"
}
]
statusCode = int
}
]
templateParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
urlTemplate = "string"
}
})
}
Egenskapsvärden
service/apis/operations
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/apis/operations@2022-08-01" |
name | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: apis |
properties | Egenskaper för åtgärdskontraktet. | OperationContractProperties |
OperationContractProperties
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. | sträng |
displayName | Åtgärdsnamn. | sträng (krävs) |
metod | En giltig HTTP-åtgärdsmetod. Typiska HTTP-metoder som GET, PUT, POST men inte begränsas av bara dem. | sträng (krävs) |
policies | Åtgärdsprinciper | sträng |
Begäran | En entitet som innehåller information om begäran. | RequestContract |
Svaren | Matris med åtgärdssvar. | ResponseContract[] |
templateParameters | Samling url-mallparametrar. | ParameterContract[] |
urlTemplate | Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar. Exempel: /customers/{cid}/orders/{oid}/?date={date} | sträng (krävs) |
RequestContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av åtgärdsbegäran. | sträng |
Headers | Samling av åtgärdsbegärandehuvuden. | ParameterContract[] |
queryParameters | Samling frågeparametrar för åtgärdsbegäran. | ParameterContract[] |
Representationer | Samling av representationer av åtgärdsbegäranden. | RepresentationContract[] |
ParameterContract
Name | Beskrivning | Värde |
---|---|---|
Standardvärde | Standardparametervärde. | sträng |
beskrivning | Parameterbeskrivning. | sträng |
exempel | Exempel som definierats för parametern . | ParameterExamplesContract |
name | Parameternamn. | sträng (krävs) |
krävs | Anger om parametern krävs eller inte. | boolesk |
schemaId | Schemaidentifierare. | sträng |
typ | Parametertyp. | sträng (krävs) |
Typename | Typnamn som definieras av schemat. | sträng |
values | Parametervärden. | string[] |
ParameterExamplesContract
Name | Beskrivning | Värde |
---|---|---|
{anpassad egenskap} | ParameterExampleContract | |
{anpassad egenskap} | ParameterExampleContract |
ParameterExampleContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Lång beskrivning av exemplet | sträng |
externalValue | En URL som pekar på literalexemplet | sträng |
sammanfattning | Kort beskrivning av exemplet | sträng |
värde | Exempelvärde. Kan vara ett primitivt värde eller ett objekt. |
RepresentationContract
Name | Beskrivning | Värde |
---|---|---|
Contenttype | Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. application/xml. | sträng (krävs) |
exempel | Exempel som definierats för representationen. | ParameterExamplesContract |
formParametrar | Samling av formulärparametrar. Krävs om värdet för "contentType" antingen är "application/x-www-form-urlencoded" eller "multipart/form-data". | ParameterContract[] |
schemaId | Schemaidentifierare. Gäller endast om "contentType"-värdet varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
Typename | Typnamn som definieras av schemat. Gäller endast om "contentType"-värdet varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
ResponseContract
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Åtgärdssvarsbeskrivning. | sträng |
Headers | Samling åtgärdssvarshuvuden. | ParameterContract[] |
Representationer | Samling av åtgärdssvarsrepresentationer. | RepresentationContract[] |
statusCode | HTTP-statuskod för åtgärdssvar. | int (obligatoriskt) |