Partilhar via

az apim product

  • Referência

Gerencie o Produto de Gerenciamento de API do Azure.

Comandos

Name Description Tipo Status
az apim product api

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

 Principal GA
az apim product api add

Adicione uma API ao produto especificado.

 Principal GA
az apim product api check

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

 Principal GA
az apim product api delete

Exclui a API especificada do produto especificado.

 Principal GA
az apim product api list

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

 Principal GA
az apim product create

Cria um produto.

 Principal GA
az apim product delete

Excluir produto.

 Principal GA
az apim product list

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

 Principal GA
az apim product show

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

 Principal GA
az apim product update

Atualize os detalhes do produto existente.

 Principal GA
az apim product wait

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

 Principal 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 Obrigatórios

--product-name

Nome do produto.

--resource-group -g

o 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 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 usar qualquer uma das APIs do produto. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false.

Valores aceites: false, true
--description

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

--legal-terms

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.

--no-wait

Não espere que a operação de longa duração termine.

Default value: False
--product-id

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

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

Valores aceites: notPublished, published
--subscription-required -s

Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto.

Valores aceites: 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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

Elimine o produto com todas as subscrições deste produto.

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

Parâmetros Obrigatórios

--product-id

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

--resource-group -g

o 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 espere que a operação de longa duração termine.

Default value: False
--yes -y

Não solicite confirmação.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 do APIM.

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

Parâmetros Obrigatórios

--resource-group -g

o 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--product-id

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

--resource-group -g

o 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 Obrigatórios

--product-id

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

--resource-group -g

o 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 valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--approval-required

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 usar qualquer uma das APIs do produto. Pode estar presente somente se a propriedade subscriptionRequired estiver presente e tiver um valor false.

Valores aceites: false, true
--description

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

--force-string

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

Default value: False
--if-match

ETag da Entidade.

--legal-terms

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.

--no-wait

Não espere que a operação de longa duração termine.

Default value: False
--product-name

Nome do produto.

--remove

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

Default value: []
--set

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

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

Valores aceites: notPublished, published
--subscription-required -s

Se é necessária uma subscrição de produto para aceder às APIs incluídas neste produto.

Valores aceites: 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 de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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 apim seja atendida. (gerado automaticamente)

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

Parâmetros Obrigatórios

--product-id

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

--resource-group -g

o 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é ser criado com 'provisioningState' em 'Succeeded'.

Default value: 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.

Default value: False
--exists

Aguarde até que o recurso exista.

Default value: False
--interval

Intervalo de sondagem em segundos.

Default value: 30
--timeout

Espera máxima em segundos.

Default value: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.