Package-level declarations

Types

Link copied to clipboard
data class AuthConfigResponse(val activeDirectoryAuth: String? = null, val passwordAuth: String? = null, val tenantId: String? = null)

Authentication configuration properties of a server

Link copied to clipboard
data class BackupResponse(val backupRetentionDays: Int? = null, val earliestRestoreDate: String, val geoRedundantBackup: String? = null)

Backup properties of a server

Link copied to clipboard
data class DataEncryptionResponse(val geoBackupEncryptionKeyStatus: String? = null, val geoBackupKeyURI: String? = null, val geoBackupUserAssignedIdentityId: String? = null, val primaryEncryptionKeyStatus: String? = null, val primaryKeyURI: String? = null, val primaryUserAssignedIdentityId: String? = null, val type: String? = null)

Data encryption properties of a server

Link copied to clipboard
data class DbLevelValidationStatusResponse(val databaseName: String? = null, val endedOn: String? = null, val startedOn: String? = null, val summary: List<ValidationSummaryItemResponse>? = null)

Validation status summary for an individual database

Link copied to clipboard
data class DbMigrationStatusResponse(val appliedChanges: Int? = null, val cdcDeleteCounter: Int? = null, val cdcInsertCounter: Int? = null, val cdcUpdateCounter: Int? = null, val databaseName: String? = null, val endedOn: String? = null, val fullLoadCompletedTables: Int? = null, val fullLoadErroredTables: Int? = null, val fullLoadLoadingTables: Int? = null, val fullLoadQueuedTables: Int? = null, val incomingChanges: Int? = null, val latency: Int? = null, val message: String? = null, val migrationOperation: String? = null, val migrationState: String? = null, val startedOn: String? = null)

Migration status of an individual database

Link copied to clipboard
data class DbServerMetadataResponse(val location: String, val sku: ServerSkuResponse? = null, val storageMb: Int? = null, val version: String? = null)

Database server metadata.

Link copied to clipboard
data class GetAdministratorResult(val azureApiVersion: String, val id: String, val name: String, val objectId: String? = null, val principalName: String? = null, val principalType: String? = null, val systemData: SystemDataResponse, val tenantId: String? = null, val type: String)

Represents an Active Directory administrator.

Link copied to clipboard
data class GetBackupResult(val azureApiVersion: String, val backupType: String? = null, val completedTime: String? = null, val id: String, val name: String, val source: String? = null, val systemData: SystemDataResponse, val type: String)

Server backup properties

Link copied to clipboard
data class GetConfigurationResult(val allowedValues: String, val azureApiVersion: String, val dataType: String, val defaultValue: String, val description: String, val documentationLink: String, val id: String, val isConfigPendingRestart: Boolean, val isDynamicConfig: Boolean, val isReadOnly: Boolean, val name: String, val source: String? = null, val systemData: SystemDataResponse, val type: String, val unit: String, val value: String? = null)

Represents a Configuration.

Link copied to clipboard
data class GetDatabaseResult(val azureApiVersion: String, val charset: String? = null, val collation: String? = null, val id: String, val name: String, val systemData: SystemDataResponse, val type: String)

Represents a Database.

Link copied to clipboard
data class GetFirewallRuleResult(val azureApiVersion: String, val endIpAddress: String, val id: String, val name: String, val startIpAddress: String, val systemData: SystemDataResponse, val type: String)

Represents a server firewall rule.

Link copied to clipboard
data class GetGetPrivateDnsZoneSuffixExecuteResult(val value: String? = null)

Represents a resource name availability.

Link copied to clipboard
data class GetMigrationResult(val azureApiVersion: String, val cancel: String? = null, val currentStatus: MigrationStatusResponse, val dbsToCancelMigrationOn: List<String>? = null, val dbsToMigrate: List<String>? = null, val dbsToTriggerCutoverOn: List<String>? = null, val id: String, val location: String, val migrateRoles: String? = null, val migrationId: String, val migrationInstanceResourceId: String? = null, val migrationMode: String? = null, val migrationOption: String? = null, val migrationWindowEndTimeInUtc: String? = null, val migrationWindowStartTimeInUtc: String? = null, val name: String, val overwriteDbsInTarget: String? = null, val setupLogicalReplicationOnSourceDbIfNeeded: String? = null, val sourceDbServerFullyQualifiedDomainName: String? = null, val sourceDbServerMetadata: DbServerMetadataResponse, val sourceDbServerResourceId: String? = null, val sourceType: String? = null, val sslMode: String? = null, val startDataMigration: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val targetDbServerFullyQualifiedDomainName: String? = null, val targetDbServerMetadata: DbServerMetadataResponse, val targetDbServerResourceId: String, val triggerCutover: String? = null, val type: String)

Represents a migration resource.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val azureApiVersion: String, val groupIds: List<String>, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The private endpoint connection resource.

Link copied to clipboard
data class GetServerGroupClusterResult(val aadAuthEnabled: String, val administratorLogin: String, val authConfig: ServerGroupClusterAuthConfigResponse? = null, val azureApiVersion: String, val citusVersion: String? = null, val coordinatorEnablePublicIpAccess: Boolean? = null, val coordinatorServerEdition: String? = null, val coordinatorStorageQuotaInMb: Int? = null, val coordinatorVCores: Int? = null, val dataEncryption: ServerGroupClusterDataEncryptionResponse? = null, val databaseName: String? = null, val earliestRestoreTime: String, val enableGeoBackup: Boolean? = null, val enableHa: Boolean? = null, val enableShardsOnCoordinator: Boolean? = null, val id: String, val identity: IdentityPropertiesResponse? = null, val location: String, val maintenanceWindow: ServerGroupClusterMaintenanceWindowResponse? = null, val name: String, val nodeCount: Int? = null, val nodeEnablePublicIpAccess: Boolean? = null, val nodeServerEdition: String? = null, val nodeStorageQuotaInMb: Int? = null, val nodeVCores: Int? = null, val passwordEnabled: String, val pointInTimeUTC: String? = null, val postgresqlVersion: String? = null, val preferredPrimaryZone: String? = null, val privateEndpointConnections: List<SimplePrivateEndpointConnectionResponse>, val provisioningState: String, val readReplicas: List<String>, val serverNames: List<ServerNameItemResponse>, val sourceLocation: String? = null, val sourceResourceId: String? = null, val state: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a cluster.

Link copied to clipboard
data class GetServerGroupFirewallRuleResult(val azureApiVersion: String, val endIpAddress: String, val id: String, val name: String, val provisioningState: String, val startIpAddress: String, val systemData: SystemDataResponse, val type: String)

Represents a cluster firewall rule.

data class GetServerGroupPrivateEndpointConnectionResult(val azureApiVersion: String, val groupIds: List<String>, val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

The private endpoint connection resource.

Link copied to clipboard
data class GetServerGroupRoleResult(val azureApiVersion: String, val id: String, val name: String, val objectId: String, val principalType: String, val provisioningState: String, val roleType: String? = null, val systemData: SystemDataResponse, val tenantId: String? = null, val type: String)

Represents a cluster role.

Link copied to clipboard
data class GetServerResult(val administratorLogin: String? = null, val authConfig: AuthConfigResponse? = null, val availabilityZone: String? = null, val azureApiVersion: String, val backup: BackupResponse? = null, val dataEncryption: DataEncryptionResponse? = null, val fullyQualifiedDomainName: String, val highAvailability: HighAvailabilityResponse? = null, val id: String, val identity: UserAssignedIdentityResponse? = null, val location: String, val maintenanceWindow: MaintenanceWindowResponse? = null, val minorVersion: String, val name: String, val network: NetworkResponse? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val replica: ReplicaResponse? = null, val replicaCapacity: Int, val replicationRole: String? = null, val sku: SkuResponse? = null, val sourceServerResourceId: String? = null, val state: String, val storage: StorageResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val version: String? = null)

Represents a server.

Link copied to clipboard
data class GetSingleServerConfigurationResult(val allowedValues: String, val azureApiVersion: String, val dataType: String, val defaultValue: String, val description: String, val id: String, val name: String, val source: String? = null, val type: String, val value: String? = null)

Represents a Configuration.

Link copied to clipboard
data class GetSingleServerDatabaseResult(val azureApiVersion: String, val charset: String? = null, val collation: String? = null, val id: String, val name: String, val type: String)

Represents a Database.

Link copied to clipboard
data class GetSingleServerFirewallRuleResult(val azureApiVersion: String, val endIpAddress: String, val id: String, val name: String, val startIpAddress: String, val type: String)

Represents a server firewall rule.

Link copied to clipboard
data class GetSingleServerResult(val administratorLogin: String? = null, val azureApiVersion: String, val byokEnforcement: String, val earliestRestoreDate: String? = null, val fullyQualifiedDomainName: String? = null, val id: String, val identity: ResourceIdentityResponse? = null, val infrastructureEncryption: String? = null, val location: String, val masterServerId: String? = null, val minimalTlsVersion: String? = null, val name: String, val privateEndpointConnections: List<ServerPrivateEndpointConnectionResponse>, val publicNetworkAccess: String? = null, val replicaCapacity: Int? = null, val replicationRole: String? = null, val sku: SingleServerSkuResponse? = null, val sslEnforcement: String? = null, val storageProfile: StorageProfileResponse? = null, val tags: Map<String, String>? = null, val type: String, val userVisibleState: String? = null, val version: String? = null)

Represents a server.

Link copied to clipboard
data class GetSingleServerServerAdministratorResult(val administratorType: String, val azureApiVersion: String, val id: String, val login: String, val name: String, val sid: String, val tenantId: String, val type: String)

Represents a and external administrator to be created.

data class GetSingleServerServerSecurityAlertPolicyResult(val azureApiVersion: String, val disabledAlerts: List<String>? = null, val emailAccountAdmins: Boolean? = null, val emailAddresses: List<String>? = null, val id: String, val name: String, val retentionDays: Int? = null, val state: String, val storageAccountAccessKey: String? = null, val storageEndpoint: String? = null, val type: String)

A server security alert policy.

Link copied to clipboard
data class GetSingleServerVirtualNetworkRuleResult(val azureApiVersion: String, val id: String, val ignoreMissingVnetServiceEndpoint: Boolean? = null, val name: String, val state: String, val type: String, val virtualNetworkSubnetId: String)

A virtual network rule.

Link copied to clipboard
data class GetVirtualEndpointResult(val azureApiVersion: String, val endpointType: String? = null, val id: String, val members: List<String>? = null, val name: String, val systemData: SystemDataResponse, val type: String, val virtualEndpoints: List<String>)

Represents a virtual endpoint for a server.

Link copied to clipboard
data class HighAvailabilityResponse(val mode: String? = null, val standbyAvailabilityZone: String? = null, val state: String)

High availability properties of a server

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

Describes the identity of the cluster.

Link copied to clipboard
data class MaintenanceWindowResponse(val customWindow: String? = null, val dayOfWeek: Int? = null, val startHour: Int? = null, val startMinute: Int? = null)

Maintenance window properties of a server.

Link copied to clipboard
data class MigrationStatusResponse(val currentSubStateDetails: MigrationSubStateDetailsResponse, val error: String, val state: String)

Migration status.

Link copied to clipboard
data class MigrationSubStateDetailsResponse(val currentSubState: String, val dbDetails: Map<String, DbMigrationStatusResponse>? = null, val validationDetails: ValidationDetailsResponse? = null)

Migration sub state details.

Link copied to clipboard
data class NetworkResponse(val delegatedSubnetResourceId: String? = null, val privateDnsZoneArmResourceId: String? = null, val publicNetworkAccess: String? = null)

Network properties of a server.

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

The private endpoint connection resource.

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

The private endpoint resource.

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

A collection of information about the state of the connection between service consumer and provider.

Link copied to clipboard
data class ReplicaResponse(val capacity: Int, val replicationState: String, val role: String? = null)

Replica properties of a server

Link copied to clipboard
data class ResourceIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

Azure Active Directory identity configuration for a resource.

Link copied to clipboard
data class ServerGroupClusterAuthConfigResponse(val activeDirectoryAuth: String? = null, val passwordAuth: String? = null)

Authentication configuration of a cluster.

Link copied to clipboard
data class ServerGroupClusterDataEncryptionResponse(val primaryKeyUri: String? = null, val primaryUserAssignedIdentityId: String? = null, val type: String? = null)

The data encryption properties of a cluster.

data class ServerGroupClusterMaintenanceWindowResponse(val customWindow: String? = null, val dayOfWeek: Int? = null, val startHour: Int? = null, val startMinute: Int? = null)

Schedule settings for regular cluster updates.

Link copied to clipboard
data class ServerNameItemResponse(val fullyQualifiedDomainName: String, val name: String? = null)

The name object for a server.

data class ServerPrivateEndpointConnectionPropertiesResponse(val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: ServerPrivateLinkServiceConnectionStatePropertyResponse? = null, val provisioningState: String)

Properties of a private endpoint connection.

Link copied to clipboard

A private endpoint connection under a server

data class ServerPrivateLinkServiceConnectionStatePropertyResponse(val actionsRequired: String, val description: String, val status: String)
Link copied to clipboard
data class ServerSkuResponse(val name: String? = null, val tier: String? = null)

Sku information related properties of a server.

Link copied to clipboard
data class SimplePrivateEndpointConnectionResponse(val groupIds: List<String>? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val systemData: SystemDataResponse, val type: String)

A private endpoint connection.

Link copied to clipboard
data class SingleServerSkuResponse(val capacity: Int? = null, val family: String? = null, val name: String, val size: String? = null, val tier: String? = null)

Billing information related properties of a server.

Link copied to clipboard
data class SkuResponse(val name: String, val tier: String)

Sku information related properties of a server.

Link copied to clipboard
data class StorageProfileResponse(val backupRetentionDays: Int? = null, val geoRedundantBackup: String? = null, val storageAutogrow: String? = null, val storageMB: Int? = null)

Storage Profile properties of a server

Link copied to clipboard
data class StorageResponse(val autoGrow: String? = null, val iops: Int? = null, val storageSizeGB: Int? = null, val throughput: Int? = null, val tier: String? = null, val type: String? = null)

Storage properties of a server

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

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

User assigned identity properties

Link copied to clipboard
data class UserIdentityResponse(val clientId: String? = null, val principalId: String? = null)

Describes a single user-assigned identity associated with the application.

Link copied to clipboard
data class ValidationDetailsResponse(val dbLevelValidationDetails: List<DbLevelValidationStatusResponse>? = null, val serverLevelValidationDetails: List<ValidationSummaryItemResponse>? = null, val status: String? = null, val validationEndTimeInUtc: String? = null, val validationStartTimeInUtc: String? = null)

Details for the validation for migration

Link copied to clipboard
data class ValidationMessageResponse(val message: String? = null, val state: String? = null)

Validation message object

Link copied to clipboard
data class ValidationSummaryItemResponse(val messages: List<ValidationMessageResponse>? = null, val state: String? = null, val type: String? = null)

Validation summary object