az apic metadata

Note

Esta referencia forma parte de la extensión apic-extension para la CLI de Azure (versión 2.57.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az apic metadata . Obtenga más información sobre las extensiones.

Comandos para administrar esquemas de metadatos en el Centro de API.

Comandos

Nombre	Description	Tipo	Estado
az apic metadata create	Cree un nuevo esquema de metadatos o actualice un esquema de metadatos existente.	Extension	GA
az apic metadata delete	Elimine el esquema de metadatos especificado.	Extension	GA
az apic metadata export	Exporta el esquema de metadatos.	Extension	GA
az apic metadata list	Enumerar una colección de esquemas de metadatos.	Extension	GA
az apic metadata show	Obtenga detalles del esquema de metadatos.	Extension	GA
az apic metadata update	Actualice el esquema de metadatos existente.	Extension	GA

az apic metadata create

Cree un nuevo esquema de metadatos o actualice un esquema de metadatos existente.

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

Ejemplos

Ejemplo 1 de creación de metadatos

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}]'

Ejemplo 2 de creación de metadatos

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}]'

Ejemplo de creación de metadatos mediante el esquema y las asignaciones de archivos JSON

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

Parámetros requeridos

--assignments

Define el ámbito de asignación para los metadatos personalizados, por ejemplo"[ {entity:api,required:true,deprecated:false}]". Los valores de entidad disponibles son: api, implementación, entorno. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--metadata-name

Nombre del esquema de metadatos.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--schema

Esquema JSON que define el tipo.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--service-name -n

Nombre del servicio Azure API Center.

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apic metadata delete

Elimine el esquema de metadatos especificado.

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

Ejemplos

Eliminar esquema de metadatos

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

Eliminar esquema

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--ids

Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--metadata-name

Nombre del esquema de metadatos.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--yes -y

No solicita confirmación.

Propiedad	Valor
Valor predeterminado:	False

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apic metadata export

Exporta el esquema de metadatos.

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]

Ejemplos

Exportación del esquema de metadatos asignado a la API

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

Exportación del esquema de metadatos asignado a la implementación

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

Exportación del esquema de metadatos asignado al entorno

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

Exportar solo esquema de metadatos personalizados

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

Parámetros requeridos

--assignments

Una entidad para la que se solicita el esquema de metadatos.

Propiedad	Valor
Grupo de parámetros:	Payload Arguments
Valores aceptados:	api, deployment, environment

--file-name

Nombre del archivo al que se va a exportar el esquema de metadatos.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--custom-metadata-only

Exporte solo metadatos personalizados.

Propiedad	Valor
Valores aceptados:	0, 1, f, false, n, no, t, true, y, yes

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad	Valor
Valores aceptados:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--service-name -n

Nombre del servicio del Centro de API.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apic metadata list

Enumerar una colección de esquemas de metadatos.

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

Ejemplos

Enumerar esquemas

az apic metadata list -g api-center-test -n contosoeuap

Parámetros requeridos

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre del servicio Azure API Center.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--filter

Parámetro de filtro OData.

--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token argumento de un comando posterior.

Propiedad	Valor
Grupo de parámetros:	Pagination Arguments

--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

Propiedad	Valor
Grupo de parámetros:	Pagination Arguments

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apic metadata show

Obtenga detalles del esquema de metadatos.

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

Ejemplos

Mostrar los detalles del esquema 1

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

Mostrar los detalles del esquema 2

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--metadata-name

Nombre del esquema de metadatos.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

az apic metadata update

Actualice el esquema de metadatos 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]

Ejemplos

Actualización del 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]+$"}'

Actualización del esquema mediante el archivo json de esquema

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments

--assignments

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments
Valores aceptados:	0, 1, f, false, n, no, t, true, y, yes

--ids

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--metadata-name

Nombre del esquema de metadatos.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--schema

Esquema YAML que define el tipo.

Propiedad	Valor
Grupo de parámetros:	Properties Arguments

--service-name -n

Nombre del servicio Azure API Center.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Propiedad	Valor
Grupo de parámetros:	Generic Update Arguments

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Propiedad	Valor
Grupo de parámetros:	Resource Id Arguments

Parámetros globales

--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad	Valor
Valor predeterminado:	False

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad	Valor
Valor predeterminado:	False

--output -o

Formato de salida.

Propiedad	Valor
Valor predeterminado:	json
Valores aceptados:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad	Valor
Valor predeterminado:	False

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

az apic metadata

Comandos

az apic metadata create

Ejemplos

Parámetros requeridos

az apic metadata delete

Ejemplos

Parámetros opcionales

az apic metadata export

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic metadata list

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apic metadata show

Ejemplos

Parámetros opcionales

az apic metadata update

Ejemplos

Parámetros opcionales

Comentarios