CustomLocation interface
Custom Locations definition.
- Extends
Properties
| authentication | This is optional input that contains the authentication that should be used to generate the namespace. |
| cluster |
Contains the reference to the add-on that contains charts to deploy CRDs and operators. |
| display |
Display name for the Custom Locations location. |
| host |
Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions. |
| host |
Type of host the Custom Locations is referencing (Kubernetes, etc...). |
| identity | Identity for the resource. |
| namespace | Kubernetes namespace that will be created on the specified cluster. |
| provisioning |
Provisioning State for the Custom Location. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | The geo-location where the resource lives |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
authentication
This is optional input that contains the authentication that should be used to generate the namespace.
authentication?: CustomLocationPropertiesAuthentication
Property Value
clusterExtensionIds
Contains the reference to the add-on that contains charts to deploy CRDs and operators.
clusterExtensionIds?: string[]
Property Value
string[]
displayName
Display name for the Custom Locations location.
displayName?: string
Property Value
string
hostResourceId
Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.
hostResourceId?: string
Property Value
string
hostType
Type of host the Custom Locations is referencing (Kubernetes, etc...).
hostType?: string
Property Value
string
identity
namespace
Kubernetes namespace that will be created on the specified cluster.
namespace?: string
Property Value
string
provisioningState
Provisioning State for the Custom Location.
provisioningState?: string
Property Value
string
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: string
Property Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: string
Property Value
string
Inherited From TrackedResource.location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemData
Property Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: Record<string, string>
Property Value
Record<string, string>
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: string
Property Value
string
Inherited From TrackedResource.type