Microsoft.ApiManagement-tjänsten/apis/operations
Bicep-resursdefinition
Resurstypen tjänst/apis/operations kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
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@2023-09-01-preview' = {
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()
}
}
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()
}
}
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()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{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()
}
}
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()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{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()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
Egenskapsvärden
service/apis/operations
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | 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. |
| förälder | 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 den överordnade resursen. |
Symboliskt namn för resurs av typen: api:ar |
| Egenskaper | Egenskaper för åtgärdskontraktet. | OperationContractProperties |
OperationContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. | sträng Begränsningar: Maxlängd = 1 000 |
| displayName | Åtgärdsnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300 |
| metod | En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem. | sträng (krävs) |
| Politik | Å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) Begränsningar: Min längd = 1 Maxlängd = 1 000 |
RequestContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärdsbegäran. | sträng |
| Headers | Samling med sidhuvuden för åtgärdsbegäran. | ParameterContract[] |
| queryParameters | Samling frågeparametrar för åtgärdsbegäran. | ParameterContract[] |
| kritiska anmärkningar | Samling av representationer av åtgärdsbegäran. | RepresentationContract[] |
ParameterContract
| Namn | Beskrivning | Värde |
|---|---|---|
| defaultValue | Standardparametervärde. | sträng |
| beskrivning | Parameterbeskrivning. | sträng |
| Exempel | Exempel som definierats för parametern. | ParameterExamplesContract |
| Namn | Parameternamn. | sträng (krävs) |
| krävs | Anger om parametern krävs eller inte. | Bool |
| schemaId | Schemaidentifierare. | sträng |
| typ | Parametertyp. | sträng (krävs) |
| typeName | Typnamn som definierats av schemat. | sträng |
| värden | Parametervärden. | string[] |
ParameterExamplesContract
| Namn | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | ParameterExampleContract |
ParameterExampleContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Lång beskrivning av exemplet | sträng |
| externalValue | En URL som pekar på literalexemplet | sträng |
| sammanfattning | Kort beskrivning för 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
| Namn | Beskrivning | Värde |
|---|---|---|
| contentType | Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. program/xml. | sträng (krävs) |
| Exempel | Exempel som definierats för representationen. | ParameterExamplesContract |
| formParametrar | Insamling 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 värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
| typeName | Typnamn som definierats av schemat. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
ResponseContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärdssvar. | sträng |
| Headers | Samling av åtgärdssvarshuvuden. | ParameterContract[] |
| kritiska anmärkningar | Samling av åtgärdssvarsrepresentationer. | RepresentationContract[] |
| statusCode | Http-statuskod för åtgärdssvar. | int (krävs) |
Resursdefinition för ARM-mall
Resurstypen tjänst/apis/operations kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
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 JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2023-09-01-preview",
"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": {}
}
},
"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": {}
}
},
"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": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{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": {}
}
},
"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": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{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": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"urlTemplate": "string"
}
}
Egenskapsvärden
service/apis/operations
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/apis/operations" |
| apiVersion | Resurs-API-versionen | "2023-09-01-preview" |
| Namn | 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. |
| Egenskaper | Egenskaper för åtgärdskontraktet. | OperationContractProperties |
OperationContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. | sträng Begränsningar: Maxlängd = 1 000 |
| displayName | Åtgärdsnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300 |
| metod | En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem. | sträng (krävs) |
| Politik | Å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) Begränsningar: Min längd = 1 Maxlängd = 1 000 |
RequestContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärdsbegäran. | sträng |
| Headers | Samling med sidhuvuden för åtgärdsbegäran. | ParameterContract[] |
| queryParameters | Samling frågeparametrar för åtgärdsbegäran. | ParameterContract[] |
| kritiska anmärkningar | Samling av representationer av åtgärdsbegäran. | RepresentationContract[] |
ParameterContract
| Namn | Beskrivning | Värde |
|---|---|---|
| defaultValue | Standardparametervärde. | sträng |
| beskrivning | Parameterbeskrivning. | sträng |
| Exempel | Exempel som definierats för parametern. | ParameterExamplesContract |
| Namn | Parameternamn. | sträng (krävs) |
| krävs | Anger om parametern krävs eller inte. | Bool |
| schemaId | Schemaidentifierare. | sträng |
| typ | Parametertyp. | sträng (krävs) |
| typeName | Typnamn som definierats av schemat. | sträng |
| värden | Parametervärden. | string[] |
ParameterExamplesContract
| Namn | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | ParameterExampleContract |
ParameterExampleContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Lång beskrivning av exemplet | sträng |
| externalValue | En URL som pekar på literalexemplet | sträng |
| sammanfattning | Kort beskrivning för exemplet | sträng |
| värde | Exempelvärde. Kan vara ett primitivt värde eller ett objekt. |
RepresentationContract
| Namn | Beskrivning | Värde |
|---|---|---|
| contentType | Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. program/xml. | sträng (krävs) |
| Exempel | Exempel som definierats för representationen. | ParameterExamplesContract |
| formParametrar | Insamling 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 värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
| typeName | Typnamn som definierats av schemat. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
ResponseContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärdssvar. | sträng |
| Headers | Samling av åtgärdssvarshuvuden. | ParameterContract[] |
| kritiska anmärkningar | Samling av åtgärdssvarsrepresentationer. | RepresentationContract[] |
| statusCode | Http-statuskod för åtgärdssvar. | int (krävs) |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen tjänst/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@2023-09-01-preview"
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"
}
}
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"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{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"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{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"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
urlTemplate = "string"
}
})
}
Egenskapsvärden
service/apis/operations
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/apis/operations@2023-09-01-preview" |
| Namn | 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 |
| Egenskaper | Egenskaper för åtgärdskontraktet. | OperationContractProperties |
OperationContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärden. Kan innehålla HTML-formateringstaggar. | sträng Begränsningar: Maxlängd = 1 000 |
| displayName | Åtgärdsnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300 |
| metod | En giltig HTTP-åtgärdsmetod. Typiska Http-metoder som GET, PUT, POST men inte begränsas av bara dem. | sträng (krävs) |
| Politik | Å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) Begränsningar: Min längd = 1 Maxlängd = 1 000 |
RequestContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärdsbegäran. | sträng |
| Headers | Samling med sidhuvuden för åtgärdsbegäran. | ParameterContract[] |
| queryParameters | Samling frågeparametrar för åtgärdsbegäran. | ParameterContract[] |
| kritiska anmärkningar | Samling av representationer av åtgärdsbegäran. | RepresentationContract[] |
ParameterContract
| Namn | Beskrivning | Värde |
|---|---|---|
| defaultValue | Standardparametervärde. | sträng |
| beskrivning | Parameterbeskrivning. | sträng |
| Exempel | Exempel som definierats för parametern. | ParameterExamplesContract |
| Namn | Parameternamn. | sträng (krävs) |
| krävs | Anger om parametern krävs eller inte. | Bool |
| schemaId | Schemaidentifierare. | sträng |
| typ | Parametertyp. | sträng (krävs) |
| typeName | Typnamn som definierats av schemat. | sträng |
| värden | Parametervärden. | string[] |
ParameterExamplesContract
| Namn | Beskrivning | Värde |
|---|---|---|
| {anpassad egenskap} | ParameterExampleContract |
ParameterExampleContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Lång beskrivning av exemplet | sträng |
| externalValue | En URL som pekar på literalexemplet | sträng |
| sammanfattning | Kort beskrivning för exemplet | sträng |
| värde | Exempelvärde. Kan vara ett primitivt värde eller ett objekt. |
RepresentationContract
| Namn | Beskrivning | Värde |
|---|---|---|
| contentType | Anger en registrerad eller anpassad innehållstyp för den här representationen, t.ex. program/xml. | sträng (krävs) |
| Exempel | Exempel som definierats för representationen. | ParameterExamplesContract |
| formParametrar | Insamling 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 värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
| typeName | Typnamn som definierats av schemat. Gäller endast om värdet "contentType" varken är "application/x-www-form-urlencoded" eller "multipart/form-data". | sträng |
ResponseContract
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av åtgärdssvar. | sträng |
| Headers | Samling av åtgärdssvarshuvuden. | ParameterContract[] |
| kritiska anmärkningar | Samling av åtgärdssvarsrepresentationer. | RepresentationContract[] |
| statusCode | Http-statuskod för åtgärdssvar. | int (krävs) |