Partilhar via

az apim api release

Manage API Management do Azure API Release.

Comandos

Name Description Tipo Status
az apim api release create

Cria uma nova versão para a API.

 Core disponibilidade geral
az apim api release delete

Exclui a versão especificada na API.

 Core disponibilidade geral
az apim api release list

Lista todas as versões de uma API.

 Core disponibilidade geral
az apim api release show

Retorna os detalhes de uma versão da API.

 Core disponibilidade geral
az apim api release update

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

 Core disponibilidade geral

az apim api release create

Editar

Cria uma nova versão para a API.

az apim api release create --api-id
                           --api-revision
                           --resource-group
                           --service-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--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 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
--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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--if-match

ETag da Entidade.

--notes

Notas de versão.

--release-id

Identificador de liberação dentro de uma API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

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

Editar

Exclui a versão especificada na API.

az apim api release delete --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--acquire-policy-token]
                           [--change-reference]
                           [--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 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
--release-id

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--if-match

ETag da Entidade.

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 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 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
--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 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 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
--release-id

Identificador de liberação dentro de uma API. 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 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
                           [--acquire-policy-token]
                           [--add]
                           [--change-reference]
                           [--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 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
--release-id

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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
Default value: []
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: 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.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: []
--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
Default value: []
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