Compartir a través de

az apim api schema

  • Referencia

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.

 Principal GA
az apim api schema delete

Elimine un esquema de API Management API.

 Principal GA
az apim api schema get-etag

Obtenga etag de un esquema de API Management API.

 Principal GA
az apim api schema list

Enumerar los esquemas de API Management API.

 Principal GA
az apim api schema show

Mostrar detalles de un esquema de API Management API.

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

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

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

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

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros opcionales

--no-wait

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

valor predeterminado: False
--resource-type

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

--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 de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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.

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

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros opcionales

--if-match

ETag de la entidad.

--no-wait

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

valor predeterminado: False
--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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.

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

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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.

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

--filter-display-name

Filtrar las API por displayName.

--skip

Número de registros que se van a omitir.

--top

Número de registros que se va a devolver.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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.

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

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

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

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

Parámetros opcionales

--created

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

valor predeterminado: False
--custom

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

--deleted

Espere hasta que se elimine.

valor predeterminado: False
--exists

Espere hasta que exista el recurso.

valor predeterminado: False
--interval

Intervalo de sondeo en segundos.

valor predeterminado: 30
--timeout

Espera máxima en segundos.

valor predeterminado: 3600
--updated

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

valor predeterminado: False
Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.