Compartilhar via

az apim product api

  • Referência

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

Comandos

Nome Description Tipo Status
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 api add

Editar

Adicione uma API ao produto especificado.

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name

Exemplos

Adicione uma API ao produto especificado.

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parâmetros Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--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 api check

Editar

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

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name

Exemplos

Verifique se a API está associada ao Produto.

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parâmetros Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--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 api delete

Editar

Exclui a API especificada do produto especificado.

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name

Exemplos

Exclui a API especificada do produto especificado.

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

Parâmetros Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--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 api list

Editar

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

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

Exemplos

Listar todas as APIs associadas a um produto.

az apim product api list --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.