Serviço Microsoft.ApiManagement/apiVersionSets

  • Artigo

Definição de recursos do bíceps

O tipo de recurso service/apiVersionSets pode ser implantado com operações que visam:

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/apiVersionSets, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

Valores de propriedade

service/apiVersionSets

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

Veja como definir nomes e tipos para recursos filho no Bicep.		 string (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: serviço
propriedades API VersionSet propriedades do contrato. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Designação Descrição Valor
Descrição Descrição do conjunto de versões da API. string
displayName Nome do conjunto de versões da API string (obrigatório)

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100
versionHeaderName Nome do parâmetro de cabeçalho HTTP que indica a versão da API se versioningScheme estiver definido como header. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100
versionamentoScheme Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP. 'Cabeçalho'
'Consulta'
'Segmento' (obrigatório)
versionQueryName Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100

Definição de recurso de modelo ARM

O tipo de recurso service/apiVersionSets pode ser implantado com operações que visam:

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/apiVersionSets, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/apiVersionSets",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

Valores de propriedade

service/apiVersionSets

Designação Descrição Valor
tipo O tipo de recurso 'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion A versão da api de recursos '2023-09-01-pré-visualização'
Designação O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos JSON ARM.		 string (obrigatório)
propriedades API VersionSet propriedades do contrato. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Designação Descrição Valor
Descrição Descrição do conjunto de versões da API. string
displayName Nome do conjunto de versões da API string (obrigatório)

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100
versionHeaderName Nome do parâmetro de cabeçalho HTTP que indica a versão da API se versioningScheme estiver definido como header. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100
versionamentoScheme Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP. 'Cabeçalho'
'Consulta'
'Segmento' (obrigatório)
versionQueryName Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso service/apiVersionSets pode ser implantado com operações que visam:

  • 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/apiVersionSets, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

Valores de propriedade

service/apiVersionSets

Designação Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview"
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: serviço
propriedades API VersionSet propriedades do contrato. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Designação Descrição Valor
Descrição Descrição do conjunto de versões da API. string
displayName Nome do conjunto de versões da API string (obrigatório)

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100
versionHeaderName Nome do parâmetro de cabeçalho HTTP que indica a versão da API se versioningScheme estiver definido como header. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100
versionamentoScheme Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP. "Cabeçalho"
"Consulta"
"Segmento" (obrigatório)
versionQueryName Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 100