Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The customLocations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ExtendedLocation/customLocations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ExtendedLocation/customLocations@2021-08-31-preview' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
authentication: {
type: 'string'
value: 'string'
}
clusterExtensionIds: [
'string'
]
displayName: 'string'
hostResourceId: 'string'
hostType: 'string'
namespace: 'string'
provisioningState: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
CustomLocationProperties
| Name | Description | Value |
|---|---|---|
| authentication | This is optional input that contains the authentication that should be used to generate the namespace. | CustomLocationPropertiesAuthentication |
| clusterExtensionIds | Contains the reference to the add-on that contains charts to deploy CRDs and operators. | string[] |
| displayName | Display name for the Custom Locations location. | string |
| hostResourceId | Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. | string |
| hostType | Type of host the Custom Locations is referencing (Kubernetes, etc...). | 'Kubernetes' |
| namespace | Kubernetes namespace that will be created on the specified cluster. | string |
| provisioningState | Provisioning State for the Custom Location. | string |
CustomLocationPropertiesAuthentication
| Name | Description | Value |
|---|---|---|
| type | The type of the Custom Locations authentication | string |
| value | The kubeconfig value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' |
Microsoft.ExtendedLocation/customLocations
| Name | Description | Value |
|---|---|---|
| identity | Identity for the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required) |
| properties | The set of properties specific to a Custom Location | CustomLocationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The customLocations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ExtendedLocation/customLocations resource, add the following JSON to your template.
{
"type": "Microsoft.ExtendedLocation/customLocations",
"apiVersion": "2021-08-31-preview",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"authentication": {
"type": "string",
"value": "string"
},
"clusterExtensionIds": [ "string" ],
"displayName": "string",
"hostResourceId": "string",
"hostType": "string",
"namespace": "string",
"provisioningState": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
CustomLocationProperties
| Name | Description | Value |
|---|---|---|
| authentication | This is optional input that contains the authentication that should be used to generate the namespace. | CustomLocationPropertiesAuthentication |
| clusterExtensionIds | Contains the reference to the add-on that contains charts to deploy CRDs and operators. | string[] |
| displayName | Display name for the Custom Locations location. | string |
| hostResourceId | Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. | string |
| hostType | Type of host the Custom Locations is referencing (Kubernetes, etc...). | 'Kubernetes' |
| namespace | Kubernetes namespace that will be created on the specified cluster. | string |
| provisioningState | Provisioning State for the Custom Location. | string |
CustomLocationPropertiesAuthentication
| Name | Description | Value |
|---|---|---|
| type | The type of the Custom Locations authentication | string |
| value | The kubeconfig value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' |
Microsoft.ExtendedLocation/customLocations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-08-31-preview' |
| identity | Identity for the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required) |
| properties | The set of properties specific to a Custom Location | CustomLocationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.ExtendedLocation/customLocations' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The customLocations resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.ExtendedLocation/customLocations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ExtendedLocation/customLocations@2021-08-31-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
authentication = {
type = "string"
value = "string"
}
clusterExtensionIds = [
"string"
]
displayName = "string"
hostResourceId = "string"
hostType = "string"
namespace = "string"
provisioningState = "string"
}
}
}
Property Values
CustomLocationProperties
| Name | Description | Value |
|---|---|---|
| authentication | This is optional input that contains the authentication that should be used to generate the namespace. | CustomLocationPropertiesAuthentication |
| clusterExtensionIds | Contains the reference to the add-on that contains charts to deploy CRDs and operators. | string[] |
| displayName | Display name for the Custom Locations location. | string |
| hostResourceId | Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. | string |
| hostType | Type of host the Custom Locations is referencing (Kubernetes, etc...). | 'Kubernetes' |
| namespace | Kubernetes namespace that will be created on the specified cluster. | string |
| provisioningState | Provisioning State for the Custom Location. | string |
CustomLocationPropertiesAuthentication
| Name | Description | Value |
|---|---|---|
| type | The type of the Custom Locations authentication | string |
| value | The kubeconfig value. | string Constraints: Sensitive value. Pass in as a secure parameter. |
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'SystemAssigned' |
Microsoft.ExtendedLocation/customLocations
| Name | Description | Value |
|---|---|---|
| identity | Identity for the resource. | Identity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ (required) |
| properties | The set of properties specific to a Custom Location | CustomLocationProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.ExtendedLocation/customLocations@2021-08-31-preview" |
TrackedResourceTags
| Name | Description | Value |
|---|