Freigeben über


Microsoft.ApiManagement service/apis/tagDescriptions 2023-09-01-preview

Bicep-Ressourcendefinition

Der Ressourcentyp "service/apis/tagDescriptions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Ä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@2023-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    externalDocsDescription: 'string'
    externalDocsUrl: 'string'
  }
}

Eigenschaftswerte

Microsoft.ApiManagement/service/apis/tagDescriptions

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (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, die für den Create TagDescription-Vorgang bereitgestellt werden. TagDescriptionBasePropertiesOrTagDescriptionContractProperties

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Name Beschreibung Wert
Beschreibung Beschreibung des Tags. Schnur
externalDocsDescription Beschreibung der externen Ressourcen, die das Tag beschreiben. Schnur
externalDocsUrl Absolute URL externer Ressourcen, die das Tag beschreiben. Schnur

Zwänge:
Max. Länge =

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "service/apis/tagDescriptions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis/tagDescriptions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "externalDocsDescription": "string",
    "externalDocsUrl": "string"
  }
}

Eigenschaftswerte

Microsoft.ApiManagement/service/apis/tagDescriptions

Name Beschreibung Wert
apiVersion Die API-Version "2023-09-01-preview"
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Eigenschaften Eigenschaften, die für den Create TagDescription-Vorgang bereitgestellt werden. TagDescriptionBasePropertiesOrTagDescriptionContractProperties
Art Der Ressourcentyp 'Microsoft.ApiManagement/service/apis/tagDescriptions'

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Name Beschreibung Wert
Beschreibung Beschreibung des Tags. Schnur
externalDocsDescription Beschreibung der externen Ressourcen, die das Tag beschreiben. Schnur
externalDocsUrl Absolute URL externer Ressourcen, die das Tag beschreiben. Schnur

Zwänge:
Max. Länge =

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 unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis/tagDescriptions-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/tagDescriptions@2023-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      externalDocsDescription = "string"
      externalDocsUrl = "string"
    }
  })
}

Eigenschaftswerte

Microsoft.ApiManagement/service/apis/tagDescriptions

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[^*#&+:<>?]+$ (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, die für den Create TagDescription-Vorgang bereitgestellt werden. TagDescriptionBasePropertiesOrTagDescriptionContractProperties
Art Der Ressourcentyp "Microsoft.ApiManagement/service/apis/tagDescriptions@2023-09-01-preview"

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Name Beschreibung Wert
Beschreibung Beschreibung des Tags. Schnur
externalDocsDescription Beschreibung der externen Ressourcen, die das Tag beschreiben. Schnur
externalDocsUrl Absolute URL externer Ressourcen, die das Tag beschreiben. Schnur

Zwänge:
Max. Länge =