az apim api schema

Gerenciar esquemas de API de Gerenciamento de API do Azure.

Comandos

Nome	Description	Tipo	Status
az apim api schema create	Criar um esquema de API de Gerenciamento de API.	Core	GA
az apim api schema delete	Excluir um esquema de API de Gerenciamento de API.	Core	GA
az apim api schema get-etag	Obter a etag de um esquema de API de Gerenciamento de API.	Core	GA
az apim api schema list	Listar esquemas de API de Gerenciamento de API.	Core	GA
az apim api schema show	Mostrar detalhes de um esquema de API de Gerenciamento de API.	Core	GA
az apim api schema wait	Coloque a CLI em um estado de espera até que uma condição de um esquema de api apim seja atendida.	Core	GA

az apim api schema create

Editar

Criar 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

Criar 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. A revisão não atual tem; rev=n como um sufixo em que 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>.

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

Propriedade	Valor
Grupo de parâmetros:	Schema Arguments

--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 no RFC 2616. Tipo de mídia do documento de esquema.

Propriedade	Valor
Grupo de parâmetros:	Schema Arguments

--service-name -n

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--no-wait

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

Propriedade	Valor
Valor padrão:	False

--resource-type

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

Propriedade	Valor
Grupo de parâmetros:	Schema Arguments

--schema-content

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

Especifique --schema-path ou --schema-content not both.

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

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--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 aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apim api schema delete

Editar

Excluir 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. A revisão não atual tem; rev=n como um sufixo em que 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>.

--schema-id

Identificador de esquema. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

Propriedade	Valor
Grupo de parâmetros:	Schema Arguments

--service-name -n

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--if-match

ETag da Entidade.

--no-wait

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

Propriedade	Valor
Valor padrão:	False

--yes -y

Não solicite confirmação.

Propriedade	Valor
Valor padrão:	False

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--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 aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apim api schema get-etag

Editar

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

obter 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. A revisão não atual tem; rev=n como um sufixo em que 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>.

--schema-id

Identificador de esquema. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

Propriedade	Valor
Grupo de parâmetros:	Schema Arguments

--service-name -n

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

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--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 aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

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 a 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. A revisão não atual tem; rev=n como um sufixo em que 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 gerenciamento de API.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--filter-display-name

Filtro de APIs por displayName.

Propriedade	Valor
Grupo de parâmetros:	Schema Arguments

--skip

Número de registros a serem ignoradas.

--top

Número de registros a serem retornados.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--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 aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

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

Obter 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. A revisão não atual tem; rev=n como um sufixo em que 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>.

--schema-id

Identificador de esquema. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão.

Propriedade	Valor
Grupo de parâmetros:	Schema Arguments

--service-name -n

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

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--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 aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az apim api schema wait

Editar

Coloque a CLI em um estado de espera até que uma condição de um esquema de api apim 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 de api apim 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. A revisão não atual tem; rev=n como um sufixo em que n é o número de revisão. Required.

--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 de esquema. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Required.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--custom

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments

--deleted

Aguarde até ser excluído.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--exists

Aguarde até que o recurso exista.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

--interval

Intervalo de sondagem em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	30

--timeout

Espera máxima em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	3600

--updated

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Valor padrão:	False

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--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 aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

Comentários

Esta página foi útil?

Compartilhar via

az apim api schema

Comandos

az apim api schema create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim api schema delete

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim api schema get-etag

Exemplos

Parâmetros Exigidos

az apim api schema list

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az apim api schema show

Exemplos

Parâmetros Exigidos

az apim api schema wait

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários