Partilhar via

Microsoft.ApiManagement service/apis/tagDescriptions 2021-04-01-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso service/apis/tagDescriptions pode ser implantado com operações direcionadas:

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

Formato do recurso

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

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

Valores de propriedade

Microsoft.ApiManagement/service/apis/tagDescriptions

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: service/apis
propriedades Propriedades fornecidas para a operação Create TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContractProperties

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Designação Descrição Valor
Descrição Descrição da tag. string
externalDocsDescrição Descrição dos recursos externos que descrevem a tag. string
externalDocsUrl URL absoluta de recursos externos que descrevem a tag. string

Restrições:
Comprimento máximo = 2000

Definição de recurso de modelo ARM

O tipo de recurso service/apis/tagDescriptions pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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": "2021-04-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "externalDocsDescription": "string",
    "externalDocsUrl": "string"
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/apis/tagDescriptions

Designação Descrição Valor
apiVersion A versão api '2021-04-01-pré-visualização'
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
propriedades Propriedades fornecidas para a operação Create TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/apis/tagDescriptions'

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Designação Descrição Valor
Descrição Descrição da tag. string
externalDocsDescrição Descrição dos recursos externos que descrevem a tag. string
externalDocsUrl URL absoluta de recursos externos que descrevem a tag. string

Restrições:
Comprimento máximo = 2000

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso service/apis/tagDescriptions pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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@2021-04-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      externalDocsDescription = "string"
      externalDocsUrl = "string"
    }
  })
}

Valores de propriedade

Microsoft.ApiManagement/service/apis/tagDescriptions

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: service/apis
propriedades Propriedades fornecidas para a operação Create TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis/tagDescriptions@2021-04-01-preview"

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Designação Descrição Valor
Descrição Descrição da tag. string
externalDocsDescrição Descrição dos recursos externos que descrevem a tag. string
externalDocsUrl URL absoluta de recursos externos que descrevem a tag. string

Restrições:
Comprimento máximo = 2000