Package-level declarations

Types

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

Azure Active Directory identity configuration for a resource.

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

Azure Active Directory identity configuration for a resource.

Properties for an Azure SQL Database Vulnerability Assessment rule baseline's result.

Link copied to clipboard
data class ElasticPoolPerDatabaseSettingsResponse(val maxCapacity: Double? = null, val minCapacity: Double? = null)

Per database settings of an elastic pool.

Link copied to clipboard
data class FailoverGroupReadOnlyEndpointResponse(val failoverPolicy: String? = null)

Read-only endpoint of the failover group instance.

Link copied to clipboard
data class FailoverGroupReadWriteEndpointResponse(val failoverPolicy: String, val failoverWithDataLossGracePeriodMinutes: Int? = null)

Read-write endpoint of the failover group instance.

Link copied to clipboard
data class GetBackupLongTermRetentionPolicyResult(val id: String, val monthlyRetention: String? = null, val name: String, val type: String, val weekOfYear: Int? = null, val weeklyRetention: String? = null, val yearlyRetention: String? = null)

A long term retention policy.

Link copied to clipboard
data class GetBackupShortTermRetentionPolicyResult(val diffBackupIntervalInHours: Int? = null, val id: String, val name: String, val retentionDays: Int? = null, val type: String)

A short term retention policy.

Link copied to clipboard
data class GetDatabaseAdvisorResult(val advisorStatus: String, val autoExecuteStatus: String, val autoExecuteStatusInheritedFrom: String, val id: String, val kind: String, val lastChecked: String, val location: String, val name: String, val recommendationsStatus: String, val recommendedActions: List<RecommendedActionResponse>, val type: String)

Database, Server or Elastic Pool Advisor.

Link copied to clipboard
data class GetDatabaseBlobAuditingPolicyResult(val auditActionsAndGroups: List<String>? = null, val id: String, val isAzureMonitorTargetEnabled: Boolean? = null, val isManagedIdentityInUse: Boolean? = null, val isStorageSecondaryKeyInUse: Boolean? = null, val kind: String, val name: String, val queueDelayMs: Int? = null, val retentionDays: Int? = null, val state: String, val storageAccountSubscriptionId: String? = null, val storageEndpoint: String? = null, val type: String)

A database blob auditing policy.

Link copied to clipboard
data class GetDatabaseResult(val autoPauseDelay: Int? = null, val catalogCollation: String? = null, val collation: String? = null, val creationDate: String, val currentBackupStorageRedundancy: String, val currentServiceObjectiveName: String, val currentSku: SkuResponse, val databaseId: String, val defaultSecondaryLocation: String, val earliestRestoreDate: String, val elasticPoolId: String? = null, val failoverGroupId: String, val federatedClientId: String? = null, val highAvailabilityReplicaCount: Int? = null, val id: String, val identity: DatabaseIdentityResponse? = null, val isInfraEncryptionEnabled: Boolean, val isLedgerOn: Boolean? = null, val kind: String, val licenseType: String? = null, val location: String, val maintenanceConfigurationId: String? = null, val managedBy: String, val maxLogSizeBytes: Double, val maxSizeBytes: Double? = null, val minCapacity: Double? = null, val name: String, val pausedDate: String, val readScale: String? = null, val requestedBackupStorageRedundancy: String? = null, val requestedServiceObjectiveName: String, val resumedDate: String, val secondaryType: String? = null, val sku: SkuResponse? = null, val status: String, val tags: Map<String, String>? = null, val type: String, val zoneRedundant: Boolean? = null)

A database resource.

Link copied to clipboard
data class GetDatabaseSecurityAlertPolicyResult(val creationTime: 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 systemData: SystemDataResponse, val type: String)

A database security alert policy.

data class GetDatabaseSqlVulnerabilityAssessmentRuleBaselineResult(val id: String, val name: String, val results: List<List<String>>, val systemData: SystemDataResponse, val type: String)

A database sql vulnerability assessment rule baseline.

Link copied to clipboard
data class GetDatabaseThreatDetectionPolicyResult(val disabledAlerts: String? = null, val emailAccountAdmins: String? = null, val emailAddresses: String? = null, val id: String, val kind: String, val location: String? = null, val name: String, val retentionDays: Int? = null, val state: String, val storageEndpoint: String? = null, val type: String, val useServerDefault: String? = null)

Contains information about a database Threat Detection policy.

Link copied to clipboard

A database vulnerability assessment.

A database vulnerability assessment rule baseline.

Link copied to clipboard
data class GetDataMaskingPolicyResult(val applicationPrincipals: String, val dataMaskingState: String, val exemptPrincipals: String? = null, val id: String, val kind: String, val location: String, val maskingLevel: String, val name: String, val type: String)

A database data masking policy.

Link copied to clipboard
data class GetDisasterRecoveryConfigurationResult(val autoFailover: String, val failoverPolicy: String, val id: String, val location: String, val logicalServerName: String, val name: String, val partnerLogicalServerName: String, val partnerServerId: String, val role: String, val status: String, val type: String)

Represents a disaster recovery configuration.

Link copied to clipboard
data class GetDistributedAvailabilityGroupResult(val distributedAvailabilityGroupId: String, val id: String, val lastHardenedLsn: String, val linkState: String, val name: String, val primaryAvailabilityGroupName: String? = null, val replicationMode: String? = null, val secondaryAvailabilityGroupName: String? = null, val sourceEndpoint: String? = null, val sourceReplicaId: String, val targetDatabase: String? = null, val targetReplicaId: String, val type: String)

Distributed availability group between box and Sql Managed Instance.

Link copied to clipboard
data class GetElasticPoolResult(val creationDate: String, val highAvailabilityReplicaCount: Int? = null, val id: String, val kind: String, val licenseType: String? = null, val location: String, val maintenanceConfigurationId: String? = null, val maxSizeBytes: Double? = null, val minCapacity: Double? = null, val name: String, val perDatabaseSettings: ElasticPoolPerDatabaseSettingsResponse? = null, val sku: SkuResponse? = null, val state: String, val tags: Map<String, String>? = null, val type: String, val zoneRedundant: Boolean? = null)

An elastic pool.

Link copied to clipboard
data class GetEncryptionProtectorResult(val autoRotationEnabled: Boolean? = null, val id: String, val kind: String, val location: String, val name: String, val serverKeyName: String? = null, val serverKeyType: String, val subregion: String, val thumbprint: String, val type: String, val uri: String)

The server encryption protector.

data class GetExtendedDatabaseBlobAuditingPolicyResult(val auditActionsAndGroups: List<String>? = null, val id: String, val isAzureMonitorTargetEnabled: Boolean? = null, val isManagedIdentityInUse: Boolean? = null, val isStorageSecondaryKeyInUse: Boolean? = null, val name: String, val predicateExpression: String? = null, val queueDelayMs: Int? = null, val retentionDays: Int? = null, val state: String, val storageAccountSubscriptionId: String? = null, val storageEndpoint: String? = null, val type: String)

An extended database blob auditing policy.

data class GetExtendedServerBlobAuditingPolicyResult(val auditActionsAndGroups: List<String>? = null, val id: String, val isAzureMonitorTargetEnabled: Boolean? = null, val isDevopsAuditEnabled: Boolean? = null, val isManagedIdentityInUse: Boolean? = null, val isStorageSecondaryKeyInUse: Boolean? = null, val name: String, val predicateExpression: String? = null, val queueDelayMs: Int? = null, val retentionDays: Int? = null, val state: String, val storageAccountSubscriptionId: String? = null, val storageEndpoint: String? = null, val type: String)

An extended server blob auditing policy.

Link copied to clipboard
data class GetFailoverGroupResult(val databases: List<String>? = null, val id: String, val location: String, val name: String, val partnerServers: List<PartnerInfoResponse>, val readOnlyEndpoint: FailoverGroupReadOnlyEndpointResponse? = null, val readWriteEndpoint: FailoverGroupReadWriteEndpointResponse, val replicationRole: String, val replicationState: String, val tags: Map<String, String>? = null, val type: String)

A failover group.

Link copied to clipboard
data class GetFirewallRuleResult(val endIpAddress: String? = null, val id: String, val name: String? = null, val startIpAddress: String? = null, val type: String)

A server firewall rule.

Link copied to clipboard
data class GetGeoBackupPolicyResult(val id: String, val kind: String, val location: String, val name: String, val state: String, val storageType: String, val type: String)

A Geo backup policy.

Link copied to clipboard
data class GetInstanceFailoverGroupResult(val id: String, val managedInstancePairs: List<ManagedInstancePairInfoResponse>, val name: String, val partnerRegions: List<PartnerRegionInfoResponse>, val readOnlyEndpoint: InstanceFailoverGroupReadOnlyEndpointResponse? = null, val readWriteEndpoint: InstanceFailoverGroupReadWriteEndpointResponse, val replicationRole: String, val replicationState: String, val type: String)

An instance failover group.

Link copied to clipboard
data class GetInstancePoolResult(val id: String, val licenseType: String, val location: String, val name: String, val sku: SkuResponse? = null, val subnetId: String, val tags: Map<String, String>? = null, val type: String, val vCores: Int)

An Azure SQL instance pool.

Link copied to clipboard
data class GetIPv6FirewallRuleResult(val endIPv6Address: String? = null, val id: String, val name: String? = null, val startIPv6Address: String? = null, val type: String)

An IPv6 server firewall rule.

Link copied to clipboard
data class GetJobAgentResult(val databaseId: String, val id: String, val location: String, val name: String, val sku: SkuResponse? = null, val state: String, val tags: Map<String, String>? = null, val type: String)

An Azure SQL job agent.

Link copied to clipboard
data class GetJobCredentialResult(val id: String, val name: String, val type: String, val username: String)

A stored credential that can be used by a job to connect to target databases.

Link copied to clipboard
data class GetJobPrivateEndpointResult(val id: String, val name: String, val privateEndpointId: String, val targetServerAzureResourceId: String, val type: String)

A job agent private endpoint.

Link copied to clipboard
data class GetJobResult(val description: String? = null, val id: String, val name: String, val schedule: JobScheduleResponse? = null, val type: String, val version: Int)

A job.

Link copied to clipboard
data class GetJobStepResult(val action: JobStepActionResponse, val credential: String, val executionOptions: JobStepExecutionOptionsResponse? = null, val id: String, val name: String, val output: JobStepOutputResponse? = null, val stepId: Int? = null, val targetGroup: String, val type: String)

A job step.

Link copied to clipboard
data class GetJobTargetGroupResult(val id: String, val members: List<JobTargetResponse>, val name: String, val type: String)

A group of job targets.

Link copied to clipboard
data class GetLongTermRetentionPolicyResult(val id: String, val monthlyRetention: String? = null, val name: String, val type: String, val weekOfYear: Int? = null, val weeklyRetention: String? = null, val yearlyRetention: String? = null)

A long term retention policy.

Link copied to clipboard
data class GetManagedDatabaseResult(val catalogCollation: String? = null, val collation: String? = null, val creationDate: String, val defaultSecondaryLocation: String, val earliestRestorePoint: String, val failoverGroupId: String, val id: String, val location: String, val name: String, val status: String, val tags: Map<String, String>? = null, val type: String)

A managed database resource.

Link copied to clipboard
data class GetManagedDatabaseSensitivityLabelResult(val columnName: String, val id: String, val informationType: String? = null, val informationTypeId: String? = null, val isDisabled: Boolean, val labelId: String? = null, val labelName: String? = null, val managedBy: String, val name: String, val rank: String? = null, val schemaName: String, val tableName: String, val type: String)

A sensitivity label.

A database vulnerability assessment.

A database vulnerability assessment rule baseline.

Link copied to clipboard
data class GetManagedInstanceAdministratorResult(val administratorType: String, val id: String, val login: String, val name: String, val sid: String, val tenantId: String? = null, val type: String)

An Azure SQL managed instance administrator.

data class GetManagedInstanceAzureADOnlyAuthenticationResult(val azureADOnlyAuthentication: Boolean, val id: String, val name: String, val type: String)

Azure Active Directory only authentication.

Link copied to clipboard
data class GetManagedInstanceKeyResult(val autoRotationEnabled: Boolean, val creationDate: String, val id: String, val kind: String, val name: String, val thumbprint: String, val type: String)

A managed instance key.

data class GetManagedInstanceLongTermRetentionPolicyResult(val id: String, val monthlyRetention: String? = null, val name: String, val type: String, val weekOfYear: Int? = null, val weeklyRetention: String? = null, val yearlyRetention: String? = null)

A long term retention policy.

data class GetManagedInstancePrivateEndpointConnectionResult(val id: String, val name: String, val privateEndpoint: ManagedInstancePrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse? = null, val provisioningState: String, val type: String)

A private endpoint connection

Link copied to clipboard
data class GetManagedInstanceResult(val administratorLogin: String? = null, val administrators: ManagedInstanceExternalAdministratorResponse? = null, val collation: String? = null, val currentBackupStorageRedundancy: String, val dnsZone: String, val fullyQualifiedDomainName: String, val id: String, val identity: ResourceIdentityResponse? = null, val instancePoolId: String? = null, val keyId: String? = null, val licenseType: String? = null, val location: String, val maintenanceConfigurationId: String? = null, val minimalTlsVersion: String? = null, val name: String, val primaryUserAssignedIdentityId: String? = null, val privateEndpointConnections: List<ManagedInstancePecPropertyResponse>, val provisioningState: String, val proxyOverride: String? = null, val publicDataEndpointEnabled: Boolean? = null, val requestedBackupStorageRedundancy: String? = null, val servicePrincipal: ServicePrincipalResponse? = null, val sku: SkuResponse? = null, val state: String, val storageSizeInGB: Int? = null, val subnetId: String? = null, val tags: Map<String, String>? = null, val timezoneId: String? = null, val type: String, val vCores: Int? = null, val zoneRedundant: Boolean? = null)

An Azure SQL managed instance.

A managed instance vulnerability assessment.

Link copied to clipboard
data class GetManagedServerDnsAliasResult(val azureDnsRecord: String, val id: String, val name: String, val publicAzureDnsRecord: String, val type: String)

A managed server DNS alias.

Link copied to clipboard
data class GetOutboundFirewallRuleResult(val id: String, val name: String, val provisioningState: String, val type: String)

An Azure SQL DB Server Outbound Firewall Rule.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val groupIds: List<String>, val id: String, val name: String, val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse? = null, val provisioningState: String, val type: String)

A private endpoint connection

Link copied to clipboard
data class GetReplicationLinkResult(val id: String, val isTerminationAllowed: Boolean, val linkType: String? = null, val name: String, val partnerDatabase: String, val partnerDatabaseId: String, val partnerLocation: String, val partnerRole: String, val partnerServer: String, val percentComplete: Int, val replicationMode: String, val replicationState: String, val role: String, val startTime: String, val type: String)

A replication link.

Link copied to clipboard
data class GetSensitivityLabelResult(val columnName: String, val id: String, val informationType: String? = null, val informationTypeId: String? = null, val isDisabled: Boolean, val labelId: String? = null, val labelName: String? = null, val managedBy: String, val name: String, val rank: String? = null, val schemaName: String, val tableName: String, val type: String)

A sensitivity label.

Link copied to clipboard
data class GetServerAdvisorResult(val advisorStatus: String, val autoExecuteStatus: String, val autoExecuteStatusInheritedFrom: String, val id: String, val kind: String, val lastChecked: String, val location: String, val name: String, val recommendationsStatus: String, val recommendedActions: List<RecommendedActionResponse>, val type: String)

Database, Server or Elastic Pool Advisor.

Link copied to clipboard
data class GetServerAzureADAdministratorResult(val administratorType: String, val azureADOnlyAuthentication: Boolean, val id: String, val login: String, val name: String, val sid: String, val tenantId: String? = null, val type: String)

Azure Active Directory administrator.

Link copied to clipboard
data class GetServerAzureADOnlyAuthenticationResult(val azureADOnlyAuthentication: Boolean, val id: String, val name: String, val type: String)

Azure Active Directory only authentication.

Link copied to clipboard
data class GetServerBlobAuditingPolicyResult(val auditActionsAndGroups: List<String>? = null, val id: String, val isAzureMonitorTargetEnabled: Boolean? = null, val isDevopsAuditEnabled: Boolean? = null, val isManagedIdentityInUse: Boolean? = null, val isStorageSecondaryKeyInUse: Boolean? = null, val name: String, val queueDelayMs: Int? = null, val retentionDays: Int? = null, val state: String, val storageAccountSubscriptionId: String? = null, val storageEndpoint: String? = null, val type: String)

A server blob auditing policy.

Link copied to clipboard
data class GetServerCommunicationLinkResult(val id: String, val kind: String, val location: String, val name: String, val partnerServer: String, val state: String, val type: String)

Server communication link.

Link copied to clipboard
data class GetServerDnsAliasResult(val azureDnsRecord: String, val id: String, val name: String, val type: String)

A server DNS alias.

Link copied to clipboard
data class GetServerKeyResult(val autoRotationEnabled: Boolean, val creationDate: String, val id: String, val kind: String, val location: String, val name: String, val subregion: String, val thumbprint: String, val type: String)

A server key.

Link copied to clipboard
data class GetServerResult(val administratorLogin: String? = null, val administrators: ServerExternalAdministratorResponse? = null, val federatedClientId: String? = null, val fullyQualifiedDomainName: String, val id: String, val identity: ResourceIdentityResponse? = null, val keyId: String? = null, val kind: String, val location: String, val minimalTlsVersion: String? = null, val name: String, val primaryUserAssignedIdentityId: String? = null, val privateEndpointConnections: List<ServerPrivateEndpointConnectionResponse>, val publicNetworkAccess: String? = null, val restrictOutboundNetworkAccess: String? = null, val state: String, val tags: Map<String, String>? = null, val type: String, val version: String? = null, val workspaceFeature: String)

An Azure SQL Database server.

Link copied to clipboard
data class GetServerSecurityAlertPolicyResult(val creationTime: 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 systemData: SystemDataResponse, val type: String)

A server security alert policy.

Link copied to clipboard
data class GetServerTrustCertificateResult(val certificateName: String, val id: String, val name: String, val publicBlob: String? = null, val thumbprint: String, val type: String)

Server trust certificate imported from box to enable connection between box and Sql Managed Instance.

Link copied to clipboard
data class GetServerTrustGroupResult(val groupMembers: List<ServerInfoResponse>, val id: String, val name: String, val trustScopes: List<String>, val type: String)

A server trust group.

Link copied to clipboard
data class GetServerVulnerabilityAssessmentResult(val id: String, val name: String, val recurringScans: VulnerabilityAssessmentRecurringScansPropertiesResponse? = null, val type: String)

A server vulnerability assessment.

data class GetSqlVulnerabilityAssessmentRuleBaselineResult(val id: String, val name: String, val results: List<List<String>>, val systemData: SystemDataResponse, val type: String)

A database sql vulnerability assessment rule baseline.

data class GetSqlVulnerabilityAssessmentsSettingResult(val id: String, val name: String, val state: String? = null, val systemData: SystemDataResponse, val type: String)

A SQL Vulnerability Assessment.

data class GetStartStopManagedInstanceScheduleResult(val description: String? = null, val id: String, val name: String, val nextExecutionTime: String, val nextRunAction: String, val scheduleList: List<ScheduleItemResponse>, val systemData: SystemDataResponse, val timeZoneId: String? = null, val type: String)

Managed instance's Start/Stop schedule.

Link copied to clipboard
data class GetSyncAgentResult(val expiryTime: String, val id: String, val isUpToDate: Boolean, val lastAliveTime: String, val name: String, val state: String, val syncDatabaseId: String? = null, val type: String, val version: String)

An Azure SQL Database sync agent.

Link copied to clipboard
data class GetSyncGroupResult(val conflictLoggingRetentionInDays: Int? = null, val conflictResolutionPolicy: String? = null, val enableConflictLogging: Boolean? = null, val hubDatabaseUserName: String? = null, val id: String, val interval: Int? = null, val lastSyncTime: String, val name: String, val privateEndpointName: String, val schema: SyncGroupSchemaResponse? = null, val sku: SkuResponse? = null, val syncDatabaseId: String? = null, val syncState: String, val type: String, val usePrivateLinkConnection: Boolean? = null)

An Azure SQL Database sync group.

Link copied to clipboard
data class GetSyncMemberResult(val databaseName: String? = null, val databaseType: String? = null, val id: String, val name: String, val privateEndpointName: String, val serverName: String? = null, val sqlServerDatabaseId: String? = null, val syncAgentId: String? = null, val syncDirection: String? = null, val syncMemberAzureDatabaseResourceId: String? = null, val syncState: String, val type: String, val usePrivateLinkConnection: Boolean? = null, val userName: String? = null)

An Azure SQL Database sync member.

Link copied to clipboard
data class GetTransparentDataEncryptionResult(val id: String, val name: String, val state: String, val type: String)

A logical database transparent data encryption state.

Link copied to clipboard
data class GetVirtualNetworkRuleResult(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 GetWorkloadClassifierResult(val context: String? = null, val endTime: String? = null, val id: String, val importance: String? = null, val label: String? = null, val memberName: String, val name: String, val startTime: String? = null, val type: String)

Workload classifier operations for a data warehouse

Link copied to clipboard
data class GetWorkloadGroupResult(val id: String, val importance: String? = null, val maxResourcePercent: Int, val maxResourcePercentPerRequest: Double? = null, val minResourcePercent: Int, val minResourcePercentPerRequest: Double, val name: String, val queryExecutionTimeout: Int? = null, val type: String)

Workload group operations for a data warehouse

data class InstanceFailoverGroupReadOnlyEndpointResponse(val failoverPolicy: String? = null)

Read-only endpoint of the failover group instance.

data class InstanceFailoverGroupReadWriteEndpointResponse(val failoverPolicy: String, val failoverWithDataLossGracePeriodMinutes: Int? = null)

Read-write endpoint of the failover group instance.

Link copied to clipboard
data class JobScheduleResponse(val enabled: Boolean? = null, val endTime: String? = null, val interval: String? = null, val startTime: String? = null, val type: String? = null)

Scheduling properties of a job.

Link copied to clipboard
data class JobStepActionResponse(val source: String? = null, val type: String? = null, val value: String)

The action to be executed by a job step.

Link copied to clipboard
data class JobStepExecutionOptionsResponse(val initialRetryIntervalSeconds: Int? = null, val maximumRetryIntervalSeconds: Int? = null, val retryAttempts: Int? = null, val retryIntervalBackoffMultiplier: Double? = null, val timeoutSeconds: Int? = null)

The execution options of a job step.

Link copied to clipboard
data class JobStepOutputResponse(val credential: String, val databaseName: String, val resourceGroupName: String? = null, val schemaName: String? = null, val serverName: String, val subscriptionId: String? = null, val tableName: String, val type: String? = null)

The output configuration of a job step.

Link copied to clipboard
data class JobTargetResponse(val databaseName: String? = null, val elasticPoolName: String? = null, val membershipType: String? = null, val refreshCredential: String? = null, val serverName: String? = null, val shardMapName: String? = null, val type: String)

A job target, for example a specific database or a container of databases that is evaluated during job execution.

data class ManagedInstanceExternalAdministratorResponse(val administratorType: String? = null, val azureADOnlyAuthentication: Boolean? = null, val login: String? = null, val principalType: String? = null, val sid: String? = null, val tenantId: String? = null)

Properties of a active directory administrator.

Link copied to clipboard
data class ManagedInstancePairInfoResponse(val partnerManagedInstanceId: String? = null, val primaryManagedInstanceId: String? = null)

Pairs of Managed Instances in the failover group.

Link copied to clipboard

A private endpoint connection under a managed instance

data class ManagedInstancePrivateEndpointConnectionPropertiesResponse(val privateEndpoint: ManagedInstancePrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse? = null, val provisioningState: String)

Properties of a private endpoint connection.

Link copied to clipboard
data class PartnerInfoResponse(val id: String, val location: String, val replicationRole: String)

Partner server information for the failover group.

Link copied to clipboard
data class PartnerRegionInfoResponse(val location: String? = null, val replicationRole: String)

Partner region information for the failover group.

data class PrivateEndpointConnectionPropertiesResponse(val groupIds: List<String>, val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse? = null, val provisioningState: String)

Properties of a private endpoint connection.

Link copied to clipboard
data class PrivateEndpointPropertyResponse(val id: String? = null)
data class PrivateLinkServiceConnectionStatePropertyResponse(val actionsRequired: String, val description: String, val status: String)
Link copied to clipboard
data class RecommendedActionErrorInfoResponse(val errorCode: String, val isRetryable: String)

Contains error information for an Azure SQL Database, Server or Elastic Pool Recommended Action.

Link copied to clipboard
data class RecommendedActionImpactRecordResponse(val absoluteValue: Double, val changeValueAbsolute: Double, val changeValueRelative: Double, val dimensionName: String, val unit: String)

Contains information of estimated or observed impact on various metrics for an Azure SQL Database, Server or Elastic Pool Recommended Action.

data class RecommendedActionImplementationInfoResponse(val method: String, val script: String)

Contains information for manual implementation for an Azure SQL Database, Server or Elastic Pool Recommended Action.

Link copied to clipboard
data class RecommendedActionMetricInfoResponse(val metricName: String, val startTime: String, val timeGrain: String, val unit: String, val value: Double)

Contains time series of various impacted metrics for an Azure SQL Database, Server or Elastic Pool Recommended Action.

Link copied to clipboard
data class RecommendedActionResponse(val details: Map<String, Any>, val errorDetails: RecommendedActionErrorInfoResponse, val estimatedImpact: List<RecommendedActionImpactRecordResponse>, val executeActionDuration: String, val executeActionInitiatedBy: String, val executeActionInitiatedTime: String, val executeActionStartTime: String, val id: String, val implementationDetails: RecommendedActionImplementationInfoResponse, val isArchivedAction: Boolean, val isExecutableAction: Boolean, val isRevertableAction: Boolean, val kind: String, val lastRefresh: String, val linkedObjects: List<String>, val location: String, val name: String, val observedImpact: List<RecommendedActionImpactRecordResponse>, val recommendationReason: String, val revertActionDuration: String, val revertActionInitiatedBy: String, val revertActionInitiatedTime: String, val revertActionStartTime: String, val score: Int, val state: RecommendedActionStateInfoResponse, val timeSeries: List<RecommendedActionMetricInfoResponse>, val type: String, val validSince: String)

Database, Server or Elastic Pool Recommended Action.

Link copied to clipboard
data class RecommendedActionStateInfoResponse(val actionInitiatedBy: String, val currentValue: String, val lastModified: String)

Contains information of current state for an Azure SQL Database, Server or Elastic Pool Recommended Action.

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

Azure Active Directory identity configuration for a resource.

Link copied to clipboard
data class ScheduleItemResponse(val startDay: String, val startTime: String, val stopDay: String, val stopTime: String)

Schedule info describing when the server should be started or stopped.

Link copied to clipboard
data class ServerExternalAdministratorResponse(val administratorType: String? = null, val azureADOnlyAuthentication: Boolean? = null, val login: String? = null, val principalType: String? = null, val sid: String? = null, val tenantId: String? = null)

Properties of a active directory administrator.

Link copied to clipboard
data class ServerInfoResponse(val serverId: String)

Server info for the server trust group.

Link copied to clipboard

A private endpoint connection under a server

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

The managed instance's service principal configuration for a resource.

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

An ARM Resource SKU.

Link copied to clipboard
data class SyncGroupSchemaResponse(val masterSyncMemberName: String? = null, val tables: List<SyncGroupSchemaTableResponse>? = null)

Properties of sync group schema.

Link copied to clipboard
data class SyncGroupSchemaTableColumnResponse(val dataSize: String? = null, val dataType: String? = null, val quotedName: String? = null)

Properties of column in sync group table.

Link copied to clipboard
data class SyncGroupSchemaTableResponse(val columns: List<SyncGroupSchemaTableColumnResponse>? = null, val quotedName: String? = null)

Properties of table in sync group schema.

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 UserIdentityResponse(val clientId: String, val principalId: String)

Azure Active Directory identity configuration for a resource.

data class VulnerabilityAssessmentRecurringScansPropertiesResponse(val emailSubscriptionAdmins: Boolean? = null, val emails: List<String>? = null, val isEnabled: Boolean? = null)

Properties of a Vulnerability Assessment recurring scans.