@azure/arm-relationships package

Interfaces

DependencyOfRelationship

Defines a dependencyOf relationship resource.

DependencyOfRelationshipCreateOrUpdate

DependencyOf relationship resource for create or update.

DependencyOfRelationshipProperties

dependencyOf relationship properties.

DependencyOfRelationshipPropertiesCreateOrUpdate

model interface DependencyOfRelationshipPropertiesCreateOrUpdate

DependencyOfRelationshipsCreateOrUpdateOptionalParams

Optional parameters.

DependencyOfRelationshipsDeleteOptionalParams

Optional parameters.

DependencyOfRelationshipsGetOptionalParams

Optional parameters.

DependencyOfRelationshipsOperations

Interface representing a DependencyOfRelationships operations.

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.

ExtensionResource

The base extension resource.

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.

RelationshipMetadata

Provides information about the relationship properties.

RelationshipOriginInformation

Provides information about the origin of a relationship.

RelationshipsClientOptionalParams

Optional parameters for the client.

Resource

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

RestorePollerOptions
ServiceGroupMemberRelationship

Defines a ServiceGroupMember relationship resource.

ServiceGroupMemberRelationshipCreateOrUpdate

ServiceGroupMember relationship resource for create or update.

ServiceGroupMemberRelationshipProperties

ServiceGroupMember relationship properties.

ServiceGroupMemberRelationshipPropertiesCreateOrUpdate

model interface ServiceGroupMemberRelationshipPropertiesCreateOrUpdate

ServiceGroupMemberRelationshipsCreateOrUpdateOptionalParams

Optional parameters.

ServiceGroupMemberRelationshipsDeleteOptionalParams

Optional parameters.

ServiceGroupMemberRelationshipsGetOptionalParams

Optional parameters.

ServiceGroupMemberRelationshipsOperations

Interface representing a ServiceGroupMemberRelationships operations.

SystemData

Metadata pertaining to creation and last modification of the resource.

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.

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.

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.

ProvisioningState

The provisioning state of the resource.
KnownProvisioningState can be used interchangeably with ProvisioningState, 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.
Provisioning: The resource is being provisioned.
Updating: The resource is being updated.
Deleting: The resource is being deleted.
Accepted: The resource provisioning request has been accepted.

RelationshipOrigins

The possible origins of a relationship.
KnownRelationshipOrigins can be used interchangeably with RelationshipOrigins, this enum contains the known values that the service supports.

Known values supported by the service

ServiceExplicitlyCreated: The relationship was explicitly created by a system.
SystemDiscoveredByRule: The relationship was discovered by a system-created rule.
UserExplicitlyCreated: The relationship was explicitly created by a user.
UserDiscoveredByRule: The relationship was discovered by a user-created rule.

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.

KnownCreatedByType

The kind of entity that created the resource.

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownProvisioningState

The provisioning state of the resource.

KnownRelationshipOrigins

The possible origins of a relationship.

KnownVersions

Relationships RP API Versions

Functions

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