@azure/arm-purview package

Classes

PurviewManagementClient

Interfaces

AccessKeys

The Account access keys.

Account

Account resource

AccountEndpoints

The account endpoints

AccountList

Paged list of account resources

AccountProperties

The account properties

AccountPropertiesEndpoints

The URIs that are the public endpoints of the account.

AccountPropertiesManagedResources

Gets the resource identifiers of the managed resources.

AccountSku

Gets or sets the Sku.

AccountSkuAutoGenerated

The Sku

AccountUpdateParameters

The account update properties.

Accounts

Interface representing a Accounts.

AccountsAddRootCollectionAdminOptionalParams

Optional parameters.

AccountsCheckNameAvailabilityOptionalParams

Optional parameters.

AccountsCreateOrUpdateOptionalParams

Optional parameters.

AccountsDeleteOptionalParams

Optional parameters.

AccountsGetOptionalParams

Optional parameters.

AccountsListByResourceGroupNextOptionalParams

Optional parameters.

AccountsListByResourceGroupOptionalParams

Optional parameters.

AccountsListBySubscriptionNextOptionalParams

Optional parameters.

AccountsListBySubscriptionOptionalParams

Optional parameters.

AccountsListKeysOptionalParams

Optional parameters.

AccountsUpdateOptionalParams

Optional parameters.

CheckNameAvailabilityRequest

The request payload for CheckNameAvailability API

CheckNameAvailabilityResult

The response payload for CheckNameAvailability API

CloudConnectors

External Cloud Service connectors

CollectionAdminUpdate

Collection administrator update.

DefaultAccountPayload

Payload to get and set the default account in the given scope

DefaultAccounts

Interface representing a DefaultAccounts.

DefaultAccountsGetOptionalParams

Optional parameters.

DefaultAccountsRemoveOptionalParams

Optional parameters.

DefaultAccountsSetModelOptionalParams

Optional parameters.

DimensionProperties

properties for dimension

ErrorModel

Default error model

ErrorResponseModel

Default error response model

ErrorResponseModelError

Gets or sets the error.

Identity

The Managed Identity of the resource

ManagedResources

The managed resources in customer subscription.

Operation

Operation resource

OperationDisplay

The response model for get operation properties

OperationList

Paged list of operation resources

OperationMetaLogSpecification

log specifications for operation api

OperationMetaMetricSpecification

metric specifications for the operation

OperationMetaServiceSpecification

The operation meta service specification

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PrivateEndpoint

A private endpoint class.

PrivateEndpointConnection

A private endpoint connection class.

PrivateEndpointConnectionList

Paged list of private endpoint connections

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByAccountNextOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByAccountOptionalParams

Optional parameters.

PrivateLinkResource

A privately linkable resource.

PrivateLinkResourceList

Paged list of private link resources

PrivateLinkResourceProperties

A privately linkable resource properties.

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesGetByGroupIdOptionalParams

Optional parameters.

PrivateLinkResourcesListByAccountNextOptionalParams

Optional parameters.

PrivateLinkResourcesListByAccountOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

The private link service connection state.

ProxyResource

Proxy Azure Resource

PurviewManagementClientOptionalParams

Optional parameters.

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

Azure ARM Tracked Resource

TrackedResourceSystemData

Metadata pertaining to creation and last modification of the resource.

UserAssignedIdentity

Uses client ID and Principal ID

Type Aliases

AccountsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

AccountsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AccountsGetResponse

Contains response data for the get operation.

AccountsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

AccountsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

AccountsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

AccountsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

AccountsListKeysResponse

Contains response data for the listKeys operation.

AccountsUpdateResponse

Contains response data for the update operation.

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

DefaultAccountsGetResponse

Contains response data for the get operation.

DefaultAccountsSetModelResponse

Contains response data for the set operation.

LastModifiedByType

Defines values for LastModifiedByType.
KnownLastModifiedByType can be used interchangeably with LastModifiedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Name

Defines values for Name.
KnownName can be used interchangeably with Name, this enum contains the known values that the service supports.

Known values supported by the service

Standard

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

PrivateEndpointConnectionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListByAccountNextResponse

Contains response data for the listByAccountNext operation.

PrivateEndpointConnectionsListByAccountResponse

Contains response data for the listByAccount operation.

PrivateLinkResourcesGetByGroupIdResponse

Contains response data for the getByGroupId operation.

PrivateLinkResourcesListByAccountNextResponse

Contains response data for the listByAccountNext operation.

PrivateLinkResourcesListByAccountResponse

Contains response data for the listByAccount operation.

ProvisioningState

Defines values for ProvisioningState.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Creating
Moving
Deleting
SoftDeleting
SoftDeleted
Failed
Succeeded
Canceled

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

NotSpecified
Enabled
Disabled

Reason

Defines values for Reason.
KnownReason can be used interchangeably with Reason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

ScopeType

Defines values for ScopeType.
KnownScopeType can be used interchangeably with ScopeType, this enum contains the known values that the service supports.

Known values supported by the service

Tenant
Subscription

Status

Defines values for Status.
KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Pending
Approved
Rejected
Disconnected

Type

Defines values for Type.
KnownType can be used interchangeably with Type, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned

Enums

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownLastModifiedByType

Known values of LastModifiedByType that the service accepts.

KnownName

Known values of Name that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownReason

Known values of Reason that the service accepts.

KnownScopeType

Known values of ScopeType that the service accepts.

KnownStatus

Known values of Status that the service accepts.

KnownType

Known values of Type that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

The continuation token that can be passed into byPage().