Compartilhar via

az apim api schema

  • Referência

Gerenciar esquemas de API de gerenciamento de API do Azure.

Comandos

Nome Description Tipo Status
az apim api schema create

Crie um esquema de API de gerenciamento de API.

 Núcleo GA
az apim api schema delete

Exclua um esquema de API de gerenciamento de API.

 Núcleo GA
az apim api schema get-etag

Obtenha etag de um esquema de API de Gerenciamento de API.

 Núcleo GA
az apim api schema list

Listar esquemas de API de Gerenciamento de API.

 Núcleo GA
az apim api schema show

Mostrar detalhes de um esquema de API de gerenciamento de API.

 Núcleo GA
az apim api schema wait

Coloque a CLI em um estado de espera até que uma condição de um esquema apim api seja atendida.

 Núcleo GA

az apim api schema create

Editar

Crie um esquema de API de gerenciamento de API.

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--no-wait]
                          [--resource-type]
                          [--schema-content]
                          [--schema-name]
                          [--schema-path]

Exemplos

Crie um esquema de API.

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath

Parâmetros Exigidos

--api-id

Nome exclusivo da api para a qual o esquema precisa ser criado.

Identificador de revisão 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>.

--schema-id

Nome exclusivo do esquema de api a ser criado.

Identificador de esquema. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--schema-type

Tipo de esquema (por exemplo, application/json, application/vnd.ms-azure-apim.graphql.schema).

Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type conforme definido na RFC 2616. Tipo de mídia do documento de esquema.

--service-name -n

O nome da instância do serviço de Gerenciamento de API.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--resource-type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts".

--schema-content

Json escapou da cadeia de caracteres definindo o documento que representa o Esquema.

Especifique --schema-path ou --schema-content, não ambos.

--schema-name

O nome do recurso de esquema.

--schema-path

Caminho do arquivo especificado para importar o esquema da API.

Especifique --schema-path ou --schema-content, não ambos.

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

Editar

Exclua um esquema de API de gerenciamento de API.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

Exemplos

excluir um esquema de API.

az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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

--schema-id

Identificador de esquema. 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.

--service-name -n

O nome da instância do serviço de Gerenciamento de API.

Parâmetros Opcionais

--if-match

ETag da entidade.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--yes -y

Não solicite confirmação.

valor padrão: False
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 schema get-etag

Editar

Obtenha etag de um esquema de API de Gerenciamento de API.

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

Exemplos

Obtenha uma marca de entidade de esquema.

az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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

--schema-id

Identificador de esquema. 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.

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

Editar

Listar esquemas de API de Gerenciamento de API.

az apim api schema list --api-id
                        --resource-group
                        --service-name
                        [--filter-display-name]
                        [--skip]
                        [--top]

Exemplos

Obtenha uma lista de esquemas associados a uma id de api.

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

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 Opcionais

--filter-display-name

Filtro de APIs por displayName.

--skip

Número de registros a serem ignorados.

--top

Número de registros a serem retornados.

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

Editar

Mostrar detalhes de um esquema de API de gerenciamento de API.

az apim api schema show --api-id
                        --resource-group
                        --schema-id
                        --service-name

Exemplos

Obtenha um esquema de API.

az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

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

--schema-id

Identificador de esquema. 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.

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

Editar

Coloque a CLI em um estado de espera até que uma condição de um esquema apim api seja atendida.

az apim api schema wait --api-id
                        --name
                        --resource-group
                        --schema-id
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Exemplos

Coloque a CLI em um estado de espera até que uma condição de um esquema apim api seja atendida.

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

Parâmetros Exigidos

--api-id

Identificador de revisão 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. Obrigatório.

--name -n

O nome da instância 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>.

--schema-id

Identificador de ID do esquema. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Obrigatório.

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor padrão: False
--exists

Aguarde até que o recurso exista.

valor padrão: False
--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

valor padrão: False
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.