Serviço/produtos Microsoft.ApiManagement
O tipo de recurso serviço/produtos pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.ApiManagement/service/products, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/products@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Designação | Descrição | Valor |
---|---|---|
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 (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 | Propriedades do contrato da entidade do produto. | ProductContractProperties |
Designação | Descrição | Valor |
---|---|---|
aprovaçãoObrigatório | se a aprovação da subscrição é necessária. Se falsas, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se verdadeiro, os administradores devem aprovar manualmente a assinatura antes que o desenvolvedor possa qualquer uma das APIs do produto. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false. | Bool |
Descrição | Descrição do produto. Pode incluir tags de formatação HTML. | string Restrições: Comprimento máximo = 1000 |
displayName | Nome do produto. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 (obrigatório) |
Estado | se o produto é publicado ou não. Os produtos publicados podem ser descobertos pelos usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para administradores. O estado padrão do Produto não é Publicado. | 'nãoPublicado' 'publicado' |
assinaturaObrigatório | Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se verdadeiro, o produto é referido como "protegido" e uma chave de assinatura válida é necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se falso, o produto é referido como "aberto" e as solicitações para uma API incluída no produto podem ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será assumido como verdadeiro. | Bool |
subscriçõesLimite | Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como null ou omit para permitir assinaturas ilimitadas por usuário. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false. | Int |
termos | Termos de utilização do produto. Os programadores que tentem subscrever o produto serão apresentados e obrigados a aceitar estes termos antes de poderem concluir o processo de subscrição. | string |
O tipo de recurso serviço/produtos pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.ApiManagement/service/products, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Designação | Descrição | Valor |
---|---|---|
apiVersion | A versão api | '2024-06-01-pré-visualização' |
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 (obrigatório) |
propriedades | Propriedades do contrato da entidade do produto. | ProductContractProperties |
tipo | O tipo de recurso | 'Microsoft.ApiManagement/serviço/produtos' |
Designação | Descrição | Valor |
---|---|---|
aprovaçãoObrigatório | se a aprovação da subscrição é necessária. Se falsas, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se verdadeiro, os administradores devem aprovar manualmente a assinatura antes que o desenvolvedor possa qualquer uma das APIs do produto. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false. | Bool |
Descrição | Descrição do produto. Pode incluir tags de formatação HTML. | string Restrições: Comprimento máximo = 1000 |
displayName | Nome do produto. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 (obrigatório) |
Estado | se o produto é publicado ou não. Os produtos publicados podem ser descobertos pelos usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para administradores. O estado padrão do Produto não é Publicado. | 'nãoPublicado' 'publicado' |
assinaturaObrigatório | Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se verdadeiro, o produto é referido como "protegido" e uma chave de assinatura válida é necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se falso, o produto é referido como "aberto" e as solicitações para uma API incluída no produto podem ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será assumido como verdadeiro. | Bool |
subscriçõesLimite | Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como null ou omit para permitir assinaturas ilimitadas por usuário. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false. | Int |
termos | Termos de utilização do produto. Os programadores que tentem subscrever o produto serão apresentados e obrigados a aceitar estes termos antes de poderem concluir o processo de subscrição. | string |
O tipo de recurso serviço/produtos 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.
Para criar um recurso Microsoft.ApiManagement/service/products, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/products@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Designação | Descrição | Valor |
---|---|---|
Designação | O nome do recurso | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 256 (obrigatório) |
parent_id | A ID do recurso que é o pai para este recurso. | ID do recurso do tipo: serviço |
propriedades | Propriedades do contrato da entidade do produto. | ProductContractProperties |
tipo | O tipo de recurso | "Microsoft.ApiManagement/service/products@2024-06-01-preview" |
Designação | Descrição | Valor |
---|---|---|
aprovaçãoObrigatório | se a aprovação da subscrição é necessária. Se falsas, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se verdadeiro, os administradores devem aprovar manualmente a assinatura antes que o desenvolvedor possa qualquer uma das APIs do produto. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false. | Bool |
Descrição | Descrição do produto. Pode incluir tags de formatação HTML. | string Restrições: Comprimento máximo = 1000 |
displayName | Nome do produto. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 (obrigatório) |
Estado | se o produto é publicado ou não. Os produtos publicados podem ser descobertos pelos usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para administradores. O estado padrão do Produto não é Publicado. | 'nãoPublicado' 'publicado' |
assinaturaObrigatório | Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto. Se verdadeiro, o produto é referido como "protegido" e uma chave de assinatura válida é necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se falso, o produto é referido como "aberto" e as solicitações para uma API incluída no produto podem ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será assumido como verdadeiro. | Bool |
subscriçõesLimite | Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como null ou omit para permitir assinaturas ilimitadas por usuário. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false. | Int |
termos | Termos de utilização do produto. Os programadores que tentem subscrever o produto serão apresentados e obrigados a aceitar estes termos antes de poderem concluir o processo de subscrição. | string |