Share via


@azure/arm-sitemanager package

Classes

EdgeClient

Interfaces

EdgeClientOptionalParams

Optional parameters for the client.

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.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

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

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

RestorePollerOptions
Site

Site as ARM Resource

SiteAddressProperties

Site address properties

SiteProperties

Site properties

SiteUpdate

The type used for update operations of the Site.

SiteUpdateProperties

The updatable properties of the Site.

SitesByServiceGroupCreateOrUpdateOptionalParams

Optional parameters.

SitesByServiceGroupDeleteOptionalParams

Optional parameters.

SitesByServiceGroupGetOptionalParams

Optional parameters.

SitesByServiceGroupListByServiceGroupOptionalParams

Optional parameters.

SitesByServiceGroupOperations

Interface representing a SitesByServiceGroup operations.

SitesByServiceGroupUpdateOptionalParams

Optional parameters.

SitesBySubscriptionCreateOrUpdateOptionalParams

Optional parameters.

SitesBySubscriptionDeleteOptionalParams

Optional parameters.

SitesBySubscriptionGetOptionalParams

Optional parameters.

SitesBySubscriptionListOptionalParams

Optional parameters.

SitesBySubscriptionOperations

Interface representing a SitesBySubscription operations.

SitesBySubscriptionUpdateOptionalParams

Optional parameters.

SitesCreateOrUpdateOptionalParams

Optional parameters.

SitesDeleteOptionalParams

Optional parameters.

SitesGetOptionalParams

Optional parameters.

SitesListByResourceGroupOptionalParams

Optional parameters.

SitesOperations

Interface representing a Sites operations.

SitesUpdateOptionalParams

Optional parameters.

SystemData

Metadata pertaining to creation and last modification of the resource.

Type Aliases

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
<xref: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.

ResourceProvisioningState

The provisioning state of a resource type.
KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.

Enums

KnownCreatedByType

The kind of entity that created the resource.

KnownResourceProvisioningState

The provisioning state of a resource type.

KnownVersions

Supported API Versions

Functions

restorePoller<TResponse, TResult>(EdgeClient, 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 Details

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

Parameters

client
EdgeClient
serializedState

string

sourceOperation

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

Returns

PollerLike<OperationState<TResult>, TResult>