az apim api schema

Gerencie o esquema da API de Gerenciamento de API do Azure.

Comandos

Name	Description	Tipo	Status
az apim api schema create	Crie um esquema de API de gerenciamento de API.	Core	disponibilidade geral
az apim api schema delete	Exclua um esquema de API de gerenciamento de API.	Core	disponibilidade geral
az apim api schema get-etag	Obtenha etag de um esquema de API de Gerenciamento de API.	Core	disponibilidade geral
az apim api schema list	Listar esquemas de API de Gerenciamento de API.	Core	disponibilidade geral
az apim api schema show	Mostrar detalhes de um esquema de API de gerenciamento de API.	Core	disponibilidade geral
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.	Core	disponibilidade geral

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 Obrigatórios

--api-id

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

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 de serviço de Gerenciamento de API atual.

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 na 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 de Gerenciamento de API.

Parâmetros Opcionais

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

--no-wait

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

Propriedade	Valor
Default value:	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, 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 de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	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
Default value:	False

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

exclua um esquema de API.

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

Parâmetros Obrigatórios

--api-id

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 de Gerenciamento de API.

Parâmetros Opcionais

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

--if-match

ETag da Entidade.

--no-wait

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

Propriedade	Valor
Default value:	False

--yes -y

Não solicite confirmação.

Propriedade	Valor
Default value:	False

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	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
Default value:	False

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 Obrigatórios

--api-id

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 de Gerenciamento de API.

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	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
Default value:	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 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 Obrigatórios

--api-id

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 de Gerenciamento de API.

Parâmetros Opcionais

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

--filter-display-name

Filtro de APIs por displayName.

Propriedade	Valor
Grupo de parâmetros:	Schema Arguments

--skip

Número de registos a ignorar.

--top

Número de registos a devolver.

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	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
Default value:	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

Obtenha um esquema de API.

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

Parâmetros Obrigatórios

--api-id

Identificador de API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 de Gerenciamento de API.

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	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
Default value:	False

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 Obrigatórios

--api-id

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde 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 do esquema. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Required.

Parâmetros Opcionais

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

--created

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	False

--custom

Aguarde até que a condição satisfaç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
Default value:	False

--exists

Aguarde até que o recurso exista.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	False

--interval

Intervalo de sondagem em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	30

--timeout

Espera máxima em segundos.

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	3600

--updated

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

Propriedade	Valor
Grupo de parâmetros:	Wait Condition Arguments
Default value:	False

Parâmetros de Globais

--debug

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

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	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
Default value:	False

Feedback

Esta página foi útil?

Partilhar via

az apim api schema

Comandos

az apim api schema create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api schema delete

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api schema get-etag

Exemplos

Parâmetros Obrigatórios

az apim api schema list

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apim api schema show

Exemplos

Parâmetros Obrigatórios

az apim api schema wait

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Feedback