Compartir a través de


az k8s-extension

Note

This reference is part of the k8s-extension extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az k8s-extension command. Learn more about extensions.

Comandos para administrar extensiones de Kubernetes.

Comandos

Nombre Description Tipo Estado
az k8s-extension create

Cree una extensión de clúster de Kubernetes, incluida la compra de una oferta de extensión de Azure Marketplace (solo AKS). Consulte el ejemplo al final para ver cómo crear una extensión o comprar una oferta de extensión.

Extension GA
az k8s-extension delete

Elimine una extensión de Kubernetes.

Extension GA
az k8s-extension extension-types

Comandos para detectar tipos de extensión de Kubernetes.

Extension Preview
az k8s-extension extension-types list-by-cluster

Enumere los tipos de extensión de clúster disponibles para un clúster existente. Las propiedades usadas para filtrar incluyen el tipo de clúster (administrado, conectado, etc.), la versión de Kubernetes, la ubicación del clúster.

Extension Preview
az k8s-extension extension-types list-by-location

Enumere los tipos de extensión de clúster disponibles en una región.

Extension Preview
az k8s-extension extension-types list-versions-by-cluster

Enumere las versiones disponibles para un tipo de extensión de clúster para un clúster determinado. Las propiedades usadas para filtrar incluyen el tipo de clúster (administrado, conectado, etc.), la versión de Kubernetes, la ubicación del clúster.

Extension Preview
az k8s-extension extension-types list-versions-by-location

Enumere las versiones disponibles para las versiones de tipo de extensión de clúster en una región.

Extension Preview
az k8s-extension extension-types show-by-cluster

Mostrar las propiedades de un tipo de extensión de clúster para un clúster existente. Las propiedades usadas para filtrar incluyen el tipo de clúster (administrado, conectado, etc.), la versión de Kubernetes, la ubicación del clúster.

Extension Preview
az k8s-extension extension-types show-by-location

Mostrar las propiedades de un tipo de extensión de clúster en una región.

Extension Preview
az k8s-extension extension-types show-version-by-cluster

Mostrar las propiedades asociadas a una versión de tipo de extensión de clúster para un clúster existente. Las propiedades usadas para filtrar incluyen el tipo de clúster (administrado, conectado, etc.), la versión de Kubernetes, la ubicación del clúster.

Extension Preview
az k8s-extension extension-types show-version-by-location

Mostrar las propiedades asociadas a una versión de tipo de extensión de clúster en una región.

Extension Preview
az k8s-extension list

Enumerar extensiones de Kubernetes.

Extension GA
az k8s-extension show

Mostrar una extensión de Kubernetes.

Extension GA
az k8s-extension update

Actualice las propiedades mutables de una extensión de Kubernetes.

Extension GA

az k8s-extension create

Cree una extensión de clúster de Kubernetes, incluida la compra de una oferta de extensión de Azure Marketplace (solo AKS). Consulte el ejemplo al final para ver cómo crear una extensión o comprar una oferta de extensión.

Cree una extensión de Kubernetes. La salida incluye secretos que debe proteger. Asegúrese de que no incluya estos secretos en el control de código fuente. Compruebe también que no haya secretos presentes en los registros del comando o script. Para obtener más información, vea http://aka.ms/clisecrets.

az k8s-extension create --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --extension-type
                        --name
                        --resource-group
                        [--auto-upgrade --auto-upgrade-minor-version {false, true}]
                        [--cluster-resource-provider --cluster-rp]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-file]
                        [--config-settings]
                        [--configuration-protected-settings]
                        [--configuration-protected-settings-file]
                        [--configuration-settings-file]
                        [--no-wait]
                        [--plan-name]
                        [--plan-product]
                        [--plan-publisher]
                        [--release-namespace]
                        [--release-train]
                        [--scope {cluster, namespace}]
                        [--target-namespace]
                        [--version]

Ejemplos

Creación de una extensión de Kubernetes

az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --extension-type microsoft.openservicemesh --scope cluster --release-train stable

Creación de una extensión de Marketplace de Kubernetes

az k8s-extension create --resource-group my-resource-group --cluster-name mycluster --cluster-type managedClusters --name myextension --extension-type Contoso.AzureVoteKubernetesAppTest --scope cluster --release-train stable --plan-name testplan --plan-product kubernetest_apps_demo_offer --plan-publisher test_test_mix3pptest0011614206850774

Parámetros requeridos

--cluster-name -c

Nombre del clúster de Kubernetes.

--cluster-type -t

Especifique clústeres de Arc o clústeres administrados de AKS o dispositivos de Arc o aprovisionadosClusters.

Propiedad Valor
Valores aceptados: appliances, connectedClusters, managedClusters, provisionedClusters
--extension-type

Nombre del tipo de extensión.

--name -n

Nombre de la instancia de extensión.

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

--auto-upgrade --auto-upgrade-minor-version

Actualice automáticamente la versión secundaria de la instancia de extensión.

Propiedad Valor
Parameter group: Version Arguments
Valores aceptados: false, true
--cluster-resource-provider --cluster-rp

Nombre del proveedor de recursos de clúster para este clusterType (obligatorio para provisionedClusters).

--config --configuration-settings

Opciones de configuración como par clave=valor. Repita el parámetro para cada configuración. No lo use para secretos, ya que este valor se devuelve en respuesta.

Propiedad Valor
Parameter group: Configuration Arguments
--config-file --config-settings-file

Ruta de acceso del archivo JSON para las opciones de configuración.

Propiedad Valor
Parameter group: Configuration Arguments
--config-protected --config-protected-settings

Valores protegidos de configuración como par clave=valor. Repita el parámetro para cada configuración. Solo se devuelve la clave en respuesta, el valor no.

Propiedad Valor
Parameter group: Configuration Arguments
--config-protected-file --config-protected-settings-file

Ruta de acceso del archivo JSON para la configuración protegida por la configuración.

Propiedad Valor
Parameter group: Configuration Arguments
--config-settings
Obsoleto

La opción "--config-settings" está en desuso y se quitará en una versión futura. Use "--configuration-settings" en su lugar.

Opciones de configuración como par clave=valor. Repita el parámetro para cada configuración. No lo use para secretos, ya que este valor se devuelve en respuesta.

Propiedad Valor
Parameter group: Configuration Arguments
--configuration-protected-settings
Obsoleto

La opción "--configuration-protected-settings" está en desuso y se quitará en una versión futura. Use "--config-protected-settings" en su lugar.

Valores protegidos de configuración como par clave=valor. Repita el parámetro para cada configuración. Solo se devuelve la clave en respuesta, el valor no.

Propiedad Valor
Parameter group: Configuration Arguments
--configuration-protected-settings-file
Obsoleto

La opción "--configuration-protected-settings-file" está en desuso y se quitará en una versión futura. Use "--config-protected-file" en su lugar.

Ruta de acceso del archivo JSON para la configuración protegida por la configuración.

Propiedad Valor
Parameter group: Configuration Arguments
--configuration-settings-file
Obsoleto

La opción "--configuration-settings-file" está en desuso y se quitará en una versión futura. Use "--config-settings-file" en su lugar.

Ruta de acceso del archivo JSON para las opciones de configuración.

Propiedad Valor
Parameter group: Configuration Arguments
--no-wait

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

Propiedad Valor
Valor predeterminado: False
--plan-name

El nombre del plan hace referencia al identificador de plan de la extensión que se toma del portal de Marketplace en Información de uso y soporte técnico.

Propiedad Valor
Parameter group: Marketplace Arguments
--plan-product

El producto del plan hace referencia al identificador de producto de la extensión que se toma del portal de Marketplace en Información de uso y soporte técnico. Un ejemplo de esto es el nombre de la oferta de ISV usada.

Propiedad Valor
Parameter group: Marketplace Arguments
--plan-publisher

El publicador del plan hace referencia al identificador del publicador de la extensión que se toma del portal de Marketplace en Información de uso y soporte técnico.

Propiedad Valor
Parameter group: Marketplace Arguments
--release-namespace

Especifique el espacio de nombres para instalar la versión de extensión.

--release-train

Especifique el entrenamiento de versión para el tipo de extensión.

Propiedad Valor
Parameter group: Version Arguments
--scope

Especifique el ámbito de extensión.

Propiedad Valor
Valores aceptados: cluster, namespace
--target-namespace

Especifique el espacio de nombres de destino en el que se va a instalar para la instancia de extensión. Este parámetro es necesario si el ámbito de extensión está establecido en "espacio de nombres".

--version

Especifique la versión que se va a instalar para la instancia de extensión si --auto-upgrade-minor-version no está habilitada.

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

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

Elimine una extensión de Kubernetes.

az k8s-extension delete --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--cluster-resource-provider --cluster-rp]
                        [--force]
                        [--no-wait]
                        [--yes]

Ejemplos

Eliminación de una extensión de Kubernetes existente

az k8s-extension delete --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension

Parámetros requeridos

--cluster-name -c

Nombre del clúster de Kubernetes.

--cluster-type -t

Especifique clústeres de Arc o clústeres administrados de AKS o dispositivos de Arc o aprovisionadosClusters.

Propiedad Valor
Valores aceptados: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

Nombre de la instancia de extensión.

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

--cluster-resource-provider --cluster-rp

Nombre del proveedor de recursos de clúster para este clusterType (obligatorio para provisionedClusters).

--force

Especifique si se va a forzar la eliminación de la extensión del clúster.

Propiedad Valor
Valor predeterminado: False
--no-wait

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

Propiedad Valor
Valor predeterminado: False
--yes -y

Omitir las solicitudes de 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 k8s-extension list

Enumerar extensiones de Kubernetes.

Enumere todas las extensiones de Kubernetes en un clúster, incluidas sus propiedades. La salida incluye secretos que debe proteger. Asegúrese de que no incluya estos secretos en el control de código fuente. Compruebe también que no haya secretos presentes en los registros del comando o script. Para obtener más información, vea http://aka.ms/clisecrets.

az k8s-extension list --cluster-name
                      --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                      --resource-group
                      [--cluster-resource-provider --cluster-rp]

Ejemplos

Enumeración de todas las extensiones de Kubernetes en un clúster

az k8s-extension list --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters

Parámetros requeridos

--cluster-name -c

Nombre del clúster de Kubernetes.

--cluster-type -t

Especifique clústeres de Arc o clústeres administrados de AKS o dispositivos de Arc o aprovisionadosClusters.

Propiedad Valor
Valores aceptados: appliances, connectedClusters, managedClusters, provisionedClusters
--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.

--cluster-resource-provider --cluster-rp

Nombre del proveedor de recursos de clúster para este clusterType (obligatorio para provisionedClusters).

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

Mostrar una extensión de Kubernetes.

Mostrar una extensión de Kubernetes, incluidas sus propiedades. La salida incluye secretos que debe proteger. Asegúrese de que no incluya estos secretos en el control de código fuente. Compruebe también que no haya secretos presentes en los registros del comando o script. Para obtener más información, vea http://aka.ms/clisecrets.

az k8s-extension show --cluster-name
                      --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                      --name
                      --resource-group
                      [--cluster-resource-provider --cluster-rp]

Ejemplos

Mostrar detalles de una extensión de Kubernetes

az k8s-extension show --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension

Parámetros requeridos

--cluster-name -c

Nombre del clúster de Kubernetes.

--cluster-type -t

Especifique clústeres de Arc o clústeres administrados de AKS o dispositivos de Arc o aprovisionadosClusters.

Propiedad Valor
Valores aceptados: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

Nombre de la instancia de extensión.

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

--cluster-resource-provider --cluster-rp

Nombre del proveedor de recursos de clúster para este clusterType (obligatorio para provisionedClusters).

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

Actualice las propiedades mutables de una extensión de Kubernetes.

Para actualizar configSettings y ConfigProtectedSettings, consulte la documentación del servicio de extensión de clúster para comprobar que se admite la actualización de estas propiedades antes de actualizar estas propiedades. La salida incluye secretos que debe proteger. Asegúrese de que no incluya estos secretos en el control de código fuente. Compruebe también que no haya secretos presentes en los registros del comando o script. Para obtener más información, vea http://aka.ms/clisecrets.

az k8s-extension update --cluster-name
                        --cluster-type {appliances, connectedClusters, managedClusters, provisionedClusters}
                        --name
                        --resource-group
                        [--auto-upgrade --auto-upgrade-minor-version {false, true}]
                        [--cluster-resource-provider --cluster-rp]
                        [--config --configuration-settings]
                        [--config-file --config-settings-file]
                        [--config-protected --config-protected-settings]
                        [--config-protected-file --config-protected-settings-file]
                        [--config-settings]
                        [--configuration-protected-settings]
                        [--configuration-protected-settings-file]
                        [--configuration-settings-file]
                        [--no-wait]
                        [--release-train]
                        [--version]
                        [--yes]

Ejemplos

Actualización de una extensión de Kubernetes

az k8s-extension update --resource-group my-resource-group --cluster-name mycluster --cluster-type connectedClusters --name myextension --auto-upgrade true/false --version extension-version --release-train stable --configuration-settings settings-key=settings-value --config-protected-settings protected-settings-key=protected-value --config-settings-file=config-settings-file --config-protected-file=protected-settings-file

Parámetros requeridos

--cluster-name -c

Nombre del clúster de Kubernetes.

--cluster-type -t

Especifique clústeres de Arc o clústeres administrados de AKS o dispositivos de Arc o aprovisionadosClusters.

Propiedad Valor
Valores aceptados: appliances, connectedClusters, managedClusters, provisionedClusters
--name -n

Nombre de la instancia de extensión.

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

--auto-upgrade --auto-upgrade-minor-version

Actualice automáticamente la versión secundaria de la instancia de extensión.

Propiedad Valor
Parameter group: Version Arguments
Valores aceptados: false, true
--cluster-resource-provider --cluster-rp

Nombre del proveedor de recursos de clúster para este clusterType (obligatorio para provisionedClusters).

--config --configuration-settings

Opciones de configuración como par clave=valor. Repita el parámetro para cada configuración. No lo use para secretos, ya que este valor se devuelve en respuesta.

Propiedad Valor
Parameter group: Configuration Arguments
--config-file --config-settings-file

Ruta de acceso del archivo JSON para las opciones de configuración.

Propiedad Valor
Parameter group: Configuration Arguments
--config-protected --config-protected-settings

Valores protegidos de configuración como par clave=valor. Repita el parámetro para cada configuración. Solo se devuelve la clave en respuesta, el valor no.

Propiedad Valor
Parameter group: Configuration Arguments
--config-protected-file --config-protected-settings-file

Ruta de acceso del archivo JSON para la configuración protegida por la configuración.

Propiedad Valor
Parameter group: Configuration Arguments
--config-settings
Obsoleto

La opción "--config-settings" está en desuso y se quitará en una versión futura. Use "--configuration-settings" en su lugar.

Opciones de configuración como par clave=valor. Repita el parámetro para cada configuración. No lo use para secretos, ya que este valor se devuelve en respuesta.

Propiedad Valor
Parameter group: Configuration Arguments
--configuration-protected-settings
Obsoleto

La opción "--configuration-protected-settings" está en desuso y se quitará en una versión futura. Use "--config-protected-settings" en su lugar.

Valores protegidos de configuración como par clave=valor. Repita el parámetro para cada configuración. Solo se devuelve la clave en respuesta, el valor no.

Propiedad Valor
Parameter group: Configuration Arguments
--configuration-protected-settings-file
Obsoleto

La opción "--configuration-protected-settings-file" está en desuso y se quitará en una versión futura. Use "--config-protected-file" en su lugar.

Ruta de acceso del archivo JSON para la configuración protegida por la configuración.

Propiedad Valor
Parameter group: Configuration Arguments
--configuration-settings-file
Obsoleto

La opción "--configuration-settings-file" está en desuso y se quitará en una versión futura. Use "--config-settings-file" en su lugar.

Ruta de acceso del archivo JSON para las opciones de configuración.

Propiedad Valor
Parameter group: Configuration Arguments
--no-wait

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

Propiedad Valor
Valor predeterminado: False
--release-train

Especifique el entrenamiento de versión para el tipo de extensión.

Propiedad Valor
Parameter group: Version Arguments
--version

Especifique la versión que se va a instalar para la instancia de extensión si --auto-upgrade-minor-version no está habilitada.

Propiedad Valor
Parameter group: Version Arguments
--yes -y

Omitir las solicitudes de 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