@azure/arm-purview package

Classes

PurviewManagementClient

Interfaces

AccessKeys	The Purview Account access keys.
Account	Account resource
AccountEndpoints	The account endpoints
AccountMergeInfo	The public Account Merge Info model.
AccountProperties	The account properties
AccountPropertiesAccountStatus	Gets or sets the status of the account.
AccountPropertiesEndpoints	The URIs that are the public endpoints of the account.
AccountPropertiesManagedResources	Gets the resource identifiers of the managed resources.
AccountSku	The Sku
AccountStatus	The account status.
AccountStatusErrorDetails	Gets the account error details.
AccountUpdateParameters	The account update properties.
AccountsAddRootCollectionAdminOptionalParams	Optional parameters.
AccountsCheckNameAvailabilityOptionalParams	Optional parameters.
AccountsCreateOrUpdateOptionalParams	Optional parameters.
AccountsDeleteOptionalParams	Optional parameters.
AccountsGetOptionalParams	Optional parameters.
AccountsListByResourceGroupOptionalParams	Optional parameters.
AccountsListBySubscriptionOptionalParams	Optional parameters.
AccountsListKeysOptionalParams	Optional parameters.
AccountsOperations	Interface representing a Accounts operations.
AccountsUpdateOptionalParams	Optional parameters.
BatchFeatureRequest	Feature request model
BatchFeatureStatus	List of features with enabled status
CheckNameAvailabilityRequest	The request payload for CheckNameAvailability API
CheckNameAvailabilityResult	The response payload for CheckNameAvailability API
CloudConnectors	External Cloud Service connectors
CollectionAdminUpdate	Collection administrator update.
Credentials	Credentials to access the event streaming service attached to the purview account.
DefaultAccountPayload	Payload to get and set the default account in the given scope
DefaultAccountsGetOptionalParams	Optional parameters.
DefaultAccountsOperations	Interface representing a DefaultAccounts operations.
DefaultAccountsRemoveOptionalParams	Optional parameters.
DefaultAccountsSetOptionalParams	Optional parameters.
DimensionProperties	properties for dimension
ErrorModel	Default error model
ErrorResponseModel	Default error response model
ErrorResponseModelError	Gets or sets the error.
FeaturesAccountGetOptionalParams	Optional parameters.
FeaturesOperations	Interface representing a Features operations.
FeaturesSubscriptionGetOptionalParams	Optional parameters.
Identity	The Managed Identity of the resource
IngestionPrivateEndpointConnectionsListOptionalParams	Optional parameters.
IngestionPrivateEndpointConnectionsOperations	Interface representing a IngestionPrivateEndpointConnections operations.
IngestionPrivateEndpointConnectionsUpdateStatusOptionalParams	Optional parameters.
IngestionStorage	Ingestion Storage Account Info
KafkaConfiguration	The configuration of the event streaming service resource attached to the Purview account for kafka notifications.
KafkaConfigurationProperties	The kafka configuration properties of the event streaming service attached to the Purview account for kafka notifications.
KafkaConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
KafkaConfigurationsDeleteOptionalParams	Optional parameters.
KafkaConfigurationsGetOptionalParams	Optional parameters.
KafkaConfigurationsListByAccountOptionalParams	Optional parameters.
KafkaConfigurationsOperations	Interface representing a KafkaConfigurations operations.
ManagedResources	The managed resources in customer subscription.
Operation	Operation resource
OperationDisplay	The response model for get operation properties
OperationMetaLogSpecification	log specifications for operation api
OperationMetaMetricSpecification	metric specifications for the operation
OperationMetaServiceSpecification	The operation meta service specification
OperationProperties	properties on meta info
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.
PrivateEndpoint	A private endpoint class.
PrivateEndpointConnection	A private endpoint connection class.
PrivateEndpointConnectionProperties	A private endpoint connection properties class.
PrivateEndpointConnectionStatusUpdateRequest	A private endpoint connection status update request class.
PrivateEndpointConnectionStatusUpdateResponse	A private endpoint connection status update response class.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByAccountOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	A privately linkable resource.
PrivateLinkResourceProperties	A privately linkable resource properties.
PrivateLinkResourcesGetByGroupIdOptionalParams	Optional parameters.
PrivateLinkResourcesListByAccountOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	The private link service connection state.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PurviewManagementClientOptionalParams	Optional parameters for the client.
QuotaName	Quota name
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SystemData	Metadata pertaining to creation and last modification of the resource.
Usage	Response for usage information
UsageList	List of usage information
UsageName	Quota name
UsagesGetOptionalParams	Optional parameters.
UsagesOperations	Interface representing a Usages operations.
UserAssignedIdentity	Uses client ID and Principal ID

Type Aliases

AccountProvisioningState	Gets the account status code. KnownAccountProvisioningState can be used interchangeably with AccountProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown Creating: Creating Updating: Updating Moving: Moving Deleting: Deleting SoftDeleting: SoftDeleting SoftDeleted: SoftDeleted Failed: Failed Succeeded: Succeeded Canceled: Canceled
AccountSkuName	Gets or sets the sku name. KnownAccountSkuName can be used interchangeably with AccountSkuName, this enum contains the known values that the service supports. Known values supported by the service Standard: Standard Free: Free
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.
EventHubType	The event hub type. KnownEventHubType can be used interchangeably with EventHubType, this enum contains the known values that the service supports. Known values supported by the service Notification: Notification Hook: Hook
EventStreamingState	The state of the event streaming service KnownEventStreamingState can be used interchangeably with EventStreamingState, this enum contains the known values that the service supports. Known values supported by the service Disabled: Disabled Enabled: Enabled
EventStreamingType	The event streaming service type KnownEventStreamingType can be used interchangeably with EventStreamingType, this enum contains the known values that the service supports. Known values supported by the service None: None Managed: Managed Azure: Azure
KafkaConfigurationIdentityType	Identity Type. KnownKafkaConfigurationIdentityType can be used interchangeably with KafkaConfigurationIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: None SystemAssigned: SystemAssigned UserAssigned: UserAssigned
ManagedEventHubState	Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed. KnownManagedEventHubState can be used interchangeably with ManagedEventHubState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: NotSpecified Disabled: Disabled Enabled: Enabled
ManagedIdentityType	Identity Type KnownManagedIdentityType can be used interchangeably with ManagedIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: None SystemAssigned: SystemAssigned SystemAssigned,UserAssigned: Both SystemAssigned and UserAssigned identities.
MergeAccountType	The account's type for the merge operation. KnownMergeAccountType can be used interchangeably with MergeAccountType, this enum contains the known values that the service supports. Known values supported by the service Primary: Primary Secondary: Secondary
MergeStatus	The status of the merge operation. KnownMergeStatus can be used interchangeably with MergeStatus, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Succeeded Failed: Failed InProgress: InProgress
PrivateEndpointConnectionStatus	The status. KnownPrivateEndpointConnectionStatus can be used interchangeably with PrivateEndpointConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown Pending: Pending Approved: Approved Rejected: Rejected Disconnected: Disconnected
ProvisioningState	Gets or sets the state of the provisioning. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Unknown: Unknown Creating: Creating Moving: Moving Deleting: Deleting SoftDeleting: SoftDeleting SoftDeleted: SoftDeleted Failed: Failed Succeeded: Succeeded Canceled: Canceled
PublicNetworkAccess	Gets or sets the public network access for managed resources. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: NotSpecified Enabled: Enabled Disabled: Disabled
Reason	The reason the name is not available. KnownReason can be used interchangeably with Reason, this enum contains the known values that the service supports. Known values supported by the service Invalid: Invalid AlreadyExists: AlreadyExists
ScopeType	The scope where the default account is set. KnownScopeType can be used interchangeably with ScopeType, this enum contains the known values that the service supports. Known values supported by the service Tenant: Tenant Subscription: Subscription
TenantEndpointState	Gets or sets the state of tenant endpoint. KnownTenantEndpointState can be used interchangeably with TenantEndpointState, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: NotSpecified Disabled: Disabled Enabled: Enabled

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAccountProvisioningState	Gets the account status code.
KnownAccountSkuName	Gets or sets the sku name.
KnownCreatedByType	The kind of entity that created the resource.
KnownEventHubType	The event hub type.
KnownEventStreamingState	The state of the event streaming service
KnownEventStreamingType	The event streaming service type
KnownKafkaConfigurationIdentityType	Identity Type.
KnownManagedEventHubState	Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.
KnownManagedIdentityType	Identity Type
KnownMergeAccountType	The account's type for the merge operation.
KnownMergeStatus	The status of the merge operation.
KnownPrivateEndpointConnectionStatus	The status.
KnownProvisioningState	Gets or sets the state of the provisioning.
KnownPublicNetworkAccess	Gets or sets the public network access for managed resources.
KnownReason	The reason the name is not available.
KnownScopeType	The scope where the default account is set.
KnownTenantEndpointState	Gets or sets the state of tenant endpoint.
KnownVersions	The available API versions.

Functions

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

Parameters

client

PurviewManagementClient

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