Microsoft.ApiManagement service/apis/tagDescriptions 2021-12-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp service/apis/tagDescriptions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/tagDescriptions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/apis/tagDescriptions@2021-12-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
externalDocsDescription: 'string'
externalDocsUrl: 'string'
}
}
Eigenschaftswerte
service/apis/tagDescriptions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
| parent | 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: apis |
| properties | Eigenschaften, die für den Vorgang "TagDescription erstellen" bereitgestellt werden. | TagDescriptionBasePropertiesOrTagDescriptionContract... |
TagDescriptionBasePropertiesOrTagDescriptionContract...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Beschreibung des Tags. | Zeichenfolge |
| externalDocsDescription | Beschreibung der externen Ressourcen, die das Tag beschreiben. | Zeichenfolge |
| externalDocsUrl | Absolute URL externer Ressourcen, die das Tag beschreiben. | Zeichenfolge |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp service/apis/tagDescriptions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Ressource Microsoft.ApiManagement/service/apis/tagDescriptions zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
"apiVersion": "2021-12-01-preview",
"name": "string",
"properties": {
"description": "string",
"externalDocsDescription": "string",
"externalDocsUrl": "string"
}
}
Eigenschaftswerte
service/apis/tagDescriptions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis/tagDescriptions" |
| apiVersion | Die Version der Ressourcen-API | "2021-12-01-preview" |
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
| properties | Eigenschaften, die für den Vorgang "TagDescription erstellen" bereitgestellt werden. | TagDescriptionBasePropertiesOrTagDescriptionContract... |
TagDescriptionBasePropertiesOrTagDescriptionContract...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Beschreibung des Tags. | Zeichenfolge |
| externalDocsDescription | Beschreibung der externen Ressourcen, die das Tag beschreiben. | Zeichenfolge |
| externalDocsUrl | Absolute URL externer Ressourcen, die das Tag beschreiben. | Zeichenfolge |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp service/apis/tagDescriptions kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/tagDescriptions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/tagDescriptions@2021-12-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
externalDocsDescription = "string"
externalDocsUrl = "string"
}
})
}
Eigenschaftswerte
service/apis/tagDescriptions
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.ApiManagement/service/apis/tagDescriptions@2021-12-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
| parent_id | Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. | ID für Ressource vom Typ: apis |
| properties | Eigenschaften, die für den Vorgang "TagDescription erstellen" bereitgestellt werden. | TagDescriptionBasePropertiesOrTagDescriptionContract... |
TagDescriptionBasePropertiesOrTagDescriptionContract...
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Beschreibung des Tags. | Zeichenfolge |
| externalDocsDescription | Beschreibung der externen Ressourcen, die das Tag beschreiben. | Zeichenfolge |
| externalDocsUrl | Absolute URL externer Ressourcen, die das Tag beschreiben. | Zeichenfolge |