Serviço/produtos Microsoft.ApiManagement

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de serviço/produtos 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/products, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-03-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 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: serviço
propriedades Propriedades do contrato de entidade do produto. ProductContractProperties

ProductContractProperties

Nome Descrição Valor
approvalRequired se a aprovação da subscrição é necessária. Se for falso, as novas subscrições serão aprovadas automaticamente, permitindo que os programadores chamem as APIs do produto imediatamente após a subscrição. Se for verdadeiro, os administradores têm de aprovar manualmente a subscrição antes de o programador poder utilizar qualquer uma das APIs do produto. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor falso. bool
descrição Descrição do produto. Pode incluir etiquetas de formatação HTML. string
displayName Nome do produto. cadeia (obrigatório)
state se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado. "notPublished"
"publicado"
subscriptionRequired Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se for verdadeiro, o produto é referido como "protegido" e é necessária uma chave de subscrição válida para que um pedido a uma API incluído no produto seja bem-sucedido. Se for falso, o produto é referido como "aberto" e os pedidos para uma API incluída no produto podem ser feitos sem uma chave de subscrição. Se a propriedade for omitida ao criar um novo produto, assume-se que o valor é verdadeiro. bool
subscriptionsLimit Se o número de subscrições que um utilizador pode ter para este produto ao mesmo tempo. Defina como nulo ou omitir para permitir subscrições ilimitadas por utilizador. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor falso. int
termos Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição. string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar uma instância da Gestão de API e todos os sub-recursos com modelo

Implementar no Azure		 Este modelo demonstra como criar um serviço de Gestão de API e configurar sub entidades
Criar o Azure Front Door em frente ao Azure Gestão de API

Implementar no Azure		 Este exemplo demonstra como utilizar o Azure Front Door como um balanceador de carga global em frente ao Azure Gestão de API.

Definição de recurso do modelo arm

O tipo de recurso de serviço/produtos 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/products, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-03-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 de recursos "2023-03-01-preview"
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos do 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 do contrato de entidade do produto. ProductContractProperties

ProductContractProperties

Nome Descrição Valor
approvalRequired se a aprovação da subscrição é necessária. Se forem falsas, as novas subscrições serão aprovadas permitindo automaticamente aos programadores chamar as APIs do produto imediatamente após a subscrição. Se for verdade, os administradores têm de aprovar manualmente a subscrição antes de o programador poder fazer qualquer uma das APIs do produto. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso. bool
descrição Descrição do produto. Pode incluir etiquetas de formatação HTML. string
displayName Nome do produto. cadeia (obrigatório)
state se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado. "notPublished"
"publicado"
subscriptionRequired Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se for verdadeiro, o produto é referido como "protegido" e é necessária uma chave de subscrição válida para que um pedido a uma API incluído no produto seja bem-sucedido. Se for falso, o produto é referido como "aberto" e os pedidos para uma API incluída no produto podem ser feitos sem uma chave de subscrição. Se a propriedade for omitida ao criar um novo produto, assume-se que o valor é verdadeiro. bool
subscriptionsLimit Se o número de subscrições que um utilizador pode ter para este produto ao mesmo tempo. Defina como nulo ou omitir para permitir subscrições ilimitadas por utilizador. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso. int
termos Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição. string

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar uma instância da Gestão de API e todos os sub-recursos com modelo

Implementar no Azure		 Este modelo demonstra como criar um serviço de Gestão de API e configurar sub entidades
Criar o Azure Front Door em frente ao Azure Gestão de API

Implementar no Azure		 Este exemplo demonstra como utilizar o Azure Front Door como um balanceador de carga global em frente ao Azure Gestão de API.

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

O tipo de recurso de serviço/produtos pode ser implementado com operações que visam:

  • Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-03-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-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: serviço
propriedades Propriedades do contrato de entidade do produto. ProductContractProperties

ProductContractProperties

Nome Descrição Valor
approvalRequired se a aprovação da subscrição é necessária. Se forem falsas, as novas subscrições serão aprovadas permitindo automaticamente aos programadores chamar as APIs do produto imediatamente após a subscrição. Se for verdade, os administradores têm de aprovar manualmente a subscrição antes de o programador poder fazer qualquer uma das APIs do produto. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso. bool
descrição Descrição do produto. Pode incluir etiquetas de formatação HTML. string
displayName Nome do produto. cadeia (obrigatório)
state se o produto é publicado ou não. Os produtos publicados são detetáveis pelos utilizadores do portal do programador. Os produtos não publicados são visíveis apenas para os administradores. O estado predefinido do Produto não é Publicado. "notPublished"
"publicado"
subscriptionRequired Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se for verdadeiro, o produto é referido como "protegido" e é necessária uma chave de subscrição válida para que um pedido a uma API incluído no produto seja bem-sucedido. Se for falso, o produto é referido como "aberto" e os pedidos para uma API incluída no produto podem ser feitos sem uma chave de subscrição. Se a propriedade for omitida ao criar um novo produto, assume-se que o valor é verdadeiro. bool
subscriptionsLimit Se o número de subscrições que um utilizador pode ter para este produto ao mesmo tempo. Defina como nulo ou omitir para permitir subscrições ilimitadas por utilizador. Só pode estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor de falso. int
termos Termos de utilização do produto. Os programadores que tentarem subscrever o produto serão apresentados e terão de aceitar estes termos antes de poderem concluir o processo de subscrição. string