az apic metadata

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

Comandos para gerenciar esquemas de metadados na Central de APIs.

Comandos

Nome	Descrição	Tipo	Estado
az apic metadata create	Crie um novo esquema de metadados ou atualize um esquema de metadados existente.	Extension	disponibilidade geral
az apic metadata delete	Exclua o esquema de metadados especificado.	Extension	disponibilidade geral
az apic metadata export	Exporta o esquema de metadados.	Extension	disponibilidade geral
az apic metadata list	Listar uma coleção de esquemas de metadados.	Extension	disponibilidade geral
az apic metadata show	Obtenha detalhes do esquema de metadados.	Extension	disponibilidade geral
az apic metadata update	Atualize o esquema de metadados existente.	Extension	disponibilidade geral

az apic metadata create

Crie um novo esquema de metadados ou atualize um esquema de metadados existente.

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

Exemplos

Criar metadados exemplo 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

Criar metadados exemplo 2

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

Criar metadados usando o esquema de arquivo json e exemplo de atribuições

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json'

Parâmetros Obrigatórios

--assignments

Define o escopo de atribuição para os metadados personalizados, por exemplo, "[{entity:api,required:true,deprecated:false}]". Os valores de entidade disponíveis são: api, deployment, environment. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--metadata-name

O nome do esquema de metadados.

--resource-group -g

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

--schema

Esquema JSON definindo o tipo.

Propriedade	Valor
Grupo de parâmetros:	Properties Arguments

--service-name -n

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

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

Exclua o esquema de metadados especificado.

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

Exemplos

Excluir esquema de metadados

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

Excluir esquema

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

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.

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

--metadata-name

O nome do esquema de metadados.

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

Exporta o esquema de metadados.

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--custom-metadata-only {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

Exemplos

Exportar esquema de metadados atribuído à api

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

Exportar esquema de metadados atribuído à implantação

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

Exportar esquema de metadados atribuído ao ambiente

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

Exportar somente esquema de metadados personalizados

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json --custom-metadata-only

Parâmetros Obrigatórios

--assignments

Uma entidade para a qual o esquema de metadados é solicitado.

Propriedade	Valor
Grupo de parâmetros:	Payload Arguments
Valores aceites:	api, deployment, environment

--file-name

Nome do arquivo para o qual exportar o esquema de metadados.

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

Exporte apenas metadados personalizados.

Propriedade	Valor
Valores aceites:	0, 1, f, false, n, no, t, true, y, yes

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--no-wait

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

Propriedade	Valor
Valores aceites:	0, 1, f, false, n, no, t, true, y, yes

--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 do Centro de APIs.

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

Listar uma coleção de esquemas de metadados.

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

Exemplos

Listar esquemas

az apic metadata 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 metadata show

Obtenha detalhes do esquema de metadados.

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

Exemplos

Mostrar detalhes do esquema 1

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

Mostrar detalhes do esquema 2

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

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.

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--metadata-name

O nome do esquema de metadados.

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

Atualize o esquema de metadados existente.

az apic metadata update [--add]
                        [--assignments]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-name]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service-name]
                        [--set]
                        [--subscription]

Exemplos

Esquema de atualização

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

Atualizar esquema usando o arquivo json do esquema

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'

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

--assignments

Propriedade	Valor
Grupo de parâmetros:	Properties 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

--metadata-name

O nome do esquema de metadados.

Propriedade	Valor
Grupo de parâmetros:	Resource Id 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

--schema

Esquema YAML definindo o tipo.

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

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 metadata

Comandos

az apic metadata create

Exemplos

Parâmetros Obrigatórios

az apic metadata delete

Exemplos

Parâmetros Opcionais

az apic metadata export

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apic metadata list

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az apic metadata show

Exemplos

Parâmetros Opcionais

az apic metadata update

Exemplos

Parâmetros Opcionais

Feedback