Share via

az apic service

  • Referência

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 service . Saiba mais sobre extensões.

Gerencie uma instância de serviço do Centro de API do Azure.

Comandos

Name Description Tipo Estado
az apic service create

Cria uma instância ou atualiza uma instância existente de um serviço do Centro de API do Azure.

 Extensão GA
az apic service delete

Exclui uma instância de um serviço da Central de API do Azure.

 Extensão GA
az apic service import-from-apim

Importa APIs de uma instância de serviço de Gerenciamento de API do Azure.

 Extensão GA
az apic service list

Lista os serviços do Centro de API do Azure em uma assinatura do Azure.

 Extensão GA
az apic service show

Mostrar detalhes de uma instância de serviço do Centro de API do Azure.

 Extensão GA
az apic service update

Atualize uma instância de um serviço do Centro de API do Azure.

 Extensão GA

az apic service create

Cria uma instância ou atualiza uma instância existente de um serviço do Centro de API do Azure.

az apic service create --name
                       --resource-group
                       [--identity]
                       [--location]
                       [--tags]

Exemplos

Criar serviço Exemplo 1

az apic service create -g contoso-resources -s contoso -l eastus

Criar Exemplo de Serviço 2

az apic service create --resource-group contoso-resources --name contoso --location eastus

Parâmetros Obrigatórios

--name --service --service-name -s

O nome do serviço do Centro de APIs.

--resource-group -g

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

Parâmetros Opcionais

--identity

As identidades de serviço gerenciado atribuídas a este recurso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

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

--verbose

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

az apic service delete

Exclui uma instância de um serviço da Central de API do Azure.

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

Exemplos

Eliminar serviço

az apic service delete -s contoso -g contoso-resources

Parâmetros Opcionais

--ids

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

--name --service --service-name -s

O nome do serviço do Centro de APIs.

--resource-group -g

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

--subscription

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

--yes -y

Não solicite confirmação.

valor predefinido: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

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

--verbose

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

az apic service import-from-apim

Importa APIs de uma instância de serviço de Gerenciamento de API do Azure.

az apic service import-from-apim --source-resource-ids
                                 [--ids]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--service]
                                 [--subscription]

Exemplos

Importar do APIM

az apic service import-from-apim -g api-center-test --service-name contosoeuap --source-resource-ids '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicegroup/providers/Microsoft.ApiManagement/service/contoso/apis/contosoapi'

Parâmetros Obrigatórios

--source-resource-ids

Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Opcionais

--ids

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

--no-wait

Não espere que a operação de longa duração termine.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service --service-name -s

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

--subscription

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

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

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

--verbose

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

az apic service list

Lista os serviços do Centro de API do Azure em uma assinatura do Azure.

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

Exemplos

Listar serviços no grupo de recursos

az apic service list -g contoso-resources

Parâmetros Opcionais

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

--next-token

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

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

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

--verbose

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

az apic service show

Mostrar detalhes de uma instância de serviço do Centro de API do Azure.

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

Exemplos

Mostrar detalhes do serviço

az apic service show -g contoso-resources -s contoso

Parâmetros Opcionais

--ids

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

--name --service --service-name -s

O nome do serviço do Centro de APIs.

--resource-group -g

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

--subscription

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

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

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

--verbose

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

az apic service update

Atualize uma instância de um serviço do Centro de API do Azure.

az apic service update [--identity]
                       [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--tags]

Exemplos

Atualizar detalhes do serviço

az apic service update -g contoso-resources -s contoso

Parâmetros Opcionais

--identity

As identidades de serviço gerenciado atribuídas a este recurso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--ids

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

--name --service --service-name -s

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

--resource-group -g

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

--subscription

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

--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

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

--verbose

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