Compartir a través de

az apic api deployment

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 api deployment. Obtenga más información sobre las extensiones.

Comandos para administrar implementaciones de API en el Centro de API.

Comandos

Nombre Description Tipo Estado
az apic api deployment create

Cree una nueva implementación de API o actualice una implementación de API existente.

 Extension GA
az apic api deployment delete

Eliminar implementación de API.

 Extension GA
az apic api deployment list

Enumeración de una colección de implementaciones de API.

 Extension GA
az apic api deployment show

Obtenga detalles de la implementación de la API.

 Extension GA
az apic api deployment update

Actualice la implementación de API existente.

 Extension GA

az apic api deployment create

Cree una nueva implementación de API o actualice una implementación de API existente.

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

Ejemplos

Creación de una implementación

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Creación de una implementación mediante el archivo json del servidor

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

Parámetros requeridos

--api-id

Identificador de la API.

--definition-id

Identificador de recurso de definición con ámbito del centro de API.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--deployment-id

Identificador de la implementación de la API.

--environment-id

Identificador de recurso de entorno con ámbito del centro de API.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--resource-group -g

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

--server

Server Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--service-name -n

Nombre del servicio Azure API Center.

--title

Título de implementación.

Propiedad Valor
Grupo de parámetros: Properties Arguments

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

Metadatos personalizados definidos para las entidades del catálogo de API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--description

Descripción de la implementación.

Propiedad Valor
Grupo de parámetros: Properties 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 api deployment delete

Eliminar implementación de API.

az apic api deployment delete [--api-id]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--yes]

Ejemplos

Eliminación de la implementación de API

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

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.

--api-id

Identificador de la API.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--deployment-id

Identificador de la implementación de la API.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--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
--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 api deployment list

Enumeración de una colección de implementaciones de API.

az apic api deployment list --api-id
                            --resource-group
                            --service-name
                            [--filter]
                            [--max-items]
                            [--next-token]

Ejemplos

Enumerar implementaciones de API

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

Parámetros requeridos

--api-id

Identificador de la API.

--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 api deployment show

Obtenga detalles de la implementación de la API.

az apic api deployment show [--api-id]
                            [--deployment-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]

Ejemplos

Mostrar detalles de implementación de API

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

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.

--api-id

Identificador de la API.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--deployment-id

Identificador de la implementación de la API.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--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
--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 api deployment update

Actualice la implementación de API existente.

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]

Ejemplos

Actualización de la implementación de API

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

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

Identificador de la API.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--custom-properties

Metadatos personalizados definidos para las entidades del catálogo de API. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--definition-id

Identificador de recurso de definición con ámbito de servicio.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--deployment-id

Identificador de la implementación de la API.

Propiedad Valor
Grupo de parámetros: Resource Id Arguments
--description

Descripción de la implementación.

Propiedad Valor
Grupo de parámetros: Properties Arguments
--environment-id

Identificador de recurso de entorno con ámbito de servicio.

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

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

Server Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

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

Title.

Propiedad Valor
Grupo de parámetros: Properties 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