Compartilhar via

az apim api release

  • Referência

Gerenciar a versão da API de gerenciamento de API do Azure.

Comandos

Nome Description Tipo Status
az apim api release create

Cria uma versão para a API.

 Núcleo GA
az apim api release delete

Exclui a versão especificada na API.

 Núcleo GA
az apim api release list

Lista todas as versões de uma API.

 Núcleo GA
az apim api release show

Retorna os detalhes de uma versão da API.

 Núcleo GA
az apim api release update

Atualiza os detalhes da versão da API especificada por seu identificador.

 Núcleo GA

az apim api release create

Editar

Cria uma 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 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

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

--api-revision

Número de revisão da 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

--if-match

ETag da entidade.

--notes

Notas de versão.

--release-id

Identificador de versão dentro de uma API. Deve ser exclusivo na instância atual 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 api release delete

Editar

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

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

--release-id

Identificador de versão dentro de uma API. 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

--if-match

ETag da entidade.

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

Editar

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

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

--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 api release show

Editar

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

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

--release-id

Identificador de versão dentro de uma API. 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 api release update

Editar

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

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

--release-id

Identificador de versão dentro de uma API. 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

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Valor padrão: []
--force-string

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

Valor padrão: False
--if-match

ETag da entidade.

--notes

Notas de versão.

--remove

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

Valor padrão: []
--set

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

Valor padrão: []
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.