az apim api

Administre las API de Azure API Management.

Comandos

Nombre	Description	Tipo	Estado
az apim api create	Cree una API de API Management.	Core	GA
az apim api delete	Elimine una API de API Management.	Core	GA
az apim api export	Exportar una API de API Management.	Core	GA
az apim api import	Importe una API de API Management.	Core	GA
az apim api list	Enumera las API de API Management.	Core	GA
az apim api operation	Administración de operaciones de api de Azure API Management.	Core	GA
az apim api operation create	Crea una nueva operación en la API.	Core	GA
az apim api operation delete	Elimina la operación especificada en la API.	Core	GA
az apim api operation list	Enumerar una colección de las operaciones de la API especificada.	Core	GA
az apim api operation show	Obtiene los detalles de la operación de API especificada por su identificador.	Core	GA
az apim api operation update	Actualiza los detalles de la operación en la API especificada por su identificador.	Core	GA
az apim api release	Administración de la versión de la API de Azure API Management.	Core	GA
az apim api release create	Crea una nueva versión para la API.	Core	GA
az apim api release delete	Elimina la versión especificada en la API.	Core	GA
az apim api release list	Enumera todas las versiones de una API.	Core	GA
az apim api release show	Devuelve los detalles de una versión de API.	Core	GA
az apim api release update	Actualiza los detalles de la versión de la API especificada por su identificador.	Core	GA
az apim api revision	Administración de la revisión de la API de Azure API Management.	Core	GA
az apim api revision create	Creación de una revisión de API.	Core	GA
az apim api revision list	Enumera todas las revisiones de una API.	Core	GA
az apim api schema	Administre los esquemas de api de Azure API Management.	Core	GA
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 show	Mostrar los detalles de una API de API Management.	Core	GA
az apim api update	Actualizar una API de API Management.	Core	GA
az apim api versionset	Administración del conjunto de versiones de la API de Azure API Management.	Core	GA
az apim api versionset create	Crea un conjunto de versiones de API.	Core	GA
az apim api versionset delete	Elimina un conjunto de versiones de API específico.	Core	GA
az apim api versionset list	Enumera una colección de conjuntos de versiones de API en la instancia de servicio especificada.	Core	GA
az apim api versionset show	Obtiene los detalles del conjunto de versiones de api especificado por su identificador.	Core	GA
az apim api versionset update	Actualiza los detalles del conjunto de versiones de API especificado por su identificador.	Core	GA
az apim api wait	Coloque la CLI en un estado de espera hasta que se cumpla una condición de una API de APIm.	Core	GA

az apim api create

Editar

Cree una API de API Management.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Ejemplos

Cree una API básica.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Parámetros requeridos

--api-id

Nombre único de la API que se va a crear.

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
Parameter group:	API Arguments

--display-name

Nombre para mostrar de la API que se va a crear.

Propiedad	Valor
Parameter group:	API Arguments

--path

Ruta de acceso a la API.

Propiedad	Valor
Parameter group:	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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-type

Tipo de la API.

Propiedad	Valor
Parameter group:	API Arguments
Valores aceptados:	graphql, http, soap, websocket

--authorization-scope

Especifica el ámbito de las operaciones de OAuth.

--authorization-server-id

Especifica el identificador del servidor de autorización de OAuth.

--bearer-token-sending-methods

Especifica los métodos de envío para el token de portador.

--description

Descripción de la API. Puede incluir etiquetas de formato HTML.

Propiedad	Valor
Parameter group:	API Arguments

--no-wait

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

Propiedad	Valor
Valor predeterminado:	False

--open-id-provider-id

Especifica el openid en la configuración de autenticación.

--protocols

Describe en qué protocolos se pueden invocar las operaciones de esta API.

Propiedad	Valor
Parameter group:	API Arguments
Valores aceptados:	http, https, ws, wss

--service-url

Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres.

Propiedad	Valor
Parameter group:	API Arguments

--subscription-key-header-name

Especifica el nombre del encabezado de clave de suscripción.

Propiedad	Valor
Parameter group:	API Arguments

--subscription-key-query-param-name

Especifica el nombre del parámetro de la cadena de consulta de clave de suscripción.

Propiedad	Valor
Parameter group:	API Arguments

--subscription-key-required

Especifica si se requiere la clave de suscripción durante la llamada a esta API, true: la API solo se incluye en productos cerrados, false: la API se incluye solo en productos abiertos, null; hay una combinación de productos.

--subscription-required

Si es true, la API requiere una clave de suscripción en las solicitudes.

Propiedad	Valor
Parameter group:	API Arguments
Valor predeterminado:	False
Valores aceptados:	false, true

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

Output format.

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 delete

Editar

Elimine una API de API Management.

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

Parámetros requeridos

--api-id

API identifier. 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
Parameter group:	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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--delete-revisions

Elimine todas las revisiones de la API.

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

Output format.

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 export

Editar

Exportar una API de API Management.

az apim api export --api-id
                   --ef --export-format {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Ejemplos

Exporte una API de API Management a un archivo o devuelva una respuesta que contenga un vínculo de la exportación.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

Parámetros requeridos

--api-id

API identifier. 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. Patrón regex: ^[^*#&+:<>?]+$.

Propiedad	Valor
Parameter group:	API Arguments

--ef --export-format

Especifique el formato de la API de exportación.

Propiedad	Valor
Valores aceptados:	OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl

--resource-group -g

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

--service-name -n

Nombre de la instancia del servicio api management.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--file-path -f

Ruta de acceso del archivo especificada para exportar la API.

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

Output format.

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 import

Editar

Importe una API de API Management.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Ejemplos

Importación de una API Management API Desde un archivo o una dirección URL

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Parámetros requeridos

--path

Required. Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management.

Propiedad	Valor
Parameter group:	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.

--specification-format

Especifique el formato de la API importada.

Propiedad	Valor
Valores aceptados:	GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id

API identifier. 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
Parameter group:	API Arguments

--api-revision

Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada.

Propiedad	Valor
Parameter group:	API Arguments

--api-type

Tipo de la API.

Propiedad	Valor
Parameter group:	API Arguments
Valores aceptados:	graphql, http, soap, websocket

--api-version

Describe la versión de la API. Si agrega una versión a una API sin versiones, se creará automáticamente una versión original y responderá en la dirección URL predeterminada.

Propiedad	Valor
Parameter group:	API Arguments

--api-version-set-id

Describe el conjunto de versiones que se va a usar con la API.

Propiedad	Valor
Parameter group:	API Arguments

--description

Descripción de la API. Puede incluir etiquetas de formato HTML.

Propiedad	Valor
Parameter group:	API Arguments

--display-name

Nombre para mostrar de esta API.

Propiedad	Valor
Parameter group:	API Arguments

--no-wait

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

Propiedad	Valor
Valor predeterminado:	False

--protocols

Describe en qué protocolos (una o varias) se pueden invocar las operaciones de esta API.

Propiedad	Valor
Parameter group:	API Arguments
Valores aceptados:	http, https, ws, wss

--service-url

Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres.

Propiedad	Valor
Parameter group:	API Arguments

--soap-api-type

Tipo de API cuando el formato de archivo es WSDL.

--specification-path

Ruta de acceso de archivo especificada para importar la API.

--specification-url

Dirección URL especificada para importar la API.

--subscription-key-header-name

Especifica el nombre del encabezado de clave de suscripción.

Propiedad	Valor
Parameter group:	API Arguments

--subscription-key-query-param-name

Especifica el nombre del parámetro de la cadena de consulta de clave de suscripción.

Propiedad	Valor
Parameter group:	API Arguments

--subscription-required

Si es true, la API requiere una clave de suscripción en las solicitudes.

Propiedad	Valor
Parameter group:	API Arguments
Valores aceptados:	false, true

--wsdl-endpoint-name

Nombre local del punto de conexión WSDL (puerto) que se va a importar.

--wsdl-service-name

Nombre local del servicio WSDL que se va a importar.

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

Output format.

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 list

Editar

Enumera las API de API Management.

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

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 de la instancia del servicio API Management.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter-display-name

Filtrar las API por displayName.

Propiedad	Valor
Parameter group:	API 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

Output format.

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 show

Editar

Mostrar los detalles de una API de API Management.

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

Parámetros requeridos

--api-id

API identifier. 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
Parameter group:	API Arguments

--resource-group -g

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

--service-name

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

Output format.

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 update

Editar

Actualizar una API de API Management.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Ejemplos

Cree una API básica.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Parámetros requeridos

--api-id

Nombre único de la API que se va a crear.

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
Parameter group:	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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Generic Update Arguments
Valor predeterminado:	[]

--api-type

Tipo de la API.

Propiedad	Valor
Parameter group:	API Arguments
Valores aceptados:	graphql, http, soap, websocket

--description

Descripción de la API. Puede incluir etiquetas de formato HTML.

Propiedad	Valor
Parameter group:	API Arguments

--display-name

API name. Debe tener entre 1 y 300 caracteres.

Propiedad	Valor
Parameter group:	API Arguments

--force-string

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

Propiedad	Valor
Parameter group:	Generic Update Arguments
Valor predeterminado:	False

--if-match

ETag de la entidad. No es necesario al crear una entidad, pero es necesaria al actualizar una entidad. El valor predeterminado es None.

--no-wait

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

Propiedad	Valor
Valor predeterminado:	False

--path

Required. Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management.

Propiedad	Valor
Parameter group:	API Arguments

--protocols

Describe en qué protocolos se pueden invocar las operaciones de esta API.

Propiedad	Valor
Parameter group:	API Arguments
Valores aceptados:	http, https, ws, wss

--remove

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

Propiedad	Valor
Parameter group:	Generic Update Arguments
Valor predeterminado:	[]

--service-url

Dirección URL absoluta del servicio back-end que implementa esta API. No puede tener más de 2000 caracteres.

Propiedad	Valor
Parameter group:	API 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
Parameter group:	Generic Update Arguments
Valor predeterminado:	[]

--subscription-key-header-name

Especifica el nombre del encabezado de clave de suscripción.

Propiedad	Valor
Parameter group:	API Arguments

--subscription-key-query-param-name

Especifica el nombre del parámetro de la cadena de consulta de clave de suscripción.

Propiedad	Valor
Parameter group:	API Arguments

--subscription-required

Si es true, la API requiere una clave de suscripción en las solicitudes.

Propiedad	Valor
Parameter group:	API Arguments
Valores aceptados:	false, true

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

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

Output format.

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 wait

Editar

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

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

Ejemplos

Coloque la CLI en un estado de espera hasta que se cumpla una condición de una API apim. (autogenerated)

az apim api wait --created --api-id MyApi --name MyApim --resource-group 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>.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Propiedad	Valor
Parameter group:	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
Parameter group:	Wait Condition Arguments

--deleted

Espere hasta que se elimine.

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	False

--exists

Espere hasta que exista el recurso.

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	False

--interval

Intervalo de sondeo en segundos.

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	30

--timeout

Espera máxima en segundos.

Propiedad	Valor
Parameter group:	Wait Condition Arguments
Valor predeterminado:	3600

--updated

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

Propiedad	Valor
Parameter group:	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

Output format.

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

Compartir a través de

az apim api

Comandos

az apim api create

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim api delete

Parámetros requeridos

Parámetros opcionales

az apim api export

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim api import

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim api list

Parámetros requeridos

Parámetros opcionales

az apim api show

Parámetros requeridos

az apim api update

Ejemplos

Parámetros requeridos

Parámetros opcionales

az apim api wait

Ejemplos

Parámetros requeridos

Parámetros opcionales

Comentarios