Microsoft.ApiManagement service/apis/operations 2021-01-01-preview
- neueste
- 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-Vorschau-
- 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-Ressourcendefinition
Der Ressourcentyp "service/apis/operations" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/operations-Ressource zu erstellen, fügen Sie ihrer Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2021-01-01-preview' = {
parent: resourceSymbolicName
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: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
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(Azure.Bicep.Types.Concrete.AnyType)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
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(Azure.Bicep.Types.Concrete.AnyType)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
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(Azure.Bicep.Types.Concrete.AnyType)
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
Eigenschaftswerte
Microsoft.ApiManagement/service/apis/operations
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Elternteil | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: Dienst/APIs |
| Eigenschaften | Eigenschaften des Vorgangsvertrags. | OperationContractProperties |
OperationContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten. | Schnur Zwänge: Max. Länge = |
| displayName | Vorgangsname. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Methode | Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt. | Zeichenfolge (erforderlich) |
| Politik | Vorgangsrichtlinien | Schnur |
| bitten | Eine Entität, die Anforderungsdetails enthält. | RequestContract- |
| Antworten | Array von Vorgangsantworten. | ResponseContract[] |
| templateParameters | Sammlung von URL-Vorlagenparametern. | ParameterContract[] |
| urlTemplate | Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date} | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
ParameterContract
| Name | Beschreibung | Wert |
|---|---|---|
| defaultValue | Standardwert. | Schnur |
| Beschreibung | Parameterbeschreibung. | Schnur |
| Beispiele | Beispiel für den Parameter. | ParameterExamplesContract |
| Name | Parametername. | Zeichenfolge (erforderlich) |
| Erforderlich | Gibt an, ob der Parameter erforderlich ist oder nicht. | Bool |
| schemaId | Schemabezeichner. | Schnur |
| Art | Parametertyp. | Zeichenfolge (erforderlich) |
| typeName | Typname, der durch das Schema definiert ist. | Schnur |
| Werte | Parameterwerte. | string[] |
ParameterExampleContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Lange Beschreibung für das Beispiel | Schnur |
| externalValue | Eine URL, die auf das Literalbeispiel verweist | Schnur |
| Zusammenfassung | Kurze Beschreibung für das Beispiel | Schnur |
| Wert | Beispielwert. Kann ein Grundtypwert oder ein Objekt sein. | jegliche |
ParameterExamplesContract
| Name | Beschreibung | Wert |
|---|
RepresentationContract
| Name | Beschreibung | Wert |
|---|---|---|
| contentType | Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml. | Zeichenfolge (erforderlich) |
| formParameters | Sammlung von Formularparametern. Erforderlich, wenn der Wert "contentType" entweder "application/x-www-form-urlencoded" oder "multipart/form-data" ist. | ParameterContract[] |
| schemaId | Schemabezeichner. Gilt nur, wenn der Wert "contentType" weder 'application/x-www-form-urlencoded' noch "multipart/form-data" ist. | Schnur |
| typeName | Typname, der durch das Schema definiert ist. Gilt nur, wenn der Wert "contentType" weder 'application/x-www-form-urlencoded' noch "multipart/form-data" ist. | Schnur |
RequestContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung der Vorgangsanforderung. | Schnur |
| Header | Sammlung von Vorgangsanforderungsheadern. | ParameterContract[] |
| queryParameters | Sammlung der Abfrageparameter der Vorgangsanforderung. | ParameterContract[] |
| darstellungen | Sammlung von Vorgangsanforderungsdarstellungen. | RepresentationContract[] |
ResponseContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung der Vorgangsantwort. | Schnur |
| Header | Sammlung von Vorgangsantwortheadern. | ParameterContract[] |
| darstellungen | Sammlung von Vorgangsantwortdarstellungen. | RepresentationContract[] |
| statusCode | HTTP-Statuscode der Vorgangsantwort. | int (erforderlich) |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "service/apis/operations" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/operations-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2021-01-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",
"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",
"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"
}
}
Eigenschaftswerte
Microsoft.ApiManagement/service/apis/operations
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | "2021-01-01-preview" |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Eigenschaften | Eigenschaften des Vorgangsvertrags. | OperationContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis/operations" |
OperationContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten. | Schnur Zwänge: Max. Länge = |
| displayName | Vorgangsname. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Methode | Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt. | Zeichenfolge (erforderlich) |
| Politik | Vorgangsrichtlinien | Schnur |
| bitten | Eine Entität, die Anforderungsdetails enthält. | RequestContract- |
| Antworten | Array von Vorgangsantworten. | ResponseContract[] |
| templateParameters | Sammlung von URL-Vorlagenparametern. | ParameterContract[] |
| urlTemplate | Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date} | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
ParameterContract
| Name | Beschreibung | Wert |
|---|---|---|
| defaultValue | Standardwert. | Schnur |
| Beschreibung | Parameterbeschreibung. | Schnur |
| Beispiele | Beispiel für den Parameter. | ParameterExamplesContract |
| Name | Parametername. | Zeichenfolge (erforderlich) |
| Erforderlich | Gibt an, ob der Parameter erforderlich ist oder nicht. | Bool |
| schemaId | Schemabezeichner. | Schnur |
| Art | Parametertyp. | Zeichenfolge (erforderlich) |
| typeName | Typname, der durch das Schema definiert ist. | Schnur |
| Werte | Parameterwerte. | string[] |
ParameterExampleContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Lange Beschreibung für das Beispiel | Schnur |
| externalValue | Eine URL, die auf das Literalbeispiel verweist | Schnur |
| Zusammenfassung | Kurze Beschreibung für das Beispiel | Schnur |
| Wert | Beispielwert. Kann ein Grundtypwert oder ein Objekt sein. | jegliche |
ParameterExamplesContract
| Name | Beschreibung | Wert |
|---|
RepresentationContract
| Name | Beschreibung | Wert |
|---|---|---|
| contentType | Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml. | Zeichenfolge (erforderlich) |
| formParameters | Sammlung von Formularparametern. Erforderlich, wenn der Wert "contentType" entweder "application/x-www-form-urlencoded" oder "multipart/form-data" ist. | ParameterContract[] |
| schemaId | Schemabezeichner. Gilt nur, wenn der Wert "contentType" weder 'application/x-www-form-urlencoded' noch "multipart/form-data" ist. | Schnur |
| typeName | Typname, der durch das Schema definiert ist. Gilt nur, wenn der Wert "contentType" weder 'application/x-www-form-urlencoded' noch "multipart/form-data" ist. | Schnur |
RequestContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung der Vorgangsanforderung. | Schnur |
| Header | Sammlung von Vorgangsanforderungsheadern. | ParameterContract[] |
| queryParameters | Sammlung der Abfrageparameter der Vorgangsanforderung. | ParameterContract[] |
| darstellungen | Sammlung von Vorgangsanforderungsdarstellungen. | RepresentationContract[] |
ResponseContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung der Vorgangsantwort. | Schnur |
| Header | Sammlung von Vorgangsantwortheadern. | ParameterContract[] |
| darstellungen | Sammlung von Vorgangsantwortdarstellungen. | RepresentationContract[] |
| statusCode | HTTP-Statuscode der Vorgangsantwort. | int (erforderlich) |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "service/apis/operations" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/operations-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/operations@2021-01-01-preview"
name = "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"
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"
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"
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"
}
})
}
Eigenschaftswerte
Microsoft.ApiManagement/service/apis/operations
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst/APIs |
| Eigenschaften | Eigenschaften des Vorgangsvertrags. | OperationContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis/operations@2021-01-01-preview" |
OperationContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung des Vorgangs. Kann HTML-Formatierungstags enthalten. | Schnur Zwänge: Max. Länge = |
| displayName | Vorgangsname. | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Methode | Eine gültige HTTP-Vorgangsmethode. Typische HTTP-Methoden wie GET, PUT, POST, aber nicht nur durch sie beschränkt. | Zeichenfolge (erforderlich) |
| Politik | Vorgangsrichtlinien | Schnur |
| bitten | Eine Entität, die Anforderungsdetails enthält. | RequestContract- |
| Antworten | Array von Vorgangsantworten. | ResponseContract[] |
| templateParameters | Sammlung von URL-Vorlagenparametern. | ParameterContract[] |
| urlTemplate | Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date} | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
ParameterContract
| Name | Beschreibung | Wert |
|---|---|---|
| defaultValue | Standardwert. | Schnur |
| Beschreibung | Parameterbeschreibung. | Schnur |
| Beispiele | Beispiel für den Parameter. | ParameterExamplesContract |
| Name | Parametername. | Zeichenfolge (erforderlich) |
| Erforderlich | Gibt an, ob der Parameter erforderlich ist oder nicht. | Bool |
| schemaId | Schemabezeichner. | Schnur |
| Art | Parametertyp. | Zeichenfolge (erforderlich) |
| typeName | Typname, der durch das Schema definiert ist. | Schnur |
| Werte | Parameterwerte. | string[] |
ParameterExampleContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Lange Beschreibung für das Beispiel | Schnur |
| externalValue | Eine URL, die auf das Literalbeispiel verweist | Schnur |
| Zusammenfassung | Kurze Beschreibung für das Beispiel | Schnur |
| Wert | Beispielwert. Kann ein Grundtypwert oder ein Objekt sein. | jegliche |
ParameterExamplesContract
| Name | Beschreibung | Wert |
|---|
RepresentationContract
| Name | Beschreibung | Wert |
|---|---|---|
| contentType | Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml. | Zeichenfolge (erforderlich) |
| formParameters | Sammlung von Formularparametern. Erforderlich, wenn der Wert "contentType" entweder "application/x-www-form-urlencoded" oder "multipart/form-data" ist. | ParameterContract[] |
| schemaId | Schemabezeichner. Gilt nur, wenn der Wert "contentType" weder 'application/x-www-form-urlencoded' noch "multipart/form-data" ist. | Schnur |
| typeName | Typname, der durch das Schema definiert ist. Gilt nur, wenn der Wert "contentType" weder 'application/x-www-form-urlencoded' noch "multipart/form-data" ist. | Schnur |
RequestContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung der Vorgangsanforderung. | Schnur |
| Header | Sammlung von Vorgangsanforderungsheadern. | ParameterContract[] |
| queryParameters | Sammlung der Abfrageparameter der Vorgangsanforderung. | ParameterContract[] |
| darstellungen | Sammlung von Vorgangsanforderungsdarstellungen. | RepresentationContract[] |
ResponseContract
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Beschreibung der Vorgangsantwort. | Schnur |
| Header | Sammlung von Vorgangsantwortheadern. | ParameterContract[] |
| darstellungen | Sammlung von Vorgangsantwortdarstellungen. | RepresentationContract[] |
| statusCode | HTTP-Statuscode der Vorgangsantwort. | int (erforderlich) |