az apim product

Gerenciar produtos do 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.	Core	GA
az apim product api add	Adicione uma API ao produto especificado.	Core	GA
az apim product api check	Verifica se a entidade de API especificada pelo identificador está associada à entidade Product.	Core	GA
az apim product api delete	Exclui a API especificada do produto especificado.	Core	GA
az apim product api list	Lista uma coleção de APIs associadas a um produto.	Core	GA
az apim product create	Cria um produto.	Core	GA
az apim product delete	Excluir produto.	Core	GA
az apim product list	Lista uma coleção de produtos na instância de serviço especificada.	Core	GA
az apim product show	Obtém os detalhes do produto especificado por seu identificador.	Core	GA
az apim product update	Atualize os detalhes do produto existente.	Core	GA
az apim product wait	Coloque a CLI em um estado de espera até que uma condição de um produto apim seja atendida.	Core	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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--approval-required

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 devem aprovar manualmente a assinatura antes que o desenvolvedor possa usar qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor falso.

Propriedade	Valor
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 serão apresentados e obrigados a aceitar esses termos antes de concluir o processo de assinatura.

--no-wait

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

Propriedade	Valor
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 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 não está publicado. Os valores possíveis incluem: 'notPublished', 'published'.

Propriedade	Valor
Valores aceitos:	notPublished, published

--subscription-required -s

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

Propriedade	Valor
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 nulo ou omita para permitir assinaturas ilimitadas por usuário. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor falso.

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

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 para este 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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--delete-subscriptions

Exclua as 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 prolongada.

Propriedade	Valor
Valor padrão:	False

--yes -y

Não solicite confirmação.

Propriedade	Valor
Valor padrão:	False

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

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 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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	[]

--approval-required

Propriedade	Valor
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 em JSON.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	False

--if-match

ETag da Entidade.

--legal-terms

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.

--no-wait

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

Propriedade	Valor
Valor padrão:	False

--product-name

Nome do produto.

--remove

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	[]

--set

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	[]

--state

Propriedade	Valor
Valores aceitos:	notPublished, published

--subscription-required -s

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

Propriedade	Valor
Valores aceitos:	false, true

--subscriptions-limit

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

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. (autogenerated)

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--created

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--custom

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments

--deleted

Aguarde até ser excluído.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--exists

Aguarde até que o recurso exista.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--interval

Intervalo de sondagem em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	30

--timeout

Espera máxima em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	3600

--updated

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

Parâmetros Globais

--debug

Aumente a verbosidade de log para mostrar todos os logs de depuração.

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	json, jsonc, none, table, tsv, yaml, yamlc

--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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

Propriedade	Valor
Valor padrão:	False

Comentários

Esta página foi útil?

Compartilhar via

az apim product

Comandos

az apim product create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim product delete

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim product list

Exemplos

Parâmetros Exigidos

az apim product show

Exemplos

Parâmetros Exigidos

az apim product update

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim product wait

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários