Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az customlocation

Note

This reference is part of the customlocation extension for the Azure CLI (version 2.70.0 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
 [--acquire-policy-token]
 [--assign-identity]
 [--change-reference]
 [--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

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
--assign-identity

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

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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.

az customlocation delete

Delete a Customlocation.

az customlocation delete --name
 --resource-group
 [--acquire-policy-token]
 [--change-reference]
 [--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

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
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False

az customlocation list

Command to list CustomLocations.

az customlocation list [--resource-group]

Optional Parameters

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

--resource-group -g

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

az customlocation list-enabled-resource-types

Get details of Enabled Resource Types for a CustomLocation.

az customlocation list-enabled-resource-types --name
 --resource-group
 [--acquire-policy-token]
 [--change-reference]

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

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

az customlocation patch

Patch a Custom Location.

az customlocation patch --name
 --resource-group
 [--acquire-policy-token]
 [--assign-identity]
 [--change-reference]
 [--cluster-extension-ids]
 [--display-name]
 [--host-resource-id]
 [--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

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
--assign-identity

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

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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.

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

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

az customlocation update

Update a Custom Location.

az customlocation update --cluster-extension-ids
 --host-resource-id
 --name
 --namespace
 --resource-group
 [--acquire-policy-token]
 [--assign-identity]
 [--change-reference]
 [--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

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
--assign-identity

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

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--location -l

Location of Custom Location resource.

--tags

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

Feedback

Was this page helpful?