Compartilhar via

Serviço/produtos Microsoft.ApiManagement 2016-10-10

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.ApiManagement/service/products@2016-10-10' = {
  parent: resourceSymbolicName
  approvalRequired: bool
  description: 'string'
  name: 'string'
  state: 'string'
  subscriptionRequired: bool
  subscriptionsLimit: int
  terms: 'string'
}

Valores de propriedade

Microsoft.ApiManagement/service/products

Nome Descrição Valor
approvalRequired se a aprovação da assinatura é necessária. Se for falso, 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 fazer qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor verdadeiro. Bool
descrição Descrição do produto. Pode incluir marcas de formatação HTML. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1000
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
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 do recurso do tipo: de serviço
estado 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 é NotPublished. '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 verdadeiro. int
termos Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto serão apresentados e obrigados a aceitar esses termos antes de concluir o processo de assinatura. corda

Definição de recurso de modelo do ARM

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de 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": "2016-10-10",
  "name": "string",
  "approvalRequired": "bool",
  "description": "string",
  "state": "string",
  "subscriptionRequired": "bool",
  "subscriptionsLimit": "int",
  "terms": "string"
}

Valores de propriedade

Microsoft.ApiManagement/service/products

Nome Descrição Valor
apiVersion A versão da API '2016-10-10'
approvalRequired se a aprovação da assinatura é necessária. Se for falso, 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 fazer qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor verdadeiro. Bool
descrição Descrição do produto. Pode incluir marcas de formatação HTML. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1000
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
estado 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 é NotPublished. '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 verdadeiro. int
termos Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto serão apresentados e obrigados a aceitar esses termos antes de concluir o processo de assinatura. corda
tipo O tipo de recurso 'Microsoft.ApiManagement/service/products'

Exemplos de uso

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

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

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de 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@2016-10-10"
  name = "string"
  approvalRequired = bool
  description = "string"
  state = "string"
  subscriptionRequired = bool
  subscriptionsLimit = int
  terms = "string"
}

Valores de propriedade

Microsoft.ApiManagement/service/products

Nome Descrição Valor
approvalRequired se a aprovação da assinatura é necessária. Se for falso, 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 fazer qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor verdadeiro. Bool
descrição Descrição do produto. Pode incluir marcas de formatação HTML. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1000
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
estado 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 é NotPublished. '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 verdadeiro. int
termos Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto serão apresentados e obrigados a aceitar esses termos antes de concluir o processo de assinatura. corda
tipo O tipo de recurso "Microsoft.ApiManagement/service/products@2016-10-10"