@azure/arm-servicegroups package

Interfaces

CreateOrUpdateServiceGroupOptionalParams

Optional parameters.

DeleteServiceGroupOptionalParams

Optional parameters.

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.

ParentServiceGroupProperties

The details of the parent serviceGroup.

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
ServiceGroup

The serviceGroup details.

ServiceGroupCollectionResponse

Response holding an array of service groups and a nextLink that supports pagination

ServiceGroupProperties

ServiceGroup creation request body parameters.

ServiceGroupsGetOptionalParams

Optional parameters.

ServiceGroupsListAncestorsOptionalParams

Optional parameters.

ServiceGroupsManagementClientOptionalParams

Optional parameters for the client.

ServiceGroupsOperations

Interface representing a ServiceGroups operations.

SystemData

Metadata pertaining to creation and last modification of the resource.

UpdateServiceGroupOptionalParams

Optional parameters.

Type Aliases

AzureSupportedClouds

The supported values for cloud setting as a string literal type

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.

ProvisioningState

The provisioning state of the serviceGroup. For example, Running
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

NotStarted: NotStarted
Running: Running
Succeeded: Succeeded
Failed: Failed
Canceled: Canceled

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownCreatedByType

The kind of entity that created the resource.

KnownProvisioningState

The provisioning state of the serviceGroup. For example, Running

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(ServiceGroupsManagementClient, 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>(ServiceGroupsManagementClient, 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: ServiceGroupsManagementClient, 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>