Package-level declarations

Types

Link copied to clipboard
data class AccountPropertiesResponseAccountStatus(val accountProvisioningState: String, val errorDetails: AccountStatusResponseErrorDetails)

Gets or sets the status of the account.

Link copied to clipboard
data class AccountPropertiesResponseEndpoints(val catalog: String, val guardian: String, val scan: String)

The URIs that are the public endpoints of the account.

data class AccountPropertiesResponseManagedResources(val eventHubNamespace: String, val resourceGroup: String, val storageAccount: String)

Gets the resource identifiers of the managed resources.

Link copied to clipboard
data class AccountResponseSku(val capacity: Int? = null, val name: String? = null)

Gets or sets the Sku.

Link copied to clipboard
data class AccountStatusResponseErrorDetails(val code: String, val details: List<ErrorModelResponse>, val message: String, val target: String)

Gets the account error details.

Link copied to clipboard
data class CloudConnectorsResponse(val awsExternalId: String)

External Cloud Service connectors

Link copied to clipboard
data class CredentialsResponse(val identityId: String? = null, val type: String? = null)

Credentials to access the event streaming service attached to the purview account.

Link copied to clipboard
data class ErrorModelResponse(val code: String, val details: List<ErrorModelResponse>, val message: String, val target: String)

Default error model

Link copied to clipboard
data class GetAccountResult(val accountStatus: AccountPropertiesResponseAccountStatus, val cloudConnectors: CloudConnectorsResponse? = null, val createdAt: String, val createdBy: String, val createdByObjectId: String, val endpoints: AccountPropertiesResponseEndpoints, val friendlyName: String, val id: String, val identity: IdentityResponse? = null, val location: String? = null, val managedEventHubState: String? = null, val managedResourceGroupName: String? = null, val managedResources: AccountPropertiesResponseManagedResources, val managedResourcesPublicNetworkAccess: String? = null, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val sku: AccountResponseSku, val systemData: TrackedResourceResponseSystemData, val tags: Map<String, String>? = null, val type: String)

Account resource

Link copied to clipboard
data class GetKafkaConfigurationResult(val consumerGroup: String? = null, val credentials: CredentialsResponse? = null, val eventHubPartitionId: String? = null, val eventHubResourceId: String? = null, val eventHubType: String? = null, val eventStreamingState: String? = null, val eventStreamingType: String? = null, val id: String, val name: String, val systemData: ProxyResourceResponseSystemData, val type: String)

The configuration of the event streaming service resource attached to the Purview account for kafka notifications.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val systemData: ProxyResourceResponseSystemData, val type: String)

A private endpoint connection class.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

The Managed Identity of the resource

Link copied to clipboard
data class ListAccountKeysResult(val atlasKafkaPrimaryEndpoint: String? = null, val atlasKafkaSecondaryEndpoint: String? = null)

The Account access keys.

Link copied to clipboard
data class ListFeatureAccountResult(val features: Map<String, Boolean>? = null)

List of features with enabled status

Link copied to clipboard
data class ListFeatureSubscriptionResult(val features: Map<String, Boolean>? = null)

List of features with enabled status

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val systemData: ProxyResourceResponseSystemData, val type: String)

A private endpoint connection class.

Link copied to clipboard
data class PrivateEndpointResponse(val id: String? = null)

A private endpoint class.

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String? = null, val status: String? = null)

The private link service connection state.

Link copied to clipboard
data class ProxyResourceResponseSystemData(val createdAt: String, val createdBy: String, val createdByType: String, val lastModifiedAt: String, val lastModifiedBy: String, val lastModifiedByType: String)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TrackedResourceResponseSystemData(val createdAt: String, val createdBy: String, val createdByType: String, val lastModifiedAt: String, val lastModifiedBy: String, val lastModifiedByType: String)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

Uses client ID and Principal ID