az apim api release
Gerenciar a versão da API de Gerenciamento de API do Azure.
Comandos
| Nome | Description | Tipo | Status |
|---|---|---|---|
| az apim api release create |
Cria uma nova versão para a API. |
Core | GA |
| az apim api release delete |
Exclui a versão especificada na API. |
Core | GA |
| az apim api release list |
Lista todas as versões de uma API. |
Core | GA |
| az apim api release show |
Retorna os detalhes de uma versão da API. |
Core | GA |
| az apim api release update |
Atualiza os detalhes da versão da API especificada por seu identificador. |
Core | GA |
az apim api release create
Cria uma nova versão para a API.
az apim api release create --api-id
--api-revision
--resource-group
--service-name
[--if-match]
[--notes]
[--release-id]
Exemplos
Cria uma nova versão para a API.
az apim api release create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --api-revision 2 --notes MyNotes
Parâmetros Exigidos
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API Arguments |
Número de revisão da API.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do serviço 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.
ETag da Entidade.
Notas sobre a versão.
Identificador de versão em uma API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az apim api release delete
Exclui a versão especificada na API.
az apim api release delete --api-id
--release-id
--resource-group
--service-name
[--if-match]
Exemplos
Exclui a versão especificada na API.
az apim api release delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId
Parâmetros Exigidos
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API Arguments |
Identificador de versão em uma API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do serviço 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.
ETag da Entidade.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az apim api release list
Lista todas as versões de uma API.
az apim api release list --api-id
--resource-group
--service-name
Exemplos
Lista todas as versões de uma API.
az apim api release list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId
Parâmetros Exigidos
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API Arguments |
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do serviço gerenciamento de API.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az apim api release show
Retorna os detalhes de uma versão da API.
az apim api release show --api-id
--release-id
--resource-group
--service-name
Exemplos
Retorna os detalhes de uma versão da API.
az apim api release show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId
Parâmetros Exigidos
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API Arguments |
Identificador de versão em uma API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do serviço gerenciamento de API.
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az apim api release update
Atualiza os detalhes da versão da API especificada por seu identificador.
az apim api release update --api-id
--release-id
--resource-group
--service-name
[--add]
[--force-string]
[--if-match]
[--notes]
[--remove]
[--set]
Exemplos
Atualiza as notas da versão da API especificada por seu identificador.
az apim api release update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --notes MyNewNotes
Parâmetros Exigidos
Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | API Arguments |
Identificador de versão em uma API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da instância do serviço 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.
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: | [] |
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 |
ETag da Entidade.
Notas sobre a versão.
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: | [] |
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: | [] |
Parâmetros Globais
Aumente a verbosidade de log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostre esta mensagem de ajuda e saia.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceitos: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumentar a verbosidade do registro em log. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |