Compartilhar via

Serviço/produtos Microsoft.ApiManagement

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de serviço/produtos 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 de recurso

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

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

Valores de propriedade

serviço/produtos

Nome Descrição Valor
name O nome do recurso

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

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
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 o recurso do tipo: serviço
properties Propriedades do contrato de entidade do produto. ProductContractProperties

ProductContractProperties

Nome Descrição Valor
approvalRequired se a aprovação da assinatura é necessária. Se for false, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se for true, os administradores devem aprovar manualmente a assinatura antes que o desenvolvedor possa qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de false. bool
descrição Descrição do produto. Pode incluir marcas de formatação HTML. string
displayName Nome do produto. cadeia de caracteres (obrigatório)
state se o produto é publicado ou não. Os produtos publicados são detectáveis por usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para os administradores. O estado padrão do Produto não é publicado. 'notPublished'
'publicado'
subscriptionRequired Se uma assinatura de produto é necessária para acessar APIs incluídas neste produto. Se for true, o produto será chamado de "protegido" e uma chave de assinatura válida será necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se for falso, o produto será chamado de "aberto" e as solicitações para uma API incluída no produto poderão ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será considerado verdadeiro. bool
subscriptionsLimit Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como nulo ou omita para permitir assinaturas ilimitadas por usuário. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de false. INT
terms Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto verão e deverão aceitar esses termos para concluir o processo de assinatura. string

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando um modelo

Implantar no Azure		 Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar sub-entidades
Criar o Azure Front Door na frente do Azure Gerenciamento de API

Implantar no Azure		 Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Azure Gerenciamento de API.

Definição de recurso de modelo do ARM

O tipo de recurso de serviço/produtos 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 de recurso

Para criar um recurso Microsoft.ApiManagement/service/products, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

Valores de propriedade

serviço/produtos

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

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
properties Propriedades do contrato de entidade do produto. ProductContractProperties

ProductContractProperties

Nome Descrição Valor
approvalRequired se a aprovação da assinatura é necessária. Se for false, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se for true, os administradores deverão aprovar manualmente a assinatura antes que o desenvolvedor possa qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor false. bool
descrição Descrição do produto. Pode incluir marcas de formatação HTML. string
displayName Nome do produto. cadeia de caracteres (obrigatório)
state se o produto é publicado ou não. Os produtos publicados são detectáveis por usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para os administradores. O estado padrão do Produto não é Publicado. 'notPublished'
'publicado'
subscriptionRequired Se uma assinatura de produto é necessária para acessar APIs incluídas neste produto. Se for true, o produto será chamado de "protegido" e uma chave de assinatura válida será necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se for falso, o produto será chamado de "aberto" e as solicitações para uma API incluída no produto poderão ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será considerado verdadeiro. bool
subscriptionsLimit Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como nulo ou omita para permitir assinaturas ilimitadas por usuário. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor false. INT
terms Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto verão e deverão aceitar esses termos para concluir o processo de assinatura. string

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma instância de Gerenciamento de API e todos os sub-recursos usando um modelo

Implantar no Azure		 Este modelo demonstra como criar um serviço de Gerenciamento de API e configurar subentidades
Criar o Azure Front Door na frente do Azure Gerenciamento de API

Implantar no Azure		 Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Azure Gerenciamento de API.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de serviço/produtos pode ser implantado com operações direcionadas:

  • Grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/products, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

Valores de propriedade

serviço/produtos

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

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
properties Propriedades do contrato de entidade do produto. ProductContractProperties

ProductContractProperties

Nome Descrição Valor
approvalRequired se a aprovação da assinatura é necessária. Se for false, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se for true, os administradores devem aprovar manualmente a assinatura antes que o desenvolvedor possa qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de false. bool
descrição Descrição do produto. Pode incluir marcas de formatação HTML. string
displayName Nome do produto. cadeia de caracteres (obrigatório)
state se o produto é publicado ou não. Os produtos publicados são detectáveis por usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para os administradores. O estado padrão do Produto não é publicado. "notPublished"
"publicado"
subscriptionRequired Se uma assinatura de produto é necessária para acessar APIs incluídas neste produto. Se for true, o produto será chamado de "protegido" e uma chave de assinatura válida será necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se for falso, o produto será chamado de "aberto" e as solicitações para uma API incluída no produto poderão ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será considerado verdadeiro. bool
subscriptionsLimit Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como nulo ou omita para permitir assinaturas ilimitadas por usuário. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de false. INT
terms Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto verão e deverão aceitar esses termos para concluir o processo de assinatura. string