CustomLocation interface

Package:

@azure/arm-extendedlocation

Custom Locations definition.

Extends

TrackedResource

Properties

authentication	This is optional input that contains the authentication that should be used to generate the namespace.
clusterExtensionIds	Contains the reference to the add-on that contains charts to deploy CRDs and operators.
displayName	Display name for the Custom Locations location.
hostResourceId	Connected Cluster or AKS Cluster. The Custom Locations RP will perform a checkAccess API for listAdminCredentials permissions.
hostType	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.
provisioningState	Provisioning State for the Custom Location.
systemData	Metadata pertaining to creation and last modification of the resource NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

authentication

This is optional input that contains the authentication that should be used to generate the namespace.

authentication?: CustomLocationPropertiesAuthentication

Property Value

CustomLocationPropertiesAuthentication

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

Identity for the resource.

identity?: Identity

Property Value

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

systemData

Metadata pertaining to creation and last modification of the resource NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

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

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type