Compartilhar via

az apic metadata

  • Referência

Nota

Essa referência faz parte da extensão de extensão apic para a CLI do Azure (versão 2.57.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando de metadados az apic az apic. Saiba mais sobre extensões.

Comandos para gerenciar esquemas de metadados no Centro de API.

Comandos

Nome Description Tipo Status
az apic metadata create

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

 Extensão GA
az apic metadata delete

Exclua o esquema de metadados especificado.

 Extensão GA
az apic metadata export

Exporta o esquema de metadados.

 Extensão GA
az apic metadata list

Listar uma coleção de esquemas de metadados.

 Extensão GA
az apic metadata show

Obtenha detalhes do esquema de metadados.

 Extensão GA
az apic metadata update

Atualize o esquema de metadados existente.

 Extensão GA

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 o exemplo de metadados 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 o exemplo de metadados 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 o 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 Exigidos

--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, implantação, ambiente. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

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

--service-name -n

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

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

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

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

--service-name -n

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

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 Exigidos

--assignments

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

Valores aceitos: api, deployment, environment
--file-name

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

Parâmetros Opcionais

--custom-metadata-only

Exportar somente metadados personalizados.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--no-wait

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

Valores aceitos: 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>.

--service-name -n

O nome do serviço do Centro de API.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

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 Exigidos

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

Parâmetros Opcionais

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

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor do token de uma resposta truncada anteriormente.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

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

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

--service-name -n

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.

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

Atualizar esquema

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

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

--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, implantação, ambiente. Suporte a sintaxe abreviada, arquivo json e yaml-file. Tente "??" para mostrar mais.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter em JSON.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

--metadata-name

O nome do esquema de metadados.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--schema

Esquema YAML definindo o tipo.

--service-name -n

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

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

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

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Apenas mostrar 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 a verbosidade do registro em log. Use --debug para logs de depuração completos.