Serviço Microsoft.ApiManagement/apis/tagDescriptions 2023-03-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso service/apis/tagDescriptions pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/tagDescriptions, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/apis/tagDescriptions@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    externalDocsDescription: 'string'
    externalDocsUrl: 'string'
  }
}

Valores de propriedade

service/apis/tagDescriptions

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: apis
propriedades Propriedades fornecidas para criar a operação TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

Nome Descrição Valor
descrição Descrição da Etiqueta. string
externalDocsDescription Descrição dos recursos externos que descrevem a etiqueta. string
externalDocsUrl URL absoluto de recursos externos que descreve a etiqueta. string

Definição de recurso do modelo arm

O tipo de recurso service/apis/tagDescriptions pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/tagDescriptions, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

service/apis/tagDescriptions

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis/tagDescriptions"
apiVersion A versão da API de recursos '2023-03-01-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.		 cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.
propriedades Propriedades fornecidas para criar a operação TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

Nome Descrição Valor
descrição Descrição da Etiqueta. string
externalDocsDescription Descrição dos recursos externos que descrevem a etiqueta. string
externalDocsUrl URL absoluto de recursos externos que descreve a etiqueta. string

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso service/apis/tagDescriptions pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/tagDescriptions, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

service/apis/tagDescriptions

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis/tagDescriptions@2023-03-01-preview"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-80

Carateres válidos:
Alfanuméricos e hífenes.

Comece com letra e termine com alfanumérico.
parent_id O ID do recurso que é o principal para este recurso. ID para recurso do tipo: apis
propriedades Propriedades fornecidas para a operação Criar TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

Nome Descrição Valor
descrição Descrição da Etiqueta. string
externalDocsDescription Descrição dos recursos externos que descrevem a etiqueta. string
externalDocsUrl URL absoluto de recursos externos que descreve a etiqueta. string