az sf managed-node-type vm-extension

Managed vm extension on a node type on managed clusters.

Commands

Name	Description	Type	Status
az sf managed-node-type vm-extension add	Add an extension to the node type.	Core	GA
az sf managed-node-type vm-extension delete	Delete an extension from the node type.	Core	GA

az sf managed-node-type vm-extension add

Add an extension to the node type.

az sf managed-node-type vm-extension add --cluster-name
                                         --extension-name
                                         --extension-type
                                         --name --node-type-name
                                         --publisher
                                         --resource-group
                                         --type-handler-version
                                         [--acquire-policy-token]
                                         [--auto-upgrade --auto-upgrade-minor-version {false, true}]
                                         [--change-reference]
                                         [--force-update-tag]
                                         [--protected-setting]
                                         [--provision-after --provision-after-extension]
                                         [--setting]

Examples

Add bg extension.

az sf managed-node-type vm-extension add -g testRG -c testCluster -n snt --extension-name csetest --publisher Microsoft.Compute --extension-type BGInfo --type-handler-version 2.1 --auto-upgrade-minor-version

Required Parameters

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--extension-name

Extension name.

--extension-type

Specifies the type of the extension; an example is "CustomScriptExtension".

--name --node-type-name -n

Node type name.

--publisher

The name of the extension handler publisher.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

--type-handler-version

Specifies the version of the script handler.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

Property	Value
Default value:	True
Accepted values:	false, true

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--force-update-tag

If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.

--protected-setting

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

--provision-after --provision-after-extension

Collection of extension names after which this extension needs to be provisioned.

--setting

Json formatted public settings for the extension.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az sf managed-node-type vm-extension delete

Delete an extension from the node type.

az sf managed-node-type vm-extension delete --cluster-name
                                            --extension-name
                                            --name --node-type-name
                                            --resource-group
                                            [--acquire-policy-token]
                                            [--change-reference]

Examples

Delete extension by name.

az sf managed-node-type vm-extension delete -g testRG -c testCluster -n snt --extension-name csetest

Required Parameters

--cluster-name -c

Specify the name of the cluster, if not given it will be same as resource group name.

--extension-name

Extension name.

--name --node-type-name -n

Node type name.

--resource-group -g

Specify the resource group name. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False