Share via

az connectedmachine extension

  • Referencia

Nota:

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

Administrar una extensión de máquina virtual en un servidor habilitado para Azure Arc.

Comandos

Nombre Description Tipo Estado
az connectedmachine extension create

Operación para crear la extensión.

 Extensión GA
az connectedmachine extension delete

Operación para eliminar la extensión.

 Extensión GA
az connectedmachine extension image

Administre los metadatos de la extensión de máquina virtual disponibles para los servidores habilitados para Azure Arc.

 Extensión GA
az connectedmachine extension image list

Enumere todas las versiones de extensión basadas en la ubicación, el publicador, extensionType.

 Extensión GA
az connectedmachine extension image show

Obtenga un metadato de extensión basado en la ubicación, el publicador, extensionType y la versión.

 Extensión GA
az connectedmachine extension list

La operación para obtener todas las extensiones de una máquina que no es de Azure.

 Extensión GA
az connectedmachine extension show

Operación para crear o actualizar la extensión.

 Extensión GA
az connectedmachine extension update

Operación de actualización para actualizar la extensión.

 Extensión GA
az connectedmachine extension wait

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

 Extensión GA

az connectedmachine extension create

Operación para crear la extensión.

az connectedmachine extension create --extension-name
                                     --machine-name
                                     --resource-group
                                     [--auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--auto-upgrade-minor {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--instance-view]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--settings]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Ejemplos

Comando de ejemplo para la creación de extensiones

az connectedmachine extension create --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

Parámetros requeridos

--extension-name --name -n

Nombre de la extensión del equipo.

--machine-name

Nombre del equipo donde se debe crear o actualizar la extensión.

--resource-group -g

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

Parámetros opcionales

--auto-upgrade --enable-auto-upgrade --enable-automatic-upgrade

Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente disponible.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--auto-upgrade-minor --auto-upgrade-minor-version --upgrade-minor-ver

Indica si la extensión debe usar una versión secundaria más reciente si está disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--force-update-tag

Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado.

--instance-view

Vista de instancia de extensión de máquina. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--location -l

Ubicación geográfica donde reside el recurso Cuando no se especifica, se usará la ubicación del grupo de recursos.

--no-wait

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

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--protected-settings

La extensión puede contener configuraciones protegidas Configuración o protegidas Configuración FromKeyVault o ninguna configuración protegida. Admite json-file y yaml-file.

--publisher

Nombre del publicador de controladores de extensión.

--settings

Configuración pública con formato JSON para la extensión. Admite json-file y yaml-file.

--tags

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

--type

Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".

--type-handler-version

Especifica la versión del controlador de script.

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 connectedmachine extension delete

Operación para eliminar la extensión.

az connectedmachine extension delete [--extension-name]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Ejemplos

Comando de ejemplo para la eliminación de extensiones

az connectedmachine extension delete --name myName --machine-name myMachine --resource-group myResourceGroup

Parámetros opcionales

--extension-name --name -n

Nombre de la extensión del equipo.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--machine-name

Nombre del equipo donde se debe eliminar la extensión.

--no-wait

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

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

--subscription

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

--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 connectedmachine extension list

La operación para obtener todas las extensiones de una máquina que no es de Azure.

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]

Ejemplos

Comando de ejemplo para la lista de extensiones

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

Parámetros requeridos

--machine-name

Nombre de la máquina que contiene la extensión.

--resource-group -g

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

Parámetros opcionales

--expand

Expresión expand que se va a aplicar en la operación.

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 connectedmachine extension show

Operación para crear o actualizar la extensión.

az connectedmachine extension show [--extension-name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

Ejemplos

Comando de ejemplo para la presentación de extensiones

az connectedmachine extension show --name CustomScriptExtension --machine-name myMachine --resource-group myResourceGroup

Parámetros opcionales

--extension-name --name -n

Nombre de la extensión del equipo.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--machine-name

Nombre de la máquina que contiene la extensión.

--resource-group -g

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

--subscription

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

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 connectedmachine extension update

Operación de actualización para actualizar la extensión.

az connectedmachine extension update [--add]
                                     [--auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--auto-upgrade-minor {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--settings]
                                     [--subscription]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Ejemplos

Comando de ejemplo para la actualización de extensiones

az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

Parámetros opcionales

--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 o JSON string>.

--auto-upgrade --enable-auto-upgrade --enable-automatic-upgrade

Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente disponible.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--auto-upgrade-minor --auto-upgrade-minor-version --upgrade-minor-ver

Indica si la extensión debe usar una versión secundaria más reciente si está disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--extension-name --name -n

Nombre de la extensión del equipo.

--force-string

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

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--force-update-tag

Cómo se debe forzar el controlador de extensión para actualizar incluso si la configuración de la extensión no ha cambiado.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--instance-view

Vista de instancia de extensión de máquina. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--machine-name

Nombre de la máquina que contiene la extensión.

--no-wait

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

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--protected-settings

La extensión puede contener configuraciones protegidas Configuración o protegidas Configuración FromKeyVault o ninguna configuración protegida. Admite json-file y yaml-file.

--publisher

Nombre del publicador de controladores de extensión.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

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

--settings

Configuración pública con formato JSON para la extensión. Admite json-file y yaml-file.

--subscription

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

--tags

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

--type

Especifica el tipo de la extensión; Un ejemplo es "CustomScriptExtension".

--type-handler-version

Especifica la versión del controlador de script.

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 connectedmachine extension wait

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

az connectedmachine extension wait [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--extension-name]
                                   [--ids]
                                   [--interval]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

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
--extension-name --name -n

Nombre de la extensión del equipo.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--interval

Intervalo de sondeo en segundos.

valor predeterminado: 30
--machine-name

Nombre de la máquina que contiene la extensión.

--resource-group -g

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

--subscription

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

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