Partilhar via


az apim product api

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

Comandos

Name Description Tipo Status
az apim product api add

Adicione uma API ao produto especificado.

Core disponibilidade geral
az apim product api check

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

Core disponibilidade geral
az apim product api delete

Exclui a API especificada do produto especificado.

Core disponibilidade geral
az apim product api list

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

Core disponibilidade geral

az apim product api add

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

--api-id

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

Propriedade Valor
Grupo de parâmetros: API Arguments
--product-id

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

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az apim product api check

Verifica se a entidade da API especificada pelo identificador está associada à entidade do 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 Obrigatórios

--api-id

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

Propriedade Valor
Grupo de parâmetros: API Arguments
--product-id

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

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az apim product api delete

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

--api-id

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

Propriedade Valor
Grupo de parâmetros: API Arguments
--product-id

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

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False

az apim product api list

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

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

Exemplos

Liste todas as APIs associadas a um produto.

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

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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Default value: False