@azure/arm-extendedlocation package

Interfaces

CustomLocation

Custom Locations definition.

CustomLocationFindTargetResourceGroupProperties

The Find Target Resource Group operation request.

CustomLocationFindTargetResourceGroupResult

The Find Target Resource Group operation response.

CustomLocationOperation

Custom Locations operation.

CustomLocationOperationValueDisplay

Describes the properties of a Custom Locations Operation Value Display.

CustomLocationProperties

Properties for a custom location.

CustomLocationPropertiesAuthentication

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

CustomLocationsCreateOrUpdateOptionalParams

Optional parameters.

CustomLocationsDeleteOptionalParams

Optional parameters.

CustomLocationsFindTargetResourceGroupOptionalParams

Optional parameters.

CustomLocationsGetOptionalParams

Optional parameters.

CustomLocationsListByResourceGroupOptionalParams

Optional parameters.

CustomLocationsListBySubscriptionOptionalParams

Optional parameters.

CustomLocationsListEnabledResourceTypesOptionalParams

Optional parameters.

CustomLocationsListOperationsOptionalParams

Optional parameters.

CustomLocationsManagementClientOptionalParams

Optional parameters for the client.

CustomLocationsOperations

Interface representing a CustomLocations operations.

CustomLocationsUpdateOptionalParams

Optional parameters.

EnabledResourceType

EnabledResourceType definition.

EnabledResourceTypeProperties

Properties for EnabledResourceType of a custom location.

EnabledResourceTypePropertiesTypesMetadataItem

Metadata of the Resource Type.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Identity

Identity for the resource.

MatchExpressionsProperties

Resource Sync Rules matchExpression property definition.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PatchableCustomLocations

The Custom Locations patchable resource definition.

PatchableResourceSyncRule

The Resource Sync Rules patchable resource definition.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceSyncRule

Resource Sync Rules definition.

ResourceSyncRuleProperties

Properties for a resource sync rule. For an unmapped custom resource, its labels will be used to find out matching resource sync rules using the selector property of the resource sync rule. If this resource sync rule has highest priority among all matching rules, then the unmapped custom resource will be projected to the target resource group associated with this resource sync rule.

ResourceSyncRulePropertiesSelector

A label selector is composed of two parts, matchLabels and matchExpressions. The first part, matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is 'key', the operator is 'In', and the values array contains only 'value'. The second part, matchExpressions is a list of resource selector requirements. Valid operators include In, NotIn, Exists, and DoesNotExist. The values set must be non-empty in the case of In and NotIn. The values set must be empty in the case of Exists and DoesNotExist. All of the requirements, from both matchLabels and matchExpressions must all be satisfied in order to match.

ResourceSyncRulesCreateOrUpdateOptionalParams

Optional parameters.

ResourceSyncRulesDeleteOptionalParams

Optional parameters.

ResourceSyncRulesGetOptionalParams

Optional parameters.

ResourceSyncRulesListByCustomLocationIDOptionalParams

Optional parameters.

ResourceSyncRulesOperations

Interface representing a ResourceSyncRules operations.

ResourceSyncRulesUpdateOptionalParams

Optional parameters.

RestorePollerOptions
SimplePollerLike

A simple poller that can be used to poll a long running operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

HostType

Type of host the Custom Locations is referencing (Kubernetes, etc...).
KnownHostType can be used interchangeably with HostType, this enum contains the known values that the service supports.

Known values supported by the service

Kubernetes: Kubernetes

ResourceIdentityType

The identity type.
KnownResourceIdentityType can be used interchangeably with ResourceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned: SystemAssigned
None: None

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownCreatedByType

The kind of entity that created the resource.

KnownHostType

Type of host the Custom Locations is referencing (Kubernetes, etc...).

KnownResourceIdentityType

The identity type.

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

restorePoller<TResponse, TResult>(CustomLocationsManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(CustomLocationsManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: CustomLocationsManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type