az apic api deployment
Nota
Essa referência faz parte da extensão apic-extension para a CLI do Azure (versão 2.57.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az apic api deployment . Saiba mais sobre extensões.
Comandos para gerenciar implantações de API na Central de APIs.
Comandos
| Name | Description | Tipo | Estado |
|---|---|---|---|
| az apic api deployment create |
Crie uma nova implantação de API ou atualize uma implantação de API existente. |
Extensão | GA |
| az apic api deployment delete |
Exclua a implantação da API. |
Extensão | GA |
| az apic api deployment list |
Listar uma coleção de implantações de API. |
Extensão | GA |
| az apic api deployment show |
Obtenha detalhes da implantação da API. |
Extensão | GA |
| az apic api deployment update |
Atualize a implantação da API existente. |
Extensão | GA |
az apic api deployment create
Crie uma nova implantação de API ou atualize uma implantação de API existente.
az apic api deployment create --api-id
--deployment-id
--resource-group
--service
[--custom-properties]
[--definition-id]
[--description]
[--environment-id]
[--server]
[--state {active, inactive}]
[--title]Exemplos
Criar implementação
az apic api deployment create -g api-center-test -s contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'Parâmetros Obrigatórios
A id da API.
A id da implantação da API.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço do Centro de APIs.
Parâmetros Opcionais
Os metadados personalizados definidos para entidades de catálogo de API. Suporte json-file e yaml-file.
ID do recurso de definição do escopo central da API.
Descrição da implantação.
ID do recurso do ambiente com escopo central da API.
Suporte ao servidor taquigrafia-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.
Estado de implantação da API.
Título da implantação.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api deployment delete
Exclua a implantação da API.
az apic api deployment delete [--api-id]
[--deployment-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--yes]Exemplos
Excluir implantação de API
az apic api deployment delete -g api-center-test -s contoso --deployment-id production --api-id echo-apiParâmetros Opcionais
A id da API.
A id da implantação da API.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço do Centro de APIs.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Não solicite confirmação.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api deployment list
Listar uma coleção de implantações de API.
az apic api deployment list --api-id
--resource-group
--service
[--filter]
[--max-items]
[--next-token]Exemplos
Listar implantações de API
az apic api deployment list -g api-center-test -s contoso --api-id echo-apiParâmetros Obrigatórios
A id da API.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço do Centro de APIs.
Parâmetros Opcionais
Parâmetro de filtro OData.
Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.
Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api deployment show
Obtenha detalhes da implantação da API.
az apic api deployment show [--api-id]
[--deployment-id]
[--ids]
[--resource-group]
[--service]
[--subscription]Exemplos
Mostrar detalhes da implantação da API
az apic api deployment show -g api-center-test -s contoso --deployment-id production --api-id echo-apiParâmetros Opcionais
A id da API.
A id da implantação da API.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome do serviço do Centro de APIs.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apic api deployment update
Atualize a implantação da API existente.
az apic api deployment update [--add]
[--api-id]
[--custom-properties]
[--definition-id]
[--deployment-id]
[--description]
[--environment-id]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--server]
[--service]
[--set]
[--state {active, inactive}]
[--subscription]
[--title]Exemplos
Atualizar a implantação da API
az apic api deployment update -g api-center-test -s contoso --deployment-id production --title "Production deployment" --api-id echo-apiParâmetros Opcionais
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string ou JSON string>.
A id da API.
Os metadados personalizados definidos para entidades de catálogo de API. Suporte json-file e yaml-file.
ID do recurso de definição de escopo de serviço.
A id da implantação da API.
Descrição da implantação.
ID do recurso de ambiente com escopo de serviço.
Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.
Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
Suporte ao servidor taquigrafia-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.
O nome do serviço do Centro de APIs.
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=.
Estado de implantação da API.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Título.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários