Package-level declarations

Types

data class ActiveDirectoryConnectorDNSDetailsResponse(val domainName: String? = null, val nameserverIPAddresses: List<String>, val preferK8sDnsForPtrLookups: Boolean? = null, val replicas: Double? = null)

DNS server details

data class ActiveDirectoryConnectorDomainDetailsResponse(val domainControllers: ActiveDirectoryDomainControllersResponse? = null, val netbiosDomainName: String? = null, val ouDistinguishedName: String? = null, val realm: String, val serviceAccountProvisioning: String? = null)

Active Directory domain details

data class ActiveDirectoryConnectorPropertiesResponse(val domainServiceAccountLoginInformation: BasicLoginInformationResponse? = null, val provisioningState: String, val spec: ActiveDirectoryConnectorSpecResponse, val status: ActiveDirectoryConnectorStatusResponse? = null)

The properties of an Active Directory connector resource

Link copied to clipboard

The specifications of the AD Kubernetes resource.

Link copied to clipboard
data class ActiveDirectoryConnectorStatusResponse(val lastUpdateTime: String? = null, val observedGeneration: Double? = null, val state: String? = null)

The status of the Kubernetes custom resource.

Link copied to clipboard

Information about a domain controller in the AD domain.

Link copied to clipboard
data class ActiveDirectoryDomainControllersResponse(val primaryDomainController: ActiveDirectoryDomainControllerResponse? = null, val secondaryDomainControllers: List<ActiveDirectoryDomainControllerResponse>? = null)

Details about the Active Directory domain controllers associated with this AD connector instance

Link copied to clipboard
data class AvailabilityGroupConfigureResponse(val availabilityModeDescription: String, val backupPriority: Int? = null, val endpointUrl: String? = null, val failoverModeDescription: String, val primaryRoleAllowConnectionsDescription: String, val readOnlyRoutingUrl: String? = null, val readWriteRoutingUrl: String? = null, val replicaCreateDate: String, val replicaModifyDate: String, val secondaryRoleAllowConnectionsDescription: String, val seedingModeDescription: String, val sessionTimeout: Int? = null)

The specifications of the availability group replica configuration

Link copied to clipboard
data class AvailabilityGroupInfoResponse(val automatedBackupPreferenceDescription: String, val basicFeatures: Boolean? = null, val clusterTypeDescription: String, val dbFailover: Boolean? = null, val dtcSupport: Boolean? = null, val failureConditionLevel: Int? = null, val healthCheckTimeout: Int? = null, val isContained: Boolean? = null, val isDistributed: Boolean? = null, val primaryRecoveryHealthDescription: String, val primaryReplica: String, val replicationPartnerType: String, val requiredSynchronizedSecondariesToCommit: Int? = null, val secondaryRecoveryHealthDescription: String, val synchronizationHealthDescription: String, val version: Int)

The specifications of the availability group state

Link copied to clipboard
data class AvailabilityGroupStateResponse(val availabilityGroupReplicaRole: String, val connectedStateDescription: String, val lastConnectErrorDescription: String, val lastConnectErrorTimestamp: String, val operationalStateDescription: String, val recoveryHealthDescription: String, val synchronizationHealthDescription: String)

The specifications of the availability group state

Link copied to clipboard
data class BackgroundJobResponse(val endTime: String? = null, val executionState: String? = null, val lastExecutionStatus: String? = null, val lastExecutionTime: String? = null, val startTime: String? = null, val state: String? = null)

The background job details.

Link copied to clipboard
data class BackupPolicyResponse(val differentialBackupHours: Int? = null, val fullBackupDays: Int? = null, val retentionPeriodDays: Int? = null, val transactionLogBackupMinutes: Int? = null)

The backup profile for the SQL server.

Link copied to clipboard
data class BasicLoginInformationResponse(val username: String? = null)

Username and password for basic login authentication.

Link copied to clipboard
data class DataControllerPropertiesResponse(val basicLoginInformation: BasicLoginInformationResponse? = null, val clusterId: String? = null, val extensionId: String? = null, val infrastructure: String? = null, val k8sRaw: Any? = null, val lastUploadedDate: String? = null, val logAnalyticsWorkspaceConfig: LogAnalyticsWorkspaceConfigResponse? = null, val logsDashboardCredential: BasicLoginInformationResponse? = null, val metricsDashboardCredential: BasicLoginInformationResponse? = null, val onPremiseProperty: OnPremisePropertyResponse? = null, val provisioningState: String, val uploadServicePrincipal: UploadServicePrincipalResponse? = null, val uploadWatermark: UploadWatermarkResponse? = null)

The data controller properties.

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

The complex type of the extended location.

Link copied to clipboard
data class FailoverClusterResponse(val hostNames: List<String>, val id: String, val networkName: String, val sqlInstanceIds: List<String>)

Failover Cluster Instance properties.

Link copied to clipboard
data class FailoverGroupPropertiesResponse(val partnerManagedInstanceId: String, val provisioningState: String, val spec: FailoverGroupSpecResponse, val status: Any? = null)

The properties of a failover group resource.

Link copied to clipboard
data class FailoverGroupSpecResponse(val partnerMI: String? = null, val partnerMirroringCert: String? = null, val partnerMirroringURL: String? = null, val partnerSyncMode: String? = null, val role: String, val sharedName: String? = null, val sourceMI: String? = null)

The specifications of the failover group resource.

Link copied to clipboard
data class GetActiveDirectoryConnectorResult(val azureApiVersion: String, val id: String, val name: String, val properties: ActiveDirectoryConnectorPropertiesResponse, val systemData: SystemDataResponse, val type: String)

Active directory connector resource

Link copied to clipboard
data class GetDataControllerResult(val azureApiVersion: String, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String, val name: String, val properties: DataControllerPropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Data controller resource

Link copied to clipboard
data class GetFailoverGroupResult(val azureApiVersion: String, val id: String, val name: String, val properties: FailoverGroupPropertiesResponse, val systemData: SystemDataResponse, val type: String)

A failover group resource.

Link copied to clipboard
data class GetPostgresInstanceResult(val azureApiVersion: String, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String, val name: String, val properties: PostgresInstancePropertiesResponse, val sku: PostgresInstanceSkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A Postgres Instance.

Link copied to clipboard
data class GetSqlManagedInstanceResult(val azureApiVersion: String, val extendedLocation: ExtendedLocationResponse? = null, val id: String, val location: String, val name: String, val properties: SqlManagedInstancePropertiesResponse, val sku: SqlManagedInstanceSkuResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A SqlManagedInstance.

data class GetSqlServerAvailabilityGroupDetailViewResult(val id: String, val location: String, val name: String, val properties: SqlServerAvailabilityGroupResourcePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Arc Sql Server Availability Group

Link copied to clipboard
data class GetSqlServerAvailabilityGroupResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: SqlServerAvailabilityGroupResourcePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Arc Sql Server Availability Group

Link copied to clipboard
data class GetSqlServerDatabaseResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: SqlServerDatabaseResourcePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Arc Sql Server database

Link copied to clipboard
data class GetSqlServerEsuLicenseResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: SqlServerEsuLicensePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Describe SQL Server ESU license resource.

Link copied to clipboard

The response for the status of the jobs running on the SQL Server instance.

Link copied to clipboard
data class GetSqlServerInstanceResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: SqlServerInstancePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

A SqlServerInstance.

Link copied to clipboard

A section of the telemetry response for the SQL Server instance.

Link copied to clipboard
data class GetSqlServerLicenseResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: SqlServerLicensePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Describe SQL Server license resource.

Link copied to clipboard
data class K8sActiveDirectoryResponse(val accountName: String? = null, val connector: K8sActiveDirectoryResponseConnector? = null, val encryptionTypes: List<String>? = null, val keytabSecret: String? = null)

The kubernetes active directory information.

Link copied to clipboard
data class K8sActiveDirectoryResponseConnector(val name: String? = null, val namespace: String? = null)
Link copied to clipboard
data class K8sNetworkSettingsResponse(val forceencryption: Int? = null, val tlsciphers: String? = null, val tlsprotocols: String? = null)

The kubernetes network settings information.

Link copied to clipboard
data class K8sResourceRequirementsResponse(val limits: Map<String, String>? = null, val requests: Map<String, String>? = null)

The kubernetes resource limits and requests used to restrict or reserve resource usage.

Link copied to clipboard

The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service

Link copied to clipboard
data class K8sSchedulingResponse(val default: K8sSchedulingOptionsResponse? = null)

The kubernetes scheduling information.

Link copied to clipboard
data class K8sSecurityResponse(val activeDirectory: K8sActiveDirectoryResponse? = null, val adminLoginSecret: String? = null, val serviceCertificateSecret: String? = null, val transparentDataEncryption: K8stransparentDataEncryptionResponse? = null)

The kubernetes security information.

Link copied to clipboard
data class K8sSettingsResponse(val network: K8sNetworkSettingsResponse? = null)

The kubernetes settings information.

Link copied to clipboard
data class K8stransparentDataEncryptionResponse(val mode: String? = null, val protectorSecret: String? = null)

Transparent data encryption information.

Link copied to clipboard
data class LogAnalyticsWorkspaceConfigResponse(val workspaceId: String? = null)

Log analytics workspace id and primary key

Link copied to clipboard
data class MonitoringResponse(val enabled: Boolean? = null)

The monitoring configuration.

Link copied to clipboard
data class OnPremisePropertyResponse(val id: String, val publicSigningKey: String, val signingCertificateThumbprint: String? = null)

Properties from the Kubernetes data controller

Link copied to clipboard
data class PostgresInstancePropertiesResponse(val admin: String? = null, val basicLoginInformation: BasicLoginInformationResponse? = null, val dataControllerId: String? = null, val k8sRaw: Any? = null, val lastUploadedDate: String? = null, val provisioningState: String)

Postgres Instance properties.

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

The resource model definition representing SKU for Azure Database for PostgresSQL - Azure Arc

Link copied to clipboard
data class SequencerActionResponse(val actionId: String? = null, val result: String? = null, val state: String? = null)

The sequencer action details.

data class SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse(val databaseName: String? = null, val databaseStateDescription: String, val isCommitParticipant: Boolean, val isLocal: Boolean, val isPrimaryReplica: Boolean, val isSuspended: Boolean, val replicaName: String, val suspendReasonDescription: String, val synchronizationHealthDescription: String, val synchronizationStateDescription: String)

The properties of Arc Sql availability group database replica resource

data class SqlAvailabilityGroupReplicaResourcePropertiesResponse(val configure: AvailabilityGroupConfigureResponse? = null, val replicaId: String, val replicaName: String? = null, val state: AvailabilityGroupStateResponse? = null)

The properties of Arc Sql availability group replica resource

Link copied to clipboard

The raw kubernetes information.

Link copied to clipboard
data class SqlManagedInstanceK8sSpecResponse(val replicas: Int? = null, val scheduling: K8sSchedulingResponse? = null, val security: K8sSecurityResponse? = null, val settings: K8sSettingsResponse? = null)

The kubernetes spec information.

Link copied to clipboard
data class SqlManagedInstancePropertiesResponse(val admin: String? = null, val basicLoginInformation: BasicLoginInformationResponse? = null, val clusterId: String? = null, val dataControllerId: String? = null, val endTime: String? = null, val extensionId: String? = null, val k8sRaw: SqlManagedInstanceK8sRawResponse? = null, val lastUploadedDate: String? = null, val licenseType: String? = null, val provisioningState: String, val startTime: String? = null)

Properties of sqlManagedInstance.

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

The resource model definition representing SKU for Azure Managed Instance - Azure Arc

data class SqlServerAvailabilityGroupResourcePropertiesResponse(val availabilityGroupId: String, val collectionTimestamp: String, val databases: SqlServerAvailabilityGroupResourcePropertiesResponseDatabases? = null, val info: AvailabilityGroupInfoResponse? = null, val instanceName: String, val provisioningState: String, val replicas: SqlServerAvailabilityGroupResourcePropertiesResponseReplicas? = null, val serverName: String)

The properties of Arc Sql Server availability group resource

data class SqlServerDatabaseResourcePropertiesResponse(val backupInformation: SqlServerDatabaseResourcePropertiesResponseBackupInformation? = null, val backupPolicy: BackupPolicyResponse? = null, val collationName: String? = null, val compatibilityLevel: Int? = null, val createMode: String? = null, val databaseCreationDate: String? = null, val databaseOptions: SqlServerDatabaseResourcePropertiesResponseDatabaseOptions? = null, val earliestRestoreDate: String, val isReadOnly: Boolean? = null, val lastDatabaseUploadTime: String, val provisioningState: String, val recoveryMode: String? = null, val restorePointInTime: String? = null, val sizeMB: Double? = null, val sourceDatabaseId: String? = null, val spaceAvailableMB: Double? = null, val state: String? = null)

The properties of Arc Sql Server database resource

data class SqlServerDatabaseResourcePropertiesResponseBackupInformation(val lastFullBackup: String? = null, val lastLogBackup: String? = null)
data class SqlServerDatabaseResourcePropertiesResponseDatabaseOptions(val isAutoCloseOn: Boolean? = null, val isAutoCreateStatsOn: Boolean? = null, val isAutoShrinkOn: Boolean? = null, val isAutoUpdateStatsOn: Boolean? = null, val isEncrypted: Boolean? = null, val isMemoryOptimizationEnabled: Boolean? = null, val isRemoteDataArchiveEnabled: Boolean? = null, val isTrustworthyOn: Boolean? = null)

List of features that are enabled for the database

Link copied to clipboard
data class SqlServerEsuLicensePropertiesResponse(val activatedAt: String, val activationState: String, val billingPlan: String, val physicalCores: Int, val scopeType: String, val tenantId: String, val terminatedAt: String, val uniqueId: String, val version: String)

Properties of SQL Server ESU license.

Link copied to clipboard
data class SqlServerInstanceJobStatusResponse(val backgroundJob: BackgroundJobResponse? = null, val id: String? = null, val instanceName: String? = null, val jobException: String? = null, val jobStatus: String? = null, val sequencerActions: List<SequencerActionResponse>? = null)

The status of the job running on the SQL Server instance.

Link copied to clipboard
data class SqlServerInstancePropertiesResponse(val alwaysOnRole: String, val azureDefenderStatus: String, val azureDefenderStatusLastUpdated: String, val backupPolicy: BackupPolicyResponse? = null, val collation: String, val containerResourceId: String, val cores: String? = null, val createTime: String, val currentVersion: String, val edition: String? = null, val failoverCluster: FailoverClusterResponse? = null, val hostType: String? = null, val instanceName: String? = null, val lastInventoryUploadTime: String, val lastUsageUploadTime: String, val licenseType: String, val monitoring: MonitoringResponse? = null, val patchLevel: String, val productId: String, val provisioningState: String, val status: String, val tcpDynamicPorts: String, val tcpStaticPorts: String, val upgradeLockedUntil: String? = null, val vCore: String, val version: String? = null)

Properties of SqlServerInstance.

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

The telemetry column for the SQL Server instance.

Link copied to clipboard
data class SqlServerLicensePropertiesResponse(val activationState: String, val billingPlan: String, val lastActivatedAt: String, val lastDeactivatedAt: String, val licenseCategory: String, val physicalCores: Int, val scopeType: String, val tenantId: String)

Properties of SQL Server License.

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 UploadServicePrincipalResponse(val authority: String? = null, val clientId: String? = null, val tenantId: String? = null)

Service principal for uploading billing, metrics and logs.

Link copied to clipboard
data class UploadWatermarkResponse(val logs: String? = null, val metrics: String? = null, val usages: String? = null)

Properties on upload watermark. Mostly timestamp for each upload data type