az apim api schema

Administre los esquemas de api de Azure API Management.

Comandos

Nombre	Description	Tipo	Estado
az apim api schema create	Cree un esquema de API Management API.	Core	GA
az apim api schema delete	Elimine un esquema de API Management API.	Core	GA
az apim api schema get-etag	Obtenga etag de un esquema de API Management API.	Core	GA
az apim api schema list	Enumerar los esquemas de API Management API.	Core	GA
az apim api schema show	Mostrar detalles de un esquema de API Management API.	Core	GA
az apim api schema wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición de un esquema de APIm.	Core	GA

az apim api schema create

Editar

Cree un esquema de API Management 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]

Ejemplos

Cree un 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 requeridos

--api-id

Nombre único de la API para la que se debe crear el esquema.

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad	Valor
Grupo de parámetros:	API Arguments

--resource-group -g

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

--schema-id

Nombre único del esquema de API que se va a crear.

Identificador de esquema. Debe ser único en la instancia actual del servicio API Management.

Propiedad	Valor
Grupo de parámetros:	Schema Arguments

--schema-type

Tipo de esquema (por ejemplo, application/json, application/vnd.ms-azure-apim.graphql.schema).

Debe ser un tipo de medio válido usado en un encabezado Content-Type tal como se define en RFC 2616. Tipo de medio del documento de esquema.

Propiedad	Valor
Grupo de parámetros:	Schema Arguments

--service-name -n

Nombre de la instancia del servicio API Management.

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.

--no-wait

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

Propiedad	Valor
Valor predeterminado:	False

--resource-type

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts".

Propiedad	Valor
Grupo de parámetros:	Schema Arguments

--schema-content

Cadena de escape json que define el documento que representa el esquema.

Especifique --schema-path o --schema-content no ambos.

--schema-name

Nombre del recurso de esquema.

--schema-path

Ruta de acceso de archivo especificada para importar el esquema de la API.

Especifique --schema-path o --schema-content no ambos.

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 apim api schema delete

Editar

Elimine un esquema de API Management API.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

Ejemplos

eliminar un esquema de API.

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

Parámetros requeridos

--api-id

Identificador de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad	Valor
Grupo de parámetros:	API Arguments

--resource-group -g

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

--schema-id

Identificador de esquema. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad	Valor
Grupo de parámetros:	Schema Arguments

--service-name -n

Nombre de la instancia del servicio API Management.

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.

--if-match

ETag de la entidad.

--no-wait

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

Propiedad	Valor
Valor predeterminado:	False

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

--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 apim api schema get-etag

Editar

Obtenga etag de un esquema de API Management API.

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

Ejemplos

obtiene una etiqueta de entidad de esquema.

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

Parámetros requeridos

--api-id

Identificador de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad	Valor
Grupo de parámetros:	API Arguments

--resource-group -g

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

--schema-id

Identificador de esquema. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad	Valor
Grupo de parámetros:	Schema Arguments

--service-name -n

Nombre de la instancia del servicio API Management.

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 apim api schema list

Editar

Enumerar los esquemas de API Management API.

az apim api schema list --api-id
                        --resource-group
                        --service-name
                        [--filter-display-name]
                        [--skip]
                        [--top]

Ejemplos

Obtenga la lista de esquemas asociados a un identificador de API.

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

Parámetros requeridos

--api-id

Identificador de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad	Valor
Grupo de parámetros:	API Arguments

--resource-group -g

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

--service-name -n

Nombre de la instancia del servicio API Management.

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

Filtrar las API por displayName.

Propiedad	Valor
Grupo de parámetros:	Schema Arguments

--skip

Número de registros que se van a omitir.

--top

Número de registros que se van a devolver.

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 apim api schema show

Editar

Mostrar detalles de un esquema de API Management API.

az apim api schema show --api-id
                        --resource-group
                        --schema-id
                        --service-name

Ejemplos

Obtener un esquema de API.

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

Parámetros requeridos

--api-id

Identificador de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad	Valor
Grupo de parámetros:	API Arguments

--resource-group -g

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

--schema-id

Identificador de esquema. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

Propiedad	Valor
Grupo de parámetros:	Schema Arguments

--service-name -n

Nombre de la instancia del servicio API Management.

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 apim api schema wait

Editar

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un esquema de APIm.

az apim api schema wait --api-id
                        --name
                        --resource-group
                        --schema-id
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Ejemplos

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un esquema de APIm.

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

Parámetros requeridos

--api-id

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión. Required.

--name -n

Nombre de la instancia del servicio api management.

--resource-group -g

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

--schema-id

Identificador de identificador de esquema. Debe ser único en la instancia actual del servicio API Management. Required.

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.

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments

--deleted

Espere hasta que se elimine.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--exists

Espere hasta que exista el recurso.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	False

--interval

Intervalo de sondeo en segundos.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	30

--timeout

Espera máxima en segundos.

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
Valor predeterminado:	3600

--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Propiedad	Valor
Grupo de parámetros:	Wait Condition Arguments
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.

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

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

az apim api schema

Comandos

az apim api schema create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim api schema delete

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim api schema get-etag

Ejemplos

Parámetros requeridos

az apim api schema list

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim api schema show

Ejemplos

Parámetros requeridos

az apim api schema wait

Ejemplos

Parámetros requeridos

Parámetros opcionales

Comentarios