az apim product

  • Referência

Gerenciar Produtos de Gerenciamento de API do Azure.

Comandos

Nome Description Tipo Status
az apim product api

Gerenciar as APIs do Produto de Gerenciamento de API do Azure.

 Núcleo GA
az apim product api add

Adicione uma API ao produto especificado.

 Núcleo GA
az apim product api check

Verifica se a entidade de API especificada pelo identificador está associada à entidade Produto.

 Núcleo GA
az apim product api delete

Exclui a API especificada do produto especificado.

 Núcleo GA
az apim product api list

Lista uma coleção das APIs associadas a um produto.

 Núcleo GA
az apim product create

Cria um produto.

 Núcleo GA
az apim product delete

Excluir produto.

 Núcleo GA
az apim product list

Lista uma coleção de produtos na instância de serviço especificada.

 Núcleo GA
az apim product show

Obtém os detalhes do produto especificado por seu identificador.

 Núcleo GA
az apim product update

Atualize os detalhes do produto existente.

 Núcleo GA
az apim product wait

Coloque a CLI em um estado de espera até que uma condição de um produto apim seja atendida.

 Núcleo GA

az apim product create

Editar

Cria um produto.

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Exemplos

Cria um produto.

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

Parâmetros Exigidos

--product-name

Nome do produto.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de gerenciamento de api.

Parâmetros Opcionais

--approval-required

Se a aprovação da assinatura é necessária. Se false, 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 usar qualquer uma das APIs do produto. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false.

valores aceitos: false, true
--description

Descrição do produto. Pode incluir marcas de formatação HTML.

--legal-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.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--product-id

Identificador do produto. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--state

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 os administradores. O estado padrão do Produto não é Publicado. Os valores possíveis incluem: 'notPublished', 'published'.

valores aceitos: notPublished, published
--subscription-required -s

Se uma assinatura de produto é necessária para acessar APIs incluídas neste produto.

valores aceitos: false, true
--subscriptions-limit

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.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim product delete

Editar

Excluir produto.

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--yes]

Exemplos

Exclua o produto com todas as assinaturas deste produto.

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

Parâmetros Exigidos

--product-id

Identificador do produto. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de gerenciamento de api.

Parâmetros Opcionais

--delete-subscriptions

Exclua assinaturas existentes associadas ao produto ou não.

--if-match

ETag da entidade.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim product list

Editar

Lista uma coleção de produtos na instância de serviço especificada.

az apim product list --resource-group
                     --service-name

Exemplos

Liste todos os produtos para esta instância de APIM.

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

Parâmetros Exigidos

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de gerenciamento de api.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim product show

Editar

Obtém os detalhes do produto especificado por seu identificador.

az apim product show --product-id
                     --resource-group
                     --service-name

Exemplos

Obtém os detalhes do produto especificado por seu identificador.

az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID

Parâmetros Exigidos

--product-id

Identificador do produto. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de gerenciamento de api.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim product update

Editar

Atualize os detalhes do produto existente.

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Exemplos

Atualize os detalhes do produto existente.

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

Parâmetros Exigidos

--product-id

Identificador do produto. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de gerenciamento de api.

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

valor padrão: []
--approval-required

Se a aprovação da assinatura é necessária. Se false, 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 usar qualquer uma das APIs do produto. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false.

valores aceitos: false, true
--description

Descrição do produto. Pode incluir marcas de formatação HTML.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valor padrão: False
--if-match

ETag da entidade.

--legal-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.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--product-name

Nome do produto.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

valor padrão: []
--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>.

valor padrão: []
--state

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 os administradores. O estado padrão do Produto não é Publicado. Os valores possíveis incluem: 'notPublished', 'published'.

valores aceitos: notPublished, published
--subscription-required -s

Se uma assinatura de produto é necessária para acessar APIs incluídas neste produto.

valores aceitos: false, true
--subscriptions-limit

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.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim product wait

Editar

Coloque a CLI em um estado de espera até que uma condição de um produto apim seja atendida.

az apim product wait --product-id
                     --resource-group
                     --service-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

Exemplos

Coloque a CLI em um estado de espera até que uma condição de um apim seja atendida. (gerado automaticamente)

az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

Parâmetros Exigidos

--product-id

Identificador do produto. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de gerenciamento de api.

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor padrão: False
--exists

Aguarde até que o recurso exista.

valor padrão: False
--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.