@azure/arm-resources package

Classes

ResourceManagementClient

Interfaces

Alias	The alias type.
AliasPath	The type of the paths for alias.
AliasPathMetadata	model interface AliasPathMetadata
AliasPattern	The type of the pattern for an alias path.
ApiProfile	model interface ApiProfile
CloudError	An error response for a resource management request.
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. (This also follows the OData error response format.)
ExportTemplateRequest	Export resource group template request parameters.
ExtendedLocation	Resource extended location.
ExtensionResource	The base extension resource.
GenericResource	Resource information.
GenericResourceExpanded	Resource information.
Identity	Identity for the resource.
IdentityUserAssignedIdentitiesValue	model interface IdentityUserAssignedIdentitiesValue
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Permission	Role definition permissions.
Plan	Plan for the resource.
Provider	Resource provider information.
ProviderConsentDefinition	The provider consent.
ProviderExtendedLocation	The provider extended location.
ProviderPermission	The provider permission
ProviderPermissionListResult	List of provider permissions.
ProviderRegistrationRequest	The provider registration definition.
ProviderResourceType	Resource type managed by the resource provider.
ProviderResourceTypeListResult	List of resource types of a resource provider.
ProviderResourceTypesListOptionalParams	Optional parameters.
ProviderResourceTypesOperations	Interface representing a ProviderResourceTypes operations.
ProvidersGetAtTenantScopeOptionalParams	Optional parameters.
ProvidersGetOptionalParams	Optional parameters.
ProvidersListAtTenantScopeOptionalParams	Optional parameters.
ProvidersListOptionalParams	Optional parameters.
ProvidersOperations	Interface representing a Providers operations.
ProvidersProviderPermissionsOptionalParams	Optional parameters.
ProvidersRegisterAtManagementGroupScopeOptionalParams	Optional parameters.
ProvidersRegisterOptionalParams	Optional parameters.
ProvidersUnregisterOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceGroup	Resource group information.
ResourceGroupExportResult	Resource group export result.
ResourceGroupPatchable	Resource group information.
ResourceGroupProperties	The resource group properties.
ResourceGroupsCheckExistenceOptionalParams	Optional parameters.
ResourceGroupsCreateOrUpdateOptionalParams	Optional parameters.
ResourceGroupsDeleteOptionalParams	Optional parameters.
ResourceGroupsExportTemplateOptionalParams	Optional parameters.
ResourceGroupsGetOptionalParams	Optional parameters.
ResourceGroupsListOptionalParams	Optional parameters.
ResourceGroupsOperations	Interface representing a ResourceGroups operations.
ResourceGroupsUpdateOptionalParams	Optional parameters.
ResourceManagementClientOptionalParams	Optional parameters for the client.
ResourcesCheckExistenceByIdOptionalParams	Optional parameters.
ResourcesCheckExistenceOptionalParams	Optional parameters.
ResourcesCreateOrUpdateByIdOptionalParams	Optional parameters.
ResourcesCreateOrUpdateOptionalParams	Optional parameters.
ResourcesDeleteByIdOptionalParams	Optional parameters.
ResourcesDeleteOptionalParams	Optional parameters.
ResourcesGetByIdOptionalParams	Optional parameters.
ResourcesGetOptionalParams	Optional parameters.
ResourcesListByResourceGroupOptionalParams	Optional parameters.
ResourcesListOptionalParams	Optional parameters.
ResourcesMoveInfo	Parameters of move resources.
ResourcesMoveResourcesOptionalParams	Optional parameters.
ResourcesOperations	Interface representing a Resources operations.
ResourcesUpdateByIdOptionalParams	Optional parameters.
ResourcesUpdateOptionalParams	Optional parameters.
ResourcesValidateMoveResourcesOptionalParams	Optional parameters.
RestorePollerOptions
RoleDefinition	Role definition properties.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	SKU for the resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
TagCount	Tag count.
TagDetails	Tag details.
TagValue	Tag information.
Tags	A dictionary of name and value pairs.
TagsOperationsCreateOrUpdateAtScopeOptionalParams	Optional parameters.
TagsOperationsCreateOrUpdateOptionalParams	Optional parameters.
TagsOperationsCreateOrUpdateValueOptionalParams	Optional parameters.
TagsOperationsDeleteAtScopeOptionalParams	Optional parameters.
TagsOperationsDeleteOptionalParams	Optional parameters.
TagsOperationsDeleteValueOptionalParams	Optional parameters.
TagsOperationsGetAtScopeOptionalParams	Optional parameters.
TagsOperationsListOptionalParams	Optional parameters.
TagsOperationsOperations	Interface representing a TagsOperations operations.
TagsOperationsUpdateAtScopeOptionalParams	Optional parameters.
TagsPatchResource	Wrapper resource for tags patch API request only.
TagsResource	Wrapper resource for tags API requests and responses.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
ZoneMapping	model interface ZoneMapping

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AliasPathAttributes	The attributes of the token that the alias path is referring to. KnownAliasPathAttributes can be used interchangeably with AliasPathAttributes, this enum contains the known values that the service supports. Known values supported by the service None: The token that the alias path is referring to has no attributes. Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect.
AliasPathTokenType	The type of the token that the alias path is referring to. KnownAliasPathTokenType can be used interchangeably with AliasPathTokenType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The token type is not specified. Any: The token type can be anything. String: The token type is string. Object: The token type is object. Array: The token type is array. Integer: The token type is integer. Number: The token type is number. Boolean: The token type is boolean.
AliasPatternType	The type of alias pattern
AliasType	The type of the alias.
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.
ExportTemplateOutputFormat	The output format for the exported resources. KnownExportTemplateOutputFormat can be used interchangeably with ExportTemplateOutputFormat, this enum contains the known values that the service supports. Known values supported by the service Json: Json Bicep: Bicep
ExtendedLocationType	The extended location type. KnownExtendedLocationType can be used interchangeably with ExtendedLocationType, this enum contains the known values that the service supports. Known values supported by the service EdgeZone: EdgeZone
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProviderAuthorizationConsentState	The provider authorization consent state. KnownProviderAuthorizationConsentState can be used interchangeably with ProviderAuthorizationConsentState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: NotSpecified Required: Required NotRequired: NotRequired Consented: Consented
ResourceGroupsCheckExistenceResponse
ResourceIdentityType	The identity type.
ResourcesCheckExistenceByIdResponse
ResourcesCheckExistenceResponse
TagsPatchOperation	The operation type for the patch API. KnownTagsPatchOperation can be used interchangeably with TagsPatchOperation, this enum contains the known values that the service supports. Known values supported by the service Replace: The 'replace' option replaces the entire set of existing tags with a new set. Merge: The 'merge' option allows adding tags with new names and updating the values of tags with existing names. Delete: The 'delete' option allows selectively deleting tags based on given names or name/value pairs.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAliasPathAttributes	The attributes of the token that the alias path is referring to.
KnownAliasPathTokenType	The type of the token that the alias path is referring to.
KnownCreatedByType	The kind of entity that created the resource.
KnownExportTemplateOutputFormat	The output format for the exported resources.
KnownExtendedLocationType	The extended location type.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProviderAuthorizationConsentState	The provider authorization consent state.
KnownTagsPatchOperation	The operation type for the patch API.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ResourceManagementClient, 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>(ResourceManagementClient, 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: ResourceManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ResourceManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor