az apic environment

Note

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 az apic environment comando. Saiba mais sobre extensões.

Comandos para gerenciar ambientes na Central de APIs.

Comandos

Nome	Descrição	Tipo	Estado
az apic environment create	Crie um novo ambiente ou atualize um ambiente existente.	Extension	disponibilidade geral
az apic environment delete	Elimine o ambiente.	Extension	disponibilidade geral
az apic environment list	Liste uma coleção de ambientes.	Extension	disponibilidade geral
az apic environment show	Obtenha detalhes do ambiente.	Extension	disponibilidade geral
az apic environment update	Atualize o ambiente existente.	Extension	disponibilidade geral

az apic environment create

Crie um novo ambiente ou atualize um ambiente existente.

az apic environment create --environment-id
                           --resource-group
                           --service-name
                           --title
                           --type {development, production, staging, testing}
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

Exemplos

Criar ambiente

az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"

Parâmetros Obrigatórios

--environment-id

O id do ambiente.

--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 do serviço Central de API do Azure.

--title

Título ambiental.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--type

Tipo de ambiente.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments
Valores aceites:	development, production, staging, testing

Parâmetros Opcionais

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

--custom-properties

Os metadados personalizados definidos para entidades de catálogo de API. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--description

Descrição do ambiente.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--onboarding

Forneça documentação de integração relacionada ao seu ambiente, por exemplo, {developerPortalUri:['https://developer.contoso.com'],instructions:'instructions markdown'} Suporte a sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--server

Informações do servidor do ambiente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

Parâmetros globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	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
Valor padrão:	False

az apic environment delete

Elimine o ambiente.

az apic environment delete [--environment-id]
                           [--ids]
                           [--resource-group]
                           [--service-name]
                           [--subscription]
                           [--yes]

Exemplos

Eliminar ambiente

az apic environment delete -g api-center-test -n contosoeuap --environment-id public

Parâmetros Opcionais

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

--environment-id

O id do ambiente.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--service-name -n

O nome do serviço Central de API do Azure.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--yes -y

Não solicite confirmação.

Propriedade	Valor
Valor padrão:	False

Parâmetros globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apic environment list

Liste uma coleção de ambientes.

az apic environment list --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Exemplos

Listar ambientes

az apic environment list -g api-center-test -n contosoeuap

Parâmetros Obrigatórios

--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 do serviço Central de API do Azure.

Parâmetros Opcionais

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

--filter

Parâmetro de filtro OData.

--max-items

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 em --next-token argumento de um comando subsequente.

Propriedade	Valor
Grupo de parâmetros:	Pagination Arguments

--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade	Valor
Grupo de parâmetros:	Pagination Arguments

Parâmetros globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	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
Valor padrão:	False

az apic environment show

Obtenha detalhes do ambiente.

az apic environment show [--environment-id]
                         [--ids]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Exemplos

Mostrar detalhes do ambiente

az apic environment show -g api-center-test -n contosoeuap --environment-id public

Parâmetros Opcionais

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

--environment-id

O id do ambiente.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--service-name -n

O nome do serviço Central de API do Azure.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

Parâmetros globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apic environment update

Atualize o ambiente existente.

az apic environment update [--add]
                           [--custom-properties]
                           [--description]
                           [--environment-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--onboarding]
                           [--remove]
                           [--resource-group]
                           [--server]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--type {development, production, staging, testing}]

Exemplos

Ambiente de atualização

az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"

Parâmetros Opcionais

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

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

--custom-properties

Os metadados personalizados definidos para entidades de catálogo de API. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--description

Description.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--environment-id

O id do ambiente.

Propriedade	Valor
Grupo de parâmetros:	Resource Id 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
Valores aceites:	0, 1, f, false, n, no, t, true, y, yes

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--onboarding

{developerPortalUri:['https://developer.contoso.com'],instruções:'instructions markdown'} Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

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

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--server

Informações do servidor do ambiente. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--service-name -n

O nome do serviço Central de API do Azure.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

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

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--title

Título ambiental.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--type

Tipo de ambiente.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments
Valores aceites:	development, production, staging, testing

Parâmetros globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

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

--verbose

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

Propriedade	Valor
Valor padrão:	False

Feedback

Esta página foi útil?

Partilhar via

az apic environment

Comandos

az apic environment create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apic environment delete

Exemplos

Parâmetros Opcionais

az apic environment list

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apic environment show

Exemplos

Parâmetros Opcionais

az apic environment update

Exemplos

Parâmetros Opcionais

Feedback