Share via

az customlocation

  • Reference

Note

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

Commands to Create, Get, List and Delete CustomLocations.

Commands

Name Description Type Status
az customlocation create

Create a Custom Location.

 Extension GA
az customlocation delete

Delete a Customlocation.

 Extension GA
az customlocation list

Command to list CustomLocations.

 Extension GA
az customlocation list-enabled-resource-types

Get details of Enabled Resource Types for a CustomLocation.

 Extension GA
az customlocation patch

Patch a Custom Location.

 Extension GA
az customlocation show

Get details of a Customlocation.

 Extension GA
az customlocation update

Update a Custom Location.

 Extension GA

az customlocation create

Create a Custom Location.

az customlocation create --cluster-extension-ids
                         --host-resource-id
                         --name
                         --namespace
                         --resource-group
                         [--assign-identity]
                         [--kubeconfig]
                         [--location]
                         [--tags]

Required Parameters

--cluster-extension-ids -c

Space-seperated list of the cluster extension ids - input full id in the format /subscription/.../resourceGroups/.../Microsoft.Kubernetes/connectedClusters/.../providers/Microsoft.KubernetesConfiguration/extensions/...

--host-resource-id

Host resource ID of the connected cluster.

--name -n

Name of the Customlocation.

--namespace

Namespace for Custom Location. For namespace-scoped extensions, this should match namespace associated with the cluster extension operator.

--resource-group -g

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

Optional Parameters

--assign-identity

Create CustomLocation resource with "SystemAssigned" or "None" type identity.

--kubeconfig -k

Admin Kubeconfig of Cluster. Needs to passed in as a file if the cluster is a non-AAD enabled Cluster.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az customlocation delete

Delete a Customlocation.

az customlocation delete --name
                         --resource-group
                         [--yes]

Required Parameters

--name -n

Name of the Customlocation.

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az customlocation list

Command to list CustomLocations.

az customlocation list [--resource-group]

Optional Parameters

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az customlocation list-enabled-resource-types

Get details of Enabled Resource Types for a CustomLocation.

az customlocation list-enabled-resource-types --name
                                              --resource-group

Required Parameters

--name -n

Name of the Customlocation.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az customlocation patch

Patch a Custom Location.

az customlocation patch --name
                        --resource-group
                        [--assign-identity]
                        [--cluster-extension-ids]
                        [--display-name]
                        [--host-resource-id]
                        [--location]
                        [--namespace]
                        [--tags]

Required Parameters

--name -n

Name of the Customlocation.

--resource-group -g

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

Optional Parameters

--assign-identity

Create CustomLocation resource with "SystemAssigned" or "None" type identity.

--cluster-extension-ids -c

Space-seperated list of the cluster extension ids - input full id in the format /subscription/.../resourceGroups/.../Microsoft.Kubernetes/connectedClusters/.../providers/Microsoft.KubernetesConfiguration/extensions/...

--display-name -d

Display Name of Custom Location.

--host-resource-id

Host resource ID of the connected cluster.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--namespace

Namespace for Custom Location. For namespace-scoped extensions, this should match namespace associated with the cluster extension operator.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az customlocation show

Get details of a Customlocation.

az customlocation show --name
                       --resource-group

Required Parameters

--name -n

Name of the Customlocation.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az customlocation update

Update a Custom Location.

az customlocation update --cluster-extension-ids
                         --host-resource-id
                         --name
                         --namespace
                         --resource-group
                         [--assign-identity]
                         [--location]
                         [--tags]

Required Parameters

--cluster-extension-ids -c

Space-seperated list of the cluster extension ids - input full id in the format /subscription/.../resourceGroups/.../Microsoft.Kubernetes/connectedClusters/.../providers/Microsoft.KubernetesConfiguration/extensions/...

--host-resource-id

Host resource ID of the connected cluster.

--name -n

Name of the Customlocation.

--namespace

Namespace for Custom Location. For namespace-scoped extensions, this should match namespace associated with the cluster extension operator.

--resource-group -g

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

Optional Parameters

--assign-identity

Create CustomLocation resource with "SystemAssigned" or "None" type identity.

--location -l

Location of Custom Location resource.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.