az k8s-extension

  • Referencia

Nota:

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

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.

 Extensión GA
az k8s-extension delete

Elimine una extensión de Kubernetes.

 Extensión GA
az k8s-extension extension-types

Comandos para detectar tipos de extensión de Kubernetes.

 Extensión Vista previa
az k8s-extension extension-types list

Enumere los tipos de extensión de clúster disponibles para un clúster existente.

 Extensión Versión preliminar y en desuso
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.

 Extensión Vista previa
az k8s-extension extension-types list-by-location

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

 Extensión Vista previa
az k8s-extension extension-types list-versions

Enumere las versiones disponibles para un tipo de extensión de clúster para un clúster determinado.

 Extensión Versión preliminar y en desuso
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.

 Extensión Vista previa
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.

 Extensión Vista previa
az k8s-extension extension-types show

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

 Extensión Versión preliminar y en desuso
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.

 Extensión Vista previa
az k8s-extension extension-types show-by-location

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

 Extensión Vista previa
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.

 Extensión Vista previa
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.

 Extensión Vista previa
az k8s-extension list

Enumerar extensiones de Kubernetes.

 Extensión GA
az k8s-extension show

Mostrar una extensión de Kubernetes.

 Extensión GA
az k8s-extension update

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

 Extensión 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 {false, true}]
                        [--cluster-resource-provider]
                        [--config]
                        [--config-file]
                        [--config-protected]
                        [--config-protected-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.

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

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

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

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

La configuración 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.

--config-file --config-settings-file

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

--config-protected --config-protected-settings

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

--config-protected-file --config-protected-settings-file

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

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

La configuración 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.

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

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

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

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

--no-wait

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

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.

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

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

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

--scope

Especifique el ámbito de extensión.

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.

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

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

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

valor predeterminado: False
--no-wait

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

valor predeterminado: False
--yes -y

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

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.

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

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

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.

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

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

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

Para actualizar a Config Configuración y ConfigProtected Configuración, 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 {false, true}]
                        [--cluster-resource-provider]
                        [--config]
                        [--config-file]
                        [--config-protected]
                        [--config-protected-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.

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

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

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

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

La configuración 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.

--config-file --config-settings-file

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

--config-protected --config-protected-settings

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

--config-protected-file --config-protected-settings-file

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

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

La configuración 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.

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

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

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

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

--no-wait

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

valor predeterminado: False
--release-train

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

--version

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

--yes -y

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