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 primaryKeyURI: String? = null, val primaryUserAssignedIdentityId: String? = null, val type: String? = null)

Data encryption properties of a server

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 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 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 GetClusterResult(val administratorLogin: String, val citusVersion: String? = null, val coordinatorEnablePublicIpAccess: Boolean? = null, val coordinatorServerEdition: String? = null, val coordinatorStorageQuotaInMb: Int? = null, val coordinatorVCores: Int? = null, val earliestRestoreTime: String, val enableHa: Boolean? = null, val enableShardsOnCoordinator: Boolean? = null, val id: String, val location: String, val maintenanceWindow: MaintenanceWindowResponse? = 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 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 GetConfigurationResult(val allowedValues: 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 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 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 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 migrationId: String, val migrationMode: 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 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 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 GetRoleResult(val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, 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 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 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 GetVirtualEndpointResult(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 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)

Migration sub state details.

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

Network properties of a server.

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

Property to represent resource id of the private endpoint.

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 ServerNameItemResponse(val fullyQualifiedDomainName: String, val name: String? = null)

The name object for a server.

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

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 SkuResponse(val name: String, val tier: String)

Sku information related properties of a server.

Link copied to clipboard
data class StorageResponse(val storageSizeGB: Int? = 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 tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserIdentityResponse>? = null)

Information describing the identities associated with this application.

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.