azure.mgmt.sql.models module¶

class azure.mgmt.sql.models.AdministratorListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of active directory administrators.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ServerAzureADAdministrator]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.AutoPauseDelayTimeRange(**kwargs)[source]¶

Bases: msrest.serialization.Model

Supported auto pause delay time range.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

min_value (int) – Minimum value.
max_value (int) – Maximum value.
step_size (int) – Step value for discrete values between the minimum value and the maximum value.
default (int) – Default value is no value is provided.
unit (str or PauseDelayTimeUnit) – Unit of time that delay is expressed in. Possible values include: “Minutes”.
do_not_pause_value (int) – Value that is used to not pause (infinite delay before pause).

class azure.mgmt.sql.models.AutomaticTuningOptions(*, desired_state: Union[str, AutomaticTuningOptionModeDesired, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Automatic tuning properties for individual advisors.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

desired_state (str or AutomaticTuningOptionModeDesired) – Automatic tuning option desired state. Possible values include: “Off”, “On”, “Default”.

Variables

actual_state (str or AutomaticTuningOptionModeActual) – Automatic tuning option actual state. Possible values include: “Off”, “On”.
reason_code (int) – Reason code if desired and actual state are different.
reason_desc (str or AutomaticTuningDisabledReason) – Reason description if desired and actual state are different. Possible values include: “Default”, “Disabled”, “AutoConfigured”, “InheritedFromServer”, “QueryStoreOff”, “QueryStoreReadOnly”, “NotSupported”.

class azure.mgmt.sql.models.AutomaticTuningServerOptions(*, desired_state: Union[str, AutomaticTuningOptionModeDesired, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Automatic tuning properties for individual advisors.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

desired_state (str or AutomaticTuningOptionModeDesired) – Automatic tuning option desired state. Possible values include: “Off”, “On”, “Default”.

Variables

actual_state (str or AutomaticTuningOptionModeActual) – Automatic tuning option actual state. Possible values include: “Off”, “On”.
reason_code (int) – Reason code if desired and actual state are different.
reason_desc (str or AutomaticTuningServerReason) – Reason description if desired and actual state are different. Possible values include: “Default”, “Disabled”, “AutoConfigured”.

class azure.mgmt.sql.models.AzureADOnlyAuthListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of active directory only authentications.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ServerAzureADOnlyAuthentication]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.BackupLongTermRetentionPolicy(*, weekly_retention: Optional[str] = None, monthly_retention: Optional[str] = None, yearly_retention: Optional[str] = None, week_of_year: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A long term retention policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

weekly_retention (str) – The weekly retention policy for an LTR backup in an ISO 8601 format.
monthly_retention (str) – The monthly retention policy for an LTR backup in an ISO 8601 format.
yearly_retention (str) – The yearly retention policy for an LTR backup in an ISO 8601 format.
week_of_year (int) – The week of year to take the yearly backup in an ISO 8601 format.

class azure.mgmt.sql.models.BackupShortTermRetentionPolicy(*, retention_days: Optional[int] = None, diff_backup_interval_in_hours: Union[int, DiffBackupIntervalInHours, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A short term retention policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
diff_backup_interval_in_hours (str or DiffBackupIntervalInHours) – The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases. Possible values include: 12, 24.

class azure.mgmt.sql.models.BackupShortTermRetentionPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of short term retention policies.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[BackupShortTermRetentionPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.CheckNameAvailabilityRequest(*, name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

A request to check whether the specified name for a resource is available.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters: name (str) – Required.
Variables: type (str) – Required. Default value: “Microsoft.Sql/servers”.

type = 'Microsoft.Sql/servers'¶

class azure.mgmt.sql.models.CheckNameAvailabilityResponse(**kwargs)[source]¶

Bases: msrest.serialization.Model

The result of a name availability check.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The name whose availability was checked.
available (bool) – True if the name is available, otherwise false.
reason (str or CheckNameAvailabilityReason) – The reason code explaining why the name is unavailable. Will be undefined if the name is available. Possible values include: “Invalid”, “AlreadyExists”.
message (str) – A message explaining why the name is unavailable. Will be undefined if the name is available.

class azure.mgmt.sql.models.CompleteDatabaseRestoreDefinition(*, last_backup_name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains the information necessary to perform a complete database restore operation.

All required parameters must be populated in order to send to Azure.

Parameters: last_backup_name (str) – Required. The last backup name to apply.

class azure.mgmt.sql.models.CreateDatabaseRestorePointDefinition(*, restore_point_label: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains the information necessary to perform a create database restore point operation.

All required parameters must be populated in order to send to Azure.

Parameters: restore_point_label (str) – Required. The restore point label to apply.

class azure.mgmt.sql.models.DataMaskingPolicy(*, data_masking_state: Union[str, DataMaskingState, None] = None, exempt_principals: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a database data masking policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – The location of the data masking policy.
kind (str) – The kind of data masking policy. Metadata, used for Azure portal.
application_principals (str) – The list of the application principals. This is a legacy parameter and is no longer used.
masking_level (str) – The masking level. This is a legacy parameter and is no longer used.

Parameters

data_masking_state (str or DataMaskingState) – The state of the data masking policy. Possible values include: “Disabled”, “Enabled”.
exempt_principals (str) – The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.

class azure.mgmt.sql.models.DataMaskingRule(*, alias_name: Optional[str] = None, rule_state: Union[str, DataMaskingRuleState, None] = None, schema_name: Optional[str] = None, table_name: Optional[str] = None, column_name: Optional[str] = None, masking_function: Union[str, DataMaskingFunction, None] = None, number_from: Optional[str] = None, number_to: Optional[str] = None, prefix_size: Optional[str] = None, suffix_size: Optional[str] = None, replacement_string: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a database data masking rule.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – The location of the data masking rule.
kind (str) – The kind of Data Masking Rule. Metadata, used for Azure portal.
id_properties_id (str) – The rule Id.

Parameters

alias_name (str) – The alias name. This is a legacy parameter and is no longer used.
rule_state (str or DataMaskingRuleState) – The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn’t already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. Possible values include: “Disabled”, “Enabled”.
schema_name (str) – The schema name on which the data masking rule is applied.
table_name (str) – The table name on which the data masking rule is applied.
column_name (str) – The column name on which the data masking rule is applied.
masking_function (str or DataMaskingFunction) – The masking function that is used for the data masking rule. Possible values include: “Default”, “CCN”, “Email”, “Number”, “SSN”, “Text”.
number_from (str) – The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
number_to (str) – The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
prefix_size (str) – If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.
suffix_size (str) – If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.
replacement_string (str) – If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.

class azure.mgmt.sql.models.DataMaskingRuleListResult(*, value: Optional[List[DataMaskingRule]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list data masking rules request.

Parameters: value (list[DataMaskingRule]) – The list of database data masking rules.

class azure.mgmt.sql.models.Database(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, create_mode: Union[str, CreateMode, None] = None, collation: Optional[str] = None, max_size_bytes: Optional[int] = None, sample_name: Union[str, SampleName, None] = None, elastic_pool_id: Optional[str] = None, source_database_id: Optional[str] = None, restore_point_in_time: Optional[datetime.datetime] = None, source_database_deletion_date: Optional[datetime.datetime] = None, recovery_services_recovery_point_id: Optional[str] = None, long_term_retention_backup_resource_id: Optional[str] = None, recoverable_database_id: Optional[str] = None, restorable_dropped_database_id: Optional[str] = None, catalog_collation: Union[str, CatalogCollationType, None] = None, zone_redundant: Optional[bool] = None, license_type: Union[str, DatabaseLicenseType, None] = None, read_scale: Union[str, DatabaseReadScale, None] = None, read_replica_count: Optional[int] = None, auto_pause_delay: Optional[int] = None, min_capacity: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

A database resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Kind of database. This is metadata used for the Azure portal experience.
managed_by (str) – Resource that manages the database.
status (str or DatabaseStatus) – The status of the database. Possible values include: “Online”, “Restoring”, “RecoveryPending”, “Recovering”, “Suspect”, “Offline”, “Standby”, “Shutdown”, “EmergencyMode”, “AutoClosed”, “Copying”, “Creating”, “Inaccessible”, “OfflineSecondary”, “Pausing”, “Paused”, “Resuming”, “Scaling”, “OfflineChangingDwPerformanceTiers”, “OnlineChangingDwPerformanceTiers”, “Disabled”.
database_id (str) – The ID of the database.
creation_date (datetime) – The creation date of the database (ISO8601 format).
current_service_objective_name (str) – The current service level objective name of the database.
requested_service_objective_name (str) – The requested service level objective name of the database.
default_secondary_location (str) – The default secondary region for this database.
failover_group_id (str) – Failover Group resource identifier that this database belongs to.
max_log_size_bytes (long) – The max log size for this database.
earliest_restore_date (datetime) – This records the earliest start date and time that restore is available for this database (ISO8601 format).
current_sku (Sku) – The name and tier of the SKU.
paused_date (datetime) – The date when database was paused by user configuration or action (ISO8601 format). Null if the database is ready.
resumed_date (datetime) – The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
sku (Sku) –
The database SKU.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:
```
az sql db list-editions -l <location> -o table
`
```
```
Get-AzSqlServerServiceObjective -Location <location>
`.
```
create_mode (str or CreateMode) –
Specifies the mode of database creation.

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: “Default”, “Copy”, “Secondary”, “PointInTimeRestore”, “Restore”, “Recovery”, “RestoreExternalBackup”, “RestoreExternalBackupSecondary”, “RestoreLongTermRetentionBackup”, “OnlineSecondary”.
collation (str) – The collation of the database.
max_size_bytes (long) – The max size of the database expressed in bytes.
sample_name (str or SampleName) – The name of the sample schema to apply when creating this database. Possible values include: “AdventureWorksLT”, “WideWorldImportersStd”, “WideWorldImportersFull”.
elastic_pool_id (str) – The resource identifier of the elastic pool containing this database.
source_database_id (str) – The resource identifier of the source database associated with create operation of this database.
restore_point_in_time (datetime) – Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
source_database_deletion_date (datetime) – Specifies the time that the database was deleted.
recovery_services_recovery_point_id (str) – The resource identifier of the recovery point associated with create operation of this database.
long_term_retention_backup_resource_id (str) – The resource identifier of the long term retention backup associated with create operation of this database.
recoverable_database_id (str) – The resource identifier of the recoverable database associated with create operation of this database.
restorable_dropped_database_id (str) – The resource identifier of the restorable dropped database associated with create operation of this database.
catalog_collation (str or CatalogCollationType) – Collation of the metadata catalog. Possible values include: “DATABASE_DEFAULT”, “SQL_Latin1_General_CP1_CI_AS”.
zone_redundant (bool) – Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
license_type (str or DatabaseLicenseType) – The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit. Possible values include: “LicenseIncluded”, “BasePrice”.
read_scale (str or DatabaseReadScale) – If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases. Possible values include: “Enabled”, “Disabled”.
read_replica_count (int) – The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
auto_pause_delay (int) – Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled.
min_capacity (float) – Minimal capacity that database will always have allocated, if not paused.

class azure.mgmt.sql.models.DatabaseAutomaticTuning(*, desired_state: Union[str, AutomaticTuningMode, None] = None, options: Optional[Dict[str, AutomaticTuningOptions]] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Database-level Automatic Tuning.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
actual_state (str or AutomaticTuningMode) – Automatic tuning actual state. Possible values include: “Inherit”, “Custom”, “Auto”, “Unspecified”.

Parameters

desired_state (str or AutomaticTuningMode) – Automatic tuning desired state. Possible values include: “Inherit”, “Custom”, “Auto”, “Unspecified”.
options (dict[str, AutomaticTuningOptions]) – Automatic tuning options definition.

class azure.mgmt.sql.models.DatabaseBlobAuditingPolicy(*, state: Union[str, BlobAuditingPolicyState, None] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, audit_actions_and_groups: Optional[List[str]] = None, storage_account_subscription_id: Optional[str] = None, is_storage_secondary_key_in_use: Optional[bool] = None, is_azure_monitor_target_enabled: Optional[bool] = None, queue_delay_ms: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A database blob auditing policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Resource kind.

Parameters

state (str or BlobAuditingPolicyState) – Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: “Enabled”, “Disabled”.
storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
storage_account_access_key (str) –
Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication:
1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
#. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity.

For more information, see `Auditing to storage using Managed Identity authentication

<https://go.microsoft.com/fwlink/?linkid=2114355>`_.
retention_days (int) – Specifies the number of days to keep in the audit logs in the storage account.
audit_actions_and_groups (list[str]) –
Specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that <object> in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions.
storage_account_subscription_id (str) – Specifies the blob storage subscription Id.
is_storage_secondary_key_in_use (bool) – Specifies whether storageAccountAccessKey value is the storage’s secondary key.
is_azure_monitor_target_enabled (bool) –
Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘state’ as ‘Enabled’ and ‘isAzureMonitorTargetEnabled’ as true.

When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api- version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.
queue_delay_ms (int) – Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

class azure.mgmt.sql.models.DatabaseBlobAuditingPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of database auditing settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[DatabaseBlobAuditingPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of databases.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Database]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseOperation(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A database operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
database_name (str) – The name of the database the operation is being performed on.
operation (str) – The name of operation.
operation_friendly_name (str) – The friendly name of operation.
percent_complete (int) – The percentage of the operation completed.
server_name (str) – The name of the server.
start_time (datetime) – The operation start time.
state (str or ManagementOperationState) – The operation state. Possible values include: “Pending”, “InProgress”, “Succeeded”, “Failed”, “CancelInProgress”, “Cancelled”.
error_code (int) – The operation error code.
error_description (str) – The operation error description.
error_severity (int) – The operation error severity.
is_user_error (bool) – Whether or not the error is a user error.
estimated_completion_time (datetime) – The estimated completion time of the operation.
description (str) – The operation description.
is_cancellable (bool) – Whether the operation can be cancelled.

class azure.mgmt.sql.models.DatabaseOperationListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list database operations request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[DatabaseOperation]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseSecurityAlertPolicy(*, location: Optional[str] = None, state: Union[str, SecurityAlertPolicyState, None] = None, disabled_alerts: Optional[str] = None, email_addresses: Optional[str] = None, email_account_admins: Union[str, SecurityAlertPolicyEmailAccountAdmins, None] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, use_server_default: Union[str, SecurityAlertPolicyUseServerDefault, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Contains information about a database Threat Detection policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Resource kind.

Parameters

location (str) – The geo-location where the resource lives.
state (str or SecurityAlertPolicyState) – Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required. Possible values include: “New”, “Enabled”, “Disabled”.
disabled_alerts (str) – Specifies the semicolon-separated list of alerts that are disabled, or empty string to disable no alerts. Possible values: Sql_Injection; Sql_Injection_Vulnerability; Access_Anomaly; Data_Exfiltration; Unsafe_Action.
email_addresses (str) – Specifies the semicolon-separated list of e-mail addresses to which the alert is sent.
email_account_admins (str or SecurityAlertPolicyEmailAccountAdmins) – Specifies that the alert is sent to the account administrators. Possible values include: “Enabled”, “Disabled”.
storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. If state is Enabled, storageEndpoint is required.
storage_account_access_key (str) – Specifies the identifier key of the Threat Detection audit storage account. If state is Enabled, storageAccountAccessKey is required.
retention_days (int) – Specifies the number of days to keep in the Threat Detection audit logs.
use_server_default (str or SecurityAlertPolicyUseServerDefault) – Specifies whether to use the default server policy. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.sql.models.DatabaseUpdate(*, sku: Optional[Sku] = None, tags: Optional[Dict[str, str]] = None, create_mode: Union[str, CreateMode, None] = None, collation: Optional[str] = None, max_size_bytes: Optional[int] = None, sample_name: Union[str, SampleName, None] = None, elastic_pool_id: Optional[str] = None, source_database_id: Optional[str] = None, restore_point_in_time: Optional[datetime.datetime] = None, source_database_deletion_date: Optional[datetime.datetime] = None, recovery_services_recovery_point_id: Optional[str] = None, long_term_retention_backup_resource_id: Optional[str] = None, recoverable_database_id: Optional[str] = None, restorable_dropped_database_id: Optional[str] = None, catalog_collation: Union[str, CatalogCollationType, None] = None, zone_redundant: Optional[bool] = None, license_type: Union[str, DatabaseLicenseType, None] = None, read_scale: Union[str, DatabaseReadScale, None] = None, read_replica_count: Optional[int] = None, auto_pause_delay: Optional[int] = None, min_capacity: Optional[float] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A database resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

sku (Sku) – The name and tier of the SKU.
tags (dict[str, str]) – A set of tags. Resource tags.
create_mode (str or CreateMode) –
Specifies the mode of database creation.

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: “Default”, “Copy”, “Secondary”, “PointInTimeRestore”, “Restore”, “Recovery”, “RestoreExternalBackup”, “RestoreExternalBackupSecondary”, “RestoreLongTermRetentionBackup”, “OnlineSecondary”.
collation (str) – The collation of the database.
max_size_bytes (long) – The max size of the database expressed in bytes.
sample_name (str or SampleName) – The name of the sample schema to apply when creating this database. Possible values include: “AdventureWorksLT”, “WideWorldImportersStd”, “WideWorldImportersFull”.
elastic_pool_id (str) – The resource identifier of the elastic pool containing this database.
source_database_id (str) – The resource identifier of the source database associated with create operation of this database.
restore_point_in_time (datetime) – Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
source_database_deletion_date (datetime) – Specifies the time that the database was deleted.
recovery_services_recovery_point_id (str) – The resource identifier of the recovery point associated with create operation of this database.
long_term_retention_backup_resource_id (str) – The resource identifier of the long term retention backup associated with create operation of this database.
recoverable_database_id (str) – The resource identifier of the recoverable database associated with create operation of this database.
restorable_dropped_database_id (str) – The resource identifier of the restorable dropped database associated with create operation of this database.
catalog_collation (str or CatalogCollationType) – Collation of the metadata catalog. Possible values include: “DATABASE_DEFAULT”, “SQL_Latin1_General_CP1_CI_AS”.
zone_redundant (bool) – Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
license_type (str or DatabaseLicenseType) – The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit. Possible values include: “LicenseIncluded”, “BasePrice”.
read_scale (str or DatabaseReadScale) – If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases. Possible values include: “Enabled”, “Disabled”.
read_replica_count (int) – The number of readonly secondary replicas associated with the database to which readonly application intent connections may be routed. This property is only settable for Hyperscale edition databases.
auto_pause_delay (int) – Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled.
min_capacity (float) – Minimal capacity that database will always have allocated, if not paused.

Variables

status (str or DatabaseStatus) – The status of the database. Possible values include: “Online”, “Restoring”, “RecoveryPending”, “Recovering”, “Suspect”, “Offline”, “Standby”, “Shutdown”, “EmergencyMode”, “AutoClosed”, “Copying”, “Creating”, “Inaccessible”, “OfflineSecondary”, “Pausing”, “Paused”, “Resuming”, “Scaling”, “OfflineChangingDwPerformanceTiers”, “OnlineChangingDwPerformanceTiers”, “Disabled”.
database_id (str) – The ID of the database.
creation_date (datetime) – The creation date of the database (ISO8601 format).
current_service_objective_name (str) – The current service level objective name of the database.
requested_service_objective_name (str) – The requested service level objective name of the database.
default_secondary_location (str) – The default secondary region for this database.
failover_group_id (str) – Failover Group resource identifier that this database belongs to.
max_log_size_bytes (long) – The max log size for this database.
earliest_restore_date (datetime) – This records the earliest start date and time that restore is available for this database (ISO8601 format).
current_sku (Sku) – The name and tier of the SKU.
paused_date (datetime) – The date when database was paused by user configuration or action (ISO8601 format). Null if the database is ready.
resumed_date (datetime) – The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused.

class azure.mgmt.sql.models.DatabaseUsage(**kwargs)[source]¶

Bases: msrest.serialization.Model

The database usages.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The name of the usage metric.
resource_name (str) – The name of the resource.
display_name (str) – The usage metric display name.
current_value (float) – The current value of the usage metric.
limit (float) – The current limit of the usage metric.
unit (str) – The units of the usage metric.
next_reset_time (datetime) – The next reset time for the usage metric (ISO8601 format).

class azure.mgmt.sql.models.DatabaseUsageListResult(*, value: List[DatabaseUsage], **kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list database metrics request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[DatabaseUsage]) – Required. The list of database usages for the database.

class azure.mgmt.sql.models.DatabaseVulnerabilityAssessment(*, storage_container_path: Optional[str] = None, storage_container_sas_key: Optional[str] = None, storage_account_access_key: Optional[str] = None, recurring_scans: Optional[VulnerabilityAssessmentRecurringScansProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A database vulnerability assessment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

storage_container_path (str) – A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn’t set.
storage_container_sas_key (str) – A shared access signature (SAS Key) that has read and write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required.
storage_account_access_key (str) – Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required.
recurring_scans (VulnerabilityAssessmentRecurringScansProperties) – The recurring scans settings.

class azure.mgmt.sql.models.DatabaseVulnerabilityAssessmentListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of the database’s vulnerability assessments.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[DatabaseVulnerabilityAssessment]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseVulnerabilityAssessmentRuleBaseline(*, baseline_results: Optional[List[DatabaseVulnerabilityAssessmentRuleBaselineItem]] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A database vulnerability assessment rule baseline.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

baseline_results (list[DatabaseVulnerabilityAssessmentRuleBaselineItem]) – The rule baseline result.

class azure.mgmt.sql.models.DatabaseVulnerabilityAssessmentRuleBaselineItem(*, result: List[str], **kwargs)[source]¶

Bases: msrest.serialization.Model

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

All required parameters must be populated in order to send to Azure.

Parameters: result (list[str]) – Required. The rule baseline result.

class azure.mgmt.sql.models.DatabaseVulnerabilityAssessmentScansExport(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A database Vulnerability Assessment scan export resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
exported_report_location (str) – Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx).

class azure.mgmt.sql.models.EditionCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The edition capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The database edition name.
supported_service_level_objectives (list[ServiceObjectiveCapability]) – The list of supported service objectives for the edition.
zone_redundant (bool) – Whether or not zone redundancy is supported for the edition.
read_scale (ReadScaleCapability) – The read scale capability for the edition.
supported_storage_capabilities (list[StorageCapability]) – The list of supported storage capabilities for this edition.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ElasticPool(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, max_size_bytes: Optional[int] = None, per_database_settings: Optional[ElasticPoolPerDatabaseSettings] = None, zone_redundant: Optional[bool] = None, license_type: Union[str, ElasticPoolLicenseType, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

An elastic pool.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Kind of elastic pool. This is metadata used for the Azure portal experience.
state (str or ElasticPoolState) – The state of the elastic pool. Possible values include: “Creating”, “Ready”, “Disabled”.
creation_date (datetime) – The creation date of the elastic pool (ISO8601 format).

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
sku (Sku) –
The elastic pool SKU.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or the following command:
```
az sql elastic-pool list-editions -l <location> -o table
`.
```
max_size_bytes (long) – The storage limit for the database elastic pool in bytes.
per_database_settings (ElasticPoolPerDatabaseSettings) – The per database settings for the elastic pool.
zone_redundant (bool) – Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
license_type (str or ElasticPoolLicenseType) – The license type to apply for this elastic pool. Possible values include: “LicenseIncluded”, “BasePrice”.

class azure.mgmt.sql.models.ElasticPoolActivity(*, location: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents the activity on an elastic pool.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
end_time (datetime) – The time the operation finished (ISO8601 format).
error_code (int) – The error code if available.
error_message (str) – The error message if available.
error_severity (int) – The error severity if available.
operation (str) – The operation name.
operation_id (str) – The unique operation ID.
percent_complete (int) – The percentage complete if available.
requested_database_dtu_max (int) – The requested max DTU per database if available.
requested_database_dtu_min (int) – The requested min DTU per database if available.
requested_dtu (int) – The requested DTU for the pool if available.
requested_elastic_pool_name (str) – The requested name for the elastic pool if available.
requested_storage_limit_in_gb (long) – The requested storage limit for the pool in GB if available.
elastic_pool_name (str) – The name of the elastic pool.
server_name (str) – The name of the server the elastic pool is in.
start_time (datetime) – The time the operation started (ISO8601 format).
state (str) – The current state of the operation.
requested_storage_limit_in_mb (int) – The requested storage limit in MB.
requested_database_dtu_guarantee (int) – The requested per database DTU guarantee.
requested_database_dtu_cap (int) – The requested per database DTU cap.
requested_dtu_guarantee (int) – The requested DTU guarantee.

Parameters

location (str) – The geo-location where the resource lives.

class azure.mgmt.sql.models.ElasticPoolActivityListResult(*, value: List[ElasticPoolActivity], **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a list elastic pool activity request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[ElasticPoolActivity]) – Required. The list of elastic pool activities.

class azure.mgmt.sql.models.ElasticPoolDatabaseActivity(*, location: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents the activity on an elastic pool.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
database_name (str) – The database name.
end_time (datetime) – The time the operation finished (ISO8601 format).
error_code (int) – The error code if available.
error_message (str) – The error message if available.
error_severity (int) – The error severity if available.
operation (str) – The operation name.
operation_id (str) – The unique operation ID.
percent_complete (int) – The percentage complete if available.
requested_elastic_pool_name (str) – The name for the elastic pool the database is moving into if available.
current_elastic_pool_name (str) – The name of the current elastic pool the database is in if available.
current_service_objective (str) – The name of the current service objective if available.
requested_service_objective (str) – The name of the requested service objective if available.
server_name (str) – The name of the server the elastic pool is in.
start_time (datetime) – The time the operation started (ISO8601 format).
state (str) – The current state of the operation.

Parameters

location (str) – The geo-location where the resource lives.

class azure.mgmt.sql.models.ElasticPoolDatabaseActivityListResult(*, value: List[ElasticPoolDatabaseActivity], **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a list elastic pool database activity request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[ElasticPoolDatabaseActivity]) – Required. The list of elastic pool database activities.

class azure.mgmt.sql.models.ElasticPoolEditionCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The elastic pool edition capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The elastic pool edition name.
supported_elastic_pool_performance_levels (list[ElasticPoolPerformanceLevelCapability]) – The list of supported elastic pool DTU levels for the edition.
zone_redundant (bool) – Whether or not zone redundancy is supported for the edition.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ElasticPoolListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The result of an elastic pool list request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ElasticPool]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ElasticPoolOperation(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A elastic pool operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
elastic_pool_name (str) – The name of the elastic pool the operation is being performed on.
operation (str) – The name of operation.
operation_friendly_name (str) – The friendly name of operation.
percent_complete (int) – The percentage of the operation completed.
server_name (str) – The name of the server.
start_time (datetime) – The operation start time.
state (str) – The operation state.
error_code (int) – The operation error code.
error_description (str) – The operation error description.
error_severity (int) – The operation error severity.
is_user_error (bool) – Whether or not the error is a user error.
estimated_completion_time (datetime) – The estimated completion time of the operation.
description (str) – The operation description.
is_cancellable (bool) – Whether the operation can be cancelled.

class azure.mgmt.sql.models.ElasticPoolOperationListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list elastic pool operations request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ElasticPoolOperation]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ElasticPoolPerDatabaseMaxPerformanceLevelCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The max per-database performance level capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

limit (float) – The maximum performance level per database.
unit (str or PerformanceLevelUnit) – Unit type used to measure performance level. Possible values include: “DTU”, “VCores”.
supported_per_database_min_performance_levels (list[ElasticPoolPerDatabaseMinPerformanceLevelCapability]) – The list of supported min database performance levels.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ElasticPoolPerDatabaseMinPerformanceLevelCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The minimum per-database performance level capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

limit (float) – The minimum performance level per database.
unit (str or PerformanceLevelUnit) – Unit type used to measure performance level. Possible values include: “DTU”, “VCores”.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ElasticPoolPerDatabaseSettings(*, min_capacity: Optional[float] = None, max_capacity: Optional[float] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Per database settings of an elastic pool.

Parameters

min_capacity (float) – The minimum capacity all databases are guaranteed.
max_capacity (float) – The maximum capacity any one database can consume.

class azure.mgmt.sql.models.ElasticPoolPerformanceLevelCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The Elastic Pool performance level capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

performance_level (PerformanceLevelCapability) – The performance level for the pool.
sku (Sku) – The sku.
supported_license_types (list[LicenseTypeCapability]) – List of supported license types.
max_database_count (int) – The maximum number of databases supported.
included_max_size (MaxSizeCapability) – The included (free) max size for this performance level.
supported_max_sizes (list[MaxSizeRangeCapability]) – The list of supported max sizes.
supported_per_database_max_sizes (list[MaxSizeRangeCapability]) – The list of supported per database max sizes.
supported_per_database_max_performance_levels (list[ElasticPoolPerDatabaseMaxPerformanceLevelCapability]) – The list of supported per database max performance levels.
zone_redundant (bool) – Whether or not zone redundancy is supported for the performance level.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ElasticPoolUpdate(*, sku: Optional[Sku] = None, tags: Optional[Dict[str, str]] = None, max_size_bytes: Optional[int] = None, per_database_settings: Optional[ElasticPoolPerDatabaseSettings] = None, zone_redundant: Optional[bool] = None, license_type: Union[str, ElasticPoolLicenseType, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An elastic pool update.

Parameters

sku (Sku) – An ARM Resource SKU.
tags (dict[str, str]) – A set of tags. Resource tags.
max_size_bytes (long) – The storage limit for the database elastic pool in bytes.
per_database_settings (ElasticPoolPerDatabaseSettings) – The per database settings for the elastic pool.
zone_redundant (bool) – Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
license_type (str or ElasticPoolLicenseType) – The license type to apply for this elastic pool. Possible values include: “LicenseIncluded”, “BasePrice”.

class azure.mgmt.sql.models.EncryptionProtector(*, server_key_name: Optional[str] = None, server_key_type: Union[str, ServerKeyType, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

The server encryption protector.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Kind of encryption protector. This is metadata used for the Azure portal experience.
location (str) – Resource location.
subregion (str) – Subregion of the encryption protector.
uri (str) – The URI of the server key.
thumbprint (str) – Thumbprint of the server key.

Parameters

server_key_name (str) – The name of the server key.
server_key_type (str or ServerKeyType) – The encryption protector type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: “ServiceManaged”, “AzureKeyVault”.

class azure.mgmt.sql.models.EncryptionProtectorListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of server encryption protectors.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[EncryptionProtector]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ExportRequest(*, storage_key_type: Union[str, StorageKeyType], storage_key: str, storage_uri: str, administrator_login: str, administrator_login_password: str, authentication_type: Union[str, AuthenticationType, None] = 'SQL', **kwargs)[source]¶

Bases: msrest.serialization.Model

Export database parameters.

All required parameters must be populated in order to send to Azure.

Parameters

storage_key_type (str or StorageKeyType) – Required. The type of the storage key to use. Possible values include: “StorageAccessKey”, “SharedAccessKey”.
storage_key (str) – Required. The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a “?.”.
storage_uri (str) – Required. The storage uri to use.
administrator_login (str) – Required. The name of the SQL administrator.
administrator_login_password (str) – Required. The password of the SQL administrator.
authentication_type (str or AuthenticationType) – The authentication type. Possible values include: “SQL”, “ADPassword”. Default value: “SQL”.

class azure.mgmt.sql.models.ExtendedDatabaseBlobAuditingPolicy(*, predicate_expression: Optional[str] = None, state: Union[str, BlobAuditingPolicyState, None] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, audit_actions_and_groups: Optional[List[str]] = None, storage_account_subscription_id: Optional[str] = None, is_storage_secondary_key_in_use: Optional[bool] = None, is_azure_monitor_target_enabled: Optional[bool] = None, queue_delay_ms: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An extended database blob auditing policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

predicate_expression (str) – Specifies condition of where clause when creating an audit.
state (str or BlobAuditingPolicyState) – Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: “Enabled”, “Disabled”.
storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
storage_account_access_key (str) –
Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication:
1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
#. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity.

For more information, see `Auditing to storage using Managed Identity authentication

<https://go.microsoft.com/fwlink/?linkid=2114355>`_.
retention_days (int) – Specifies the number of days to keep in the audit logs in the storage account.
audit_actions_and_groups (list[str]) –
Specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that <object> in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions.
storage_account_subscription_id (str) – Specifies the blob storage subscription Id.
is_storage_secondary_key_in_use (bool) – Specifies whether storageAccountAccessKey value is the storage’s secondary key.
is_azure_monitor_target_enabled (bool) –
Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘state’ as ‘Enabled’ and ‘isAzureMonitorTargetEnabled’ as true.

When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api- version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.
queue_delay_ms (int) – Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

class azure.mgmt.sql.models.ExtendedDatabaseBlobAuditingPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of database extended auditing settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ExtendedDatabaseBlobAuditingPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ExtendedServerBlobAuditingPolicy(*, predicate_expression: Optional[str] = None, state: Union[str, BlobAuditingPolicyState, None] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, audit_actions_and_groups: Optional[List[str]] = None, storage_account_subscription_id: Optional[str] = None, is_storage_secondary_key_in_use: Optional[bool] = None, is_azure_monitor_target_enabled: Optional[bool] = None, queue_delay_ms: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An extended server blob auditing policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

predicate_expression (str) – Specifies condition of where clause when creating an audit.
state (str or BlobAuditingPolicyState) – Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: “Enabled”, “Disabled”.
storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
storage_account_access_key (str) –
Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication:
1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
#. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity.

For more information, see `Auditing to storage using Managed Identity authentication

<https://go.microsoft.com/fwlink/?linkid=2114355>`_.
retention_days (int) – Specifies the number of days to keep in the audit logs in the storage account.
audit_actions_and_groups (list[str]) –
Specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that <object> in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions.
storage_account_subscription_id (str) – Specifies the blob storage subscription Id.
is_storage_secondary_key_in_use (bool) – Specifies whether storageAccountAccessKey value is the storage’s secondary key.
is_azure_monitor_target_enabled (bool) –
Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘state’ as ‘Enabled’ and ‘isAzureMonitorTargetEnabled’ as true.

When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api- version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.
queue_delay_ms (int) – Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

class azure.mgmt.sql.models.ExtendedServerBlobAuditingPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of server extended auditing settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ExtendedServerBlobAuditingPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.FailoverGroup(*, tags: Optional[Dict[str, str]] = None, read_write_endpoint: Optional[FailoverGroupReadWriteEndpoint] = None, read_only_endpoint: Optional[FailoverGroupReadOnlyEndpoint] = None, partner_servers: Optional[List[PartnerInfo]] = None, databases: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A failover group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location.
replication_role (str or FailoverGroupReplicationRole) – Local replication role of the failover group instance. Possible values include: “Primary”, “Secondary”.
replication_state (str) – Replication state of the failover group instance.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.
read_write_endpoint (FailoverGroupReadWriteEndpoint) – Read-write endpoint of the failover group instance.
read_only_endpoint (FailoverGroupReadOnlyEndpoint) – Read-only endpoint of the failover group instance.
partner_servers (list[PartnerInfo]) – List of partner server information for the failover group.
databases (list[str]) – List of databases in the failover group.

class azure.mgmt.sql.models.FailoverGroupListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of failover groups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[FailoverGroup]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.FailoverGroupReadOnlyEndpoint(*, failover_policy: Union[str, ReadOnlyEndpointFailoverPolicy, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Read-only endpoint of the failover group instance.

Parameters: failover_policy (str or ReadOnlyEndpointFailoverPolicy) – Failover policy of the read-only endpoint for the failover group. Possible values include: “Disabled”, “Enabled”.

class azure.mgmt.sql.models.FailoverGroupReadWriteEndpoint(*, failover_policy: Union[str, ReadWriteEndpointFailoverPolicy], failover_with_data_loss_grace_period_minutes: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Read-write endpoint of the failover group instance.

All required parameters must be populated in order to send to Azure.

Parameters

failover_policy (str or ReadWriteEndpointFailoverPolicy) – Required. Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. Possible values include: “Manual”, “Automatic”.
failover_with_data_loss_grace_period_minutes (int) – Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

class azure.mgmt.sql.models.FailoverGroupUpdate(*, tags: Optional[Dict[str, str]] = None, read_write_endpoint: Optional[FailoverGroupReadWriteEndpoint] = None, read_only_endpoint: Optional[FailoverGroupReadOnlyEndpoint] = None, databases: Optional[List[str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A failover group update request.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.
read_write_endpoint (FailoverGroupReadWriteEndpoint) – Read-write endpoint of the failover group instance.
read_only_endpoint (FailoverGroupReadOnlyEndpoint) – Read-only endpoint of the failover group instance.
databases (list[str]) – List of databases in the failover group.

class azure.mgmt.sql.models.FirewallRule(*, start_ip_address: Optional[str] = None, end_ip_address: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a server firewall rule.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Kind of server that contains this firewall rule.
location (str) – Location of the server that contains this firewall rule.

Parameters

start_ip_address (str) – The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ to represent all Azure-internal IP addresses.
end_ip_address (str) – The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ to represent all Azure-internal IP addresses.

class azure.mgmt.sql.models.FirewallRuleListResult(*, value: Optional[List[FirewallRule]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a List Firewall Rules request.

Parameters: value (list[FirewallRule]) – The list of server firewall rules.

class azure.mgmt.sql.models.GeoBackupPolicy(*, state: Union[str, GeoBackupPolicyState], **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A database geo backup policy.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Kind of geo backup policy. This is metadata used for the Azure portal experience.
location (str) – Backup policy location.
storage_type (str) – The storage type of the geo backup policy.

Parameters

state (str or GeoBackupPolicyState) – Required. The state of the geo backup policy. Possible values include: “Disabled”, “Enabled”.

class azure.mgmt.sql.models.GeoBackupPolicyListResult(*, value: Optional[List[GeoBackupPolicy]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list geo backup policies request.

Parameters: value (list[GeoBackupPolicy]) – The list of geo backup policies.

class azure.mgmt.sql.models.ImportExportResponse(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Response for Import/Export Get operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
request_type (str) – The request type of the operation.
request_id (str) – The request type of the operation.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
status (str) – The status message returned from the server.
last_modified_time (str) – The operation status last modified time.
queued_time (str) – The operation queued time.
blob_uri (str) – The blob uri.
error_message (str) – The error message returned from the server.

class azure.mgmt.sql.models.ImportExtensionProperties(*, storage_key_type: Union[str, StorageKeyType], storage_key: str, storage_uri: str, administrator_login: str, administrator_login_password: str, authentication_type: Union[str, AuthenticationType, None] = 'SQL', **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.ExportRequest

Represents the properties for an import operation.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

storage_key_type (str or StorageKeyType) – Required. The type of the storage key to use. Possible values include: “StorageAccessKey”, “SharedAccessKey”.
storage_key (str) – Required. The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a “?.”.
storage_uri (str) – Required. The storage uri to use.
administrator_login (str) – Required. The name of the SQL administrator.
administrator_login_password (str) – Required. The password of the SQL administrator.
authentication_type (str or AuthenticationType) – The authentication type. Possible values include: “SQL”, “ADPassword”. Default value: “SQL”.

Variables

operation_mode (str) – Required. The type of import operation being performed. This is always Import. Default value: “Import”.

operation_mode = 'Import'¶

class azure.mgmt.sql.models.ImportExtensionRequest(*, name: Optional[str] = None, type: Optional[str] = None, storage_key_type: Union[str, StorageKeyType, None] = None, storage_key: Optional[str] = None, storage_uri: Optional[str] = None, administrator_login: Optional[str] = None, administrator_login_password: Optional[str] = None, authentication_type: Union[str, AuthenticationType, None] = 'SQL', **kwargs)[source]¶

Bases: msrest.serialization.Model

Import database parameters.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

name (str) – The name of the extension.
type (str) – The type of the extension.
storage_key_type (str or StorageKeyType) – The type of the storage key to use. Possible values include: “StorageAccessKey”, “SharedAccessKey”.
storage_key (str) – The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a “?.”.
storage_uri (str) – The storage uri to use.
administrator_login (str) – The name of the SQL administrator.
administrator_login_password (str) – The password of the SQL administrator.
authentication_type (str or AuthenticationType) – The authentication type. Possible values include: “SQL”, “ADPassword”. Default value: “SQL”.

Variables

operation_mode (str) – The type of import operation being performed. This is always Import. Default value: “Import”.

operation_mode = 'Import'¶

class azure.mgmt.sql.models.ImportRequest(*, storage_key_type: Union[str, StorageKeyType], storage_key: str, storage_uri: str, administrator_login: str, administrator_login_password: str, database_name: str, edition: Union[str, DatabaseEdition], service_objective_name: Union[str, ServiceObjectiveName], max_size_bytes: str, authentication_type: Union[str, AuthenticationType, None] = 'SQL', **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.ExportRequest

Import database parameters.

All required parameters must be populated in order to send to Azure.

Parameters

storage_key_type (str or StorageKeyType) – Required. The type of the storage key to use. Possible values include: “StorageAccessKey”, “SharedAccessKey”.
storage_key (str) – Required. The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a “?.”.
storage_uri (str) – Required. The storage uri to use.
administrator_login (str) – Required. The name of the SQL administrator.
administrator_login_password (str) – Required. The password of the SQL administrator.
authentication_type (str or AuthenticationType) – The authentication type. Possible values include: “SQL”, “ADPassword”. Default value: “SQL”.
database_name (str) – Required. The name of the database to import.
edition (str or DatabaseEdition) –
Required. The edition for the database being created.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:
```
az sql db list-editions -l <location> -o table
`
```
```
Get-AzSqlServerServiceObjective -Location <location>
`. Possible values include: "Web", "Business", "Basic", "Standard", "Premium", "PremiumRS",
```
”Free”, “Stretch”, “DataWarehouse”, “System”, “System2”, “GeneralPurpose”, “BusinessCritical”, “Hyperscale”.
service_objective_name (str or ServiceObjectiveName) – Required. The name of the service objective to assign to the database. Possible values include: “System”, “System0”, “System1”, “System2”, “System3”, “System4”, “System2L”, “System3L”, “System4L”, “Free”, “Basic”, “S0”, “S1”, “S2”, “S3”, “S4”, “S6”, “S7”, “S9”, “S12”, “P1”, “P2”, “P3”, “P4”, “P6”, “P11”, “P15”, “PRS1”, “PRS2”, “PRS4”, “PRS6”, “DW100”, “DW200”, “DW300”, “DW400”, “DW500”, “DW600”, “DW1000”, “DW1200”, “DW1000c”, “DW1500”, “DW1500c”, “DW2000”, “DW2000c”, “DW3000”, “DW2500c”, “DW3000c”, “DW6000”, “DW5000c”, “DW6000c”, “DW7500c”, “DW10000c”, “DW15000c”, “DW30000c”, “DS100”, “DS200”, “DS300”, “DS400”, “DS500”, “DS600”, “DS1000”, “DS1200”, “DS1500”, “DS2000”, “ElasticPool”.
max_size_bytes (str) – Required. The maximum size for the newly imported database.

class azure.mgmt.sql.models.InstanceFailoverGroup(*, read_write_endpoint: Optional[InstanceFailoverGroupReadWriteEndpoint] = None, read_only_endpoint: Optional[InstanceFailoverGroupReadOnlyEndpoint] = None, partner_regions: Optional[List[PartnerRegionInfo]] = None, managed_instance_pairs: Optional[List[ManagedInstancePairInfo]] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An instance failover group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
replication_role (str or InstanceFailoverGroupReplicationRole) – Local replication role of the failover group instance. Possible values include: “Primary”, “Secondary”.
replication_state (str) – Replication state of the failover group instance.

Parameters

read_write_endpoint (InstanceFailoverGroupReadWriteEndpoint) – Read-write endpoint of the failover group instance.
read_only_endpoint (InstanceFailoverGroupReadOnlyEndpoint) – Read-only endpoint of the failover group instance.
partner_regions (list[PartnerRegionInfo]) – Partner region information for the failover group.
managed_instance_pairs (list[ManagedInstancePairInfo]) – List of managed instance pairs in the failover group.

class azure.mgmt.sql.models.InstanceFailoverGroupListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of instance failover groups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[InstanceFailoverGroup]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.InstanceFailoverGroupReadOnlyEndpoint(*, failover_policy: Union[str, ReadOnlyEndpointFailoverPolicy, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Read-only endpoint of the failover group instance.

Parameters: failover_policy (str or ReadOnlyEndpointFailoverPolicy) – Failover policy of the read-only endpoint for the failover group. Possible values include: “Disabled”, “Enabled”.

class azure.mgmt.sql.models.InstanceFailoverGroupReadWriteEndpoint(*, failover_policy: Union[str, ReadWriteEndpointFailoverPolicy], failover_with_data_loss_grace_period_minutes: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Read-write endpoint of the failover group instance.

All required parameters must be populated in order to send to Azure.

Parameters

failover_policy (str or ReadWriteEndpointFailoverPolicy) – Required. Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. Possible values include: “Manual”, “Automatic”.
failover_with_data_loss_grace_period_minutes (int) – Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

class azure.mgmt.sql.models.InstancePool(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, subnet_id: Optional[str] = None, v_cores: Optional[int] = None, license_type: Union[str, InstancePoolLicenseType, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

An Azure SQL instance pool.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
sku (Sku) – The name and tier of the SKU.
subnet_id (str) – Resource ID of the subnet to place this instance pool in.
v_cores (int) – Count of vCores belonging to this instance pool.
license_type (str or InstancePoolLicenseType) – The license type. Possible values are ‘LicenseIncluded’ (price for SQL license is included) and ‘BasePrice’ (without SQL license price). Possible values include: “LicenseIncluded”, “BasePrice”.

class azure.mgmt.sql.models.InstancePoolEditionCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The instance pool capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The instance pool version name.
supported_families (list[InstancePoolFamilyCapability]) – The supported families.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.InstancePoolFamilyCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The instance pool family capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Family name.
supported_license_types (list[LicenseTypeCapability]) – List of supported license types.
supported_vcores_values (list[InstancePoolVcoresCapability]) – List of supported virtual cores values.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.InstancePoolListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of Azure SQL instance pools.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[InstancePool]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.InstancePoolUpdate(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An update to an Instance pool.

Parameters: tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.sql.models.InstancePoolVcoresCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The managed instance virtual cores capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The virtual cores identifier.
value (int) – The virtual cores value.
storage_limit (MaxSizeCapability) – Storage limit.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.Job(*, description: Optional[str] = '', schedule: Optional[JobSchedule] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A job.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
version (int) – The job version number.

Parameters

description (str) – User-defined description of the job.
schedule (JobSchedule) – Schedule properties of the job.

class azure.mgmt.sql.models.JobAgent(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[Sku] = None, database_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

An Azure SQL job agent.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
state (str or JobAgentState) – The state of the job agent. Possible values include: “Creating”, “Ready”, “Updating”, “Deleting”, “Disabled”.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
sku (Sku) – The name and tier of the SKU.
database_id (str) – Resource ID of the database to store job metadata in.

class azure.mgmt.sql.models.JobAgentListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of Azure SQL job agents.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[JobAgent]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.JobAgentUpdate(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An update to an Azure SQL job agent.

Parameters: tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.sql.models.JobCredential(*, username: Optional[str] = None, password: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

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

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

username (str) – The credential user name.
password (str) – The credential password.

class azure.mgmt.sql.models.JobCredentialListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of job credentials.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[JobCredential]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.JobExecution(*, current_attempts: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An execution of a job.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
job_version (int) – The job version number.
step_name (str) – The job step name.
step_id (int) – The job step id.
job_execution_id (str) – The unique identifier of the job execution.
lifecycle (str or JobExecutionLifecycle) – The detailed state of the job execution. Possible values include: “Created”, “InProgress”, “WaitingForChildJobExecutions”, “WaitingForRetry”, “Succeeded”, “SucceededWithSkipped”, “Failed”, “TimedOut”, “Canceled”, “Skipped”.
provisioning_state (str or ProvisioningState) – The ARM provisioning state of the job execution. Possible values include: “Created”, “InProgress”, “Succeeded”, “Failed”, “Canceled”.
create_time (datetime) – The time that the job execution was created.
start_time (datetime) – The time that the job execution started.
end_time (datetime) – The time that the job execution completed.
current_attempt_start_time (datetime) – Start time of the current attempt.
last_message (str) – The last status or error message.
target (JobExecutionTarget) – The target that this execution is executed on.

Parameters

current_attempts (int) – Number of times the job execution has been attempted.

class azure.mgmt.sql.models.JobExecutionListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of job executions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[JobExecution]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.JobExecutionTarget(**kwargs)[source]¶

Bases: msrest.serialization.Model

The target that a job execution is executed on.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str or JobTargetType) – The type of the target. Possible values include: “TargetGroup”, “SqlDatabase”, “SqlElasticPool”, “SqlShardMap”, “SqlServer”.
server_name (str) – The server name.
database_name (str) – The database name.

class azure.mgmt.sql.models.JobListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of jobs.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Job]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.JobSchedule(*, start_time: Optional[datetime.datetime] = '0001-01-01T00:00:00Z', end_time: Optional[datetime.datetime] = '9999-12-31T11:59:59Z', type: Union[str, JobScheduleType, None] = 'Once', enabled: Optional[bool] = None, interval: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Scheduling properties of a job.

Parameters

start_time (datetime) – Schedule start time.
end_time (datetime) – Schedule end time.
type (str or JobScheduleType) – Schedule interval type. Possible values include: “Once”, “Recurring”. Default value: “Once”.
enabled (bool) – Whether or not the schedule is enabled.
interval (str) – Value of the schedule’s recurring interval, if the schedule type is recurring. ISO8601 duration format.

class azure.mgmt.sql.models.JobStep(*, step_id: Optional[int] = None, target_group: Optional[str] = None, credential: Optional[str] = None, action: Optional[JobStepAction] = None, output: Optional[JobStepOutput] = None, execution_options: Optional[JobStepExecutionOptions] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A job step.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

step_id (int) – The job step’s index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
target_group (str) – The resource ID of the target group that the job step will be executed on.
credential (str) – The resource ID of the job credential that will be used to connect to the targets.
action (JobStepAction) – The action payload of the job step.
output (JobStepOutput) – Output destination properties of the job step.
execution_options (JobStepExecutionOptions) – Execution options for the job step.

class azure.mgmt.sql.models.JobStepAction(*, value: str, type: Union[str, JobStepActionType, None] = 'TSql', source: Union[str, JobStepActionSource, None] = 'Inline', **kwargs)[source]¶

Bases: msrest.serialization.Model

The action to be executed by a job step.

All required parameters must be populated in order to send to Azure.

Parameters

type (str or JobStepActionType) – Type of action being executed by the job step. Possible values include: “TSql”. Default value: “TSql”.
source (str or JobStepActionSource) – The source of the action to execute. Possible values include: “Inline”. Default value: “Inline”.
value (str) – Required. The action value, for example the text of the T-SQL script to execute.

class azure.mgmt.sql.models.JobStepExecutionOptions(*, timeout_seconds: Optional[int] = 43200, retry_attempts: Optional[int] = 10, initial_retry_interval_seconds: Optional[int] = 1, maximum_retry_interval_seconds: Optional[int] = 120, retry_interval_backoff_multiplier: Optional[float] = 2, **kwargs)[source]¶

Bases: msrest.serialization.Model

The execution options of a job step.

Parameters

timeout_seconds (int) – Execution timeout for the job step.
retry_attempts (int) – Maximum number of times the job step will be reattempted if the first attempt fails.
initial_retry_interval_seconds (int) – Initial delay between retries for job step execution.
maximum_retry_interval_seconds (int) – The maximum amount of time to wait between retries for job step execution.
retry_interval_backoff_multiplier (float) – The backoff multiplier for the time between retries.

class azure.mgmt.sql.models.JobStepListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of job steps.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[JobStep]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.JobStepOutput(*, server_name: str, database_name: str, table_name: str, credential: str, type: Union[str, JobStepOutputType, None] = 'SqlDatabase', subscription_id: Optional[str] = None, resource_group_name: Optional[str] = None, schema_name: Optional[str] = 'dbo', **kwargs)[source]¶

Bases: msrest.serialization.Model

The output configuration of a job step.

All required parameters must be populated in order to send to Azure.

Parameters

type (str or JobStepOutputType) – The output destination type. Possible values include: “SqlDatabase”. Default value: “SqlDatabase”.
subscription_id (str) – The output destination subscription id.
resource_group_name (str) – The output destination resource group.
server_name (str) – Required. The output destination server name.
database_name (str) – Required. The output destination database.
schema_name (str) – The output destination schema.
table_name (str) – Required. The output destination table.
credential (str) – Required. The resource ID of the credential to use to connect to the output destination.

class azure.mgmt.sql.models.JobTarget(*, type: Union[str, JobTargetType], membership_type: Union[str, JobTargetGroupMembershipType, None] = 'Include', server_name: Optional[str] = None, database_name: Optional[str] = None, elastic_pool_name: Optional[str] = None, shard_map_name: Optional[str] = None, refresh_credential: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

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

All required parameters must be populated in order to send to Azure.

Parameters

membership_type (str or JobTargetGroupMembershipType) – Whether the target is included or excluded from the group. Possible values include: “Include”, “Exclude”. Default value: “Include”.
type (str or JobTargetType) – Required. The target type. Possible values include: “TargetGroup”, “SqlDatabase”, “SqlElasticPool”, “SqlShardMap”, “SqlServer”.
server_name (str) – The target server name.
database_name (str) – The target database name.
elastic_pool_name (str) – The target elastic pool name.
shard_map_name (str) – The target shard map.
refresh_credential (str) – The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target.

class azure.mgmt.sql.models.JobTargetGroup(*, members: Optional[List[JobTarget]] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A group of job targets.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

members (list[JobTarget]) – Members of the target group.

class azure.mgmt.sql.models.JobTargetGroupListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of target groups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[JobTargetGroup]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.JobVersion(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A job version.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.sql.models.JobVersionListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of job versions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Resource]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.LicenseTypeCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The license type capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – License type identifier.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.LocationCapabilities(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The location capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The location name.
supported_server_versions (list[ServerVersionCapability]) – The list of supported server versions.
supported_managed_instance_versions (list[ManagedInstanceVersionCapability]) – The list of supported managed instance versions.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.LogSizeCapability(**kwargs)[source]¶

Bases: msrest.serialization.Model

The log size capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

limit (int) – The log size limit (see ‘unit’ for the units).
unit (str or LogSizeUnit) – The units that the limit is expressed in. Possible values include: “Megabytes”, “Gigabytes”, “Terabytes”, “Petabytes”, “Percent”.

class azure.mgmt.sql.models.LogicalServerSecurityAlertPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of the server’s security alert policies.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ServerSecurityAlertPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.LongTermRetentionBackup(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A long term retention backup.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
server_name (str) – The server name that the backup database belong to.
server_create_time (datetime) – The create time of the server.
database_name (str) – The name of the database the backup belong to.
database_deletion_time (datetime) – The delete time of the database.
backup_time (datetime) – The time the backup was taken.
backup_expiration_time (datetime) – The time the long term retention backup will expire.

class azure.mgmt.sql.models.LongTermRetentionBackupListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of long term retention backups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[LongTermRetentionBackup]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedBackupShortTermRetentionPolicy(*, retention_days: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A short term retention policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.

class azure.mgmt.sql.models.ManagedBackupShortTermRetentionPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of short term retention policies.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedBackupShortTermRetentionPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedDatabase(*, location: str, tags: Optional[Dict[str, str]] = None, collation: Optional[str] = None, restore_point_in_time: Optional[datetime.datetime] = None, catalog_collation: Union[str, CatalogCollationType, None] = None, create_mode: Union[str, ManagedDatabaseCreateMode, None] = None, storage_container_uri: Optional[str] = None, source_database_id: Optional[str] = None, restorable_dropped_database_id: Optional[str] = None, storage_container_sas_token: Optional[str] = None, recoverable_database_id: Optional[str] = None, long_term_retention_backup_resource_id: Optional[str] = None, auto_complete_restore: Optional[bool] = None, last_backup_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

A managed database resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
status (str or ManagedDatabaseStatus) – Status of the database. Possible values include: “Online”, “Offline”, “Shutdown”, “Creating”, “Inaccessible”, “Restoring”, “Updating”.
creation_date (datetime) – Creation date of the database.
earliest_restore_point (datetime) – Earliest restore point in time for point in time restore.
default_secondary_location (str) – Geo paired region.
failover_group_id (str) – Instance Failover Group resource identifier that this managed database belongs to.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
collation (str) – Collation of the managed database.
restore_point_in_time (datetime) – Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
catalog_collation (str or CatalogCollationType) – Collation of the metadata catalog. Possible values include: “DATABASE_DEFAULT”, “SQL_Latin1_General_CP1_CI_AS”.
create_mode (str or ManagedDatabaseCreateMode) – Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo- replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). Possible values include: “Default”, “RestoreExternalBackup”, “PointInTimeRestore”, “Recovery”, “RestoreLongTermRetentionBackup”.
storage_container_uri (str) – Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.
source_database_id (str) – The resource identifier of the source database associated with create operation of this database.
restorable_dropped_database_id (str) – The restorable dropped database resource id to restore when creating this database.
storage_container_sas_token (str) – Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.
recoverable_database_id (str) – The resource identifier of the recoverable database associated with create operation of this database.
long_term_retention_backup_resource_id (str) – The name of the Long Term Retention backup to be used for restore of this managed database.
auto_complete_restore (bool) – Whether to auto complete restore of this managed database.
last_backup_name (str) – Last backup file name for restore of this managed database.

class azure.mgmt.sql.models.ManagedDatabaseListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of managed databases.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedDatabase]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedDatabaseRestoreDetailsResult(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A managed database restore details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
status (str) – Restore status.
current_restoring_file_name (str) – Current restoring file name.
last_restored_file_name (str) – Last restored file name.
last_restored_file_time (datetime) – Last restored file time.
percent_completed (float) – Percent completed.
unrestorable_files (list[str]) – List of unrestorable files.
number_of_files_detected (long) – Number of files detected.
last_uploaded_file_name (str) – Last uploaded file name.
last_uploaded_file_time (datetime) – Last uploaded file time.
block_reason (str) – The reason why restore is in Blocked state.

class azure.mgmt.sql.models.ManagedDatabaseSecurityAlertPolicy(*, state: Union[str, SecurityAlertPolicyState, None] = None, disabled_alerts: Optional[List[str]] = None, email_addresses: Optional[List[str]] = None, email_account_admins: Optional[bool] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A managed database security alert policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
creation_time (datetime) – Specifies the UTC creation time of the policy.

Parameters

state (str or SecurityAlertPolicyState) – Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. Possible values include: “New”, “Enabled”, “Disabled”.
disabled_alerts (list[str]) – Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
email_addresses (list[str]) – Specifies an array of e-mail addresses to which the alert is sent.
email_account_admins (bool) – Specifies that the alert is sent to the account administrators.
storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
storage_account_access_key (str) – Specifies the identifier key of the Threat Detection audit storage account.
retention_days (int) – Specifies the number of days to keep in the Threat Detection audit logs.

class azure.mgmt.sql.models.ManagedDatabaseSecurityAlertPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of the managed database’s security alert policies.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedDatabaseSecurityAlertPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedDatabaseUpdate(*, tags: Optional[Dict[str, str]] = None, collation: Optional[str] = None, restore_point_in_time: Optional[datetime.datetime] = None, catalog_collation: Union[str, CatalogCollationType, None] = None, create_mode: Union[str, ManagedDatabaseCreateMode, None] = None, storage_container_uri: Optional[str] = None, source_database_id: Optional[str] = None, restorable_dropped_database_id: Optional[str] = None, storage_container_sas_token: Optional[str] = None, recoverable_database_id: Optional[str] = None, long_term_retention_backup_resource_id: Optional[str] = None, auto_complete_restore: Optional[bool] = None, last_backup_name: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An managed database update.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.
collation (str) – Collation of the managed database.
restore_point_in_time (datetime) – Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
catalog_collation (str or CatalogCollationType) – Collation of the metadata catalog. Possible values include: “DATABASE_DEFAULT”, “SQL_Latin1_General_CP1_CI_AS”.
create_mode (str or ManagedDatabaseCreateMode) – Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo- replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). Possible values include: “Default”, “RestoreExternalBackup”, “PointInTimeRestore”, “Recovery”, “RestoreLongTermRetentionBackup”.
storage_container_uri (str) – Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.
source_database_id (str) – The resource identifier of the source database associated with create operation of this database.
restorable_dropped_database_id (str) – The restorable dropped database resource id to restore when creating this database.
storage_container_sas_token (str) – Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.
recoverable_database_id (str) – The resource identifier of the recoverable database associated with create operation of this database.
long_term_retention_backup_resource_id (str) – The name of the Long Term Retention backup to be used for restore of this managed database.
auto_complete_restore (bool) – Whether to auto complete restore of this managed database.
last_backup_name (str) – Last backup file name for restore of this managed database.

Variables

status (str or ManagedDatabaseStatus) – Status of the database. Possible values include: “Online”, “Offline”, “Shutdown”, “Creating”, “Inaccessible”, “Restoring”, “Updating”.
creation_date (datetime) – Creation date of the database.
earliest_restore_point (datetime) – Earliest restore point in time for point in time restore.
default_secondary_location (str) – Geo paired region.
failover_group_id (str) – Instance Failover Group resource identifier that this managed database belongs to.

class azure.mgmt.sql.models.ManagedInstance(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[ResourceIdentity] = None, sku: Optional[Sku] = None, managed_instance_create_mode: Union[str, ManagedServerCreateMode, None] = None, administrator_login: Optional[str] = None, administrator_login_password: Optional[str] = None, subnet_id: Optional[str] = None, license_type: Union[str, ManagedInstanceLicenseType, None] = None, v_cores: Optional[int] = None, storage_size_in_gb: Optional[int] = None, collation: Optional[str] = None, dns_zone_partner: Optional[str] = None, public_data_endpoint_enabled: Optional[bool] = None, source_managed_instance_id: Optional[str] = None, restore_point_in_time: Optional[datetime.datetime] = None, proxy_override: Union[str, ManagedInstanceProxyOverride, None] = None, timezone_id: Optional[str] = None, instance_pool_id: Optional[str] = None, maintenance_configuration_id: Optional[str] = None, minimal_tls_version: Optional[str] = None, storage_account_type: Union[str, StorageAccountType, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

An Azure SQL managed instance.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
provisioning_state (str or ManagedInstancePropertiesProvisioningState) – Possible values include: “Creating”, “Deleting”, “Updating”, “Unknown”, “Succeeded”, “Failed”.
fully_qualified_domain_name (str) – The fully qualified domain name of the managed instance.
state (str) – The state of the managed instance.
dns_zone (str) – The Dns Zone that the managed instance is in.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
identity (ResourceIdentity) – The Azure Active Directory identity of the managed instance.
sku (Sku) – Managed instance SKU. Allowed values for sku.name: GP_Gen4, GP_Gen5, BC_Gen4, BC_Gen5.
managed_instance_create_mode (str or ManagedServerCreateMode) –
Specifies the mode of database creation.

Default: Regular instance creation.

Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. Possible values include: “Default”, “PointInTimeRestore”.
administrator_login (str) – Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
administrator_login_password (str) – The administrator login password (required for managed instance creation).
subnet_id (str) – Subnet resource ID for the managed instance.
license_type (str or ManagedInstanceLicenseType) – The license type. Possible values are ‘LicenseIncluded’ (regular price inclusive of a new SQL license) and ‘BasePrice’ (discounted AHB price for bringing your own SQL licenses). Possible values include: “LicenseIncluded”, “BasePrice”.
v_cores (int) – The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
storage_size_in_gb (int) – Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.
collation (str) – Collation of the managed instance.
dns_zone_partner (str) – The resource id of another managed instance whose DNS zone this managed instance will share after creation.
public_data_endpoint_enabled (bool) – Whether or not the public data endpoint is enabled.
source_managed_instance_id (str) – The resource identifier of the source managed instance associated with create operation of this instance.
restore_point_in_time (datetime) – Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
proxy_override (str or ManagedInstanceProxyOverride) – Connection type used for connecting to the instance. Possible values include: “Proxy”, “Redirect”, “Default”.
timezone_id (str) – Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINESOFTWAREMicrosoftWindows NTCurrentVersionTime Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is “Pacific Standard Time” or “W. Europe Standard Time”.
instance_pool_id (str) – The Id of the instance pool this managed server belongs to.
maintenance_configuration_id (str) – Specifies maintenance configuration id to apply to this managed instance.
minimal_tls_version (str) – Minimal TLS version. Allowed values: ‘None’, ‘1.0’, ‘1.1’, ‘1.2’.
storage_account_type (str or StorageAccountType) – The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage). Possible values include: “GRS”, “LRS”, “ZRS”.

class azure.mgmt.sql.models.ManagedInstanceAdministrator(*, administrator_type: Union[str, ManagedInstanceAdministratorType, None] = None, login: Optional[str] = None, sid: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An Azure SQL managed instance administrator.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

administrator_type (str or ManagedInstanceAdministratorType) – Type of the managed instance administrator. Possible values include: “ActiveDirectory”.
login (str) – Login name of the managed instance administrator.
sid (str) – SID (object ID) of the managed instance administrator.
tenant_id (str) – Tenant ID of the managed instance administrator.

class azure.mgmt.sql.models.ManagedInstanceAdministratorListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of managed instance administrators.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedInstanceAdministrator]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstanceEditionCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The managed server capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The managed server version name.
supported_families (list[ManagedInstanceFamilyCapability]) – The supported families.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ManagedInstanceEncryptionProtector(*, server_key_name: Optional[str] = None, server_key_type: Union[str, ServerKeyType, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

The managed instance encryption protector.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Kind of encryption protector. This is metadata used for the Azure portal experience.
uri (str) – The URI of the server key.
thumbprint (str) – Thumbprint of the server key.

Parameters

server_key_name (str) – The name of the managed instance key.
server_key_type (str or ServerKeyType) – The encryption protector type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: “ServiceManaged”, “AzureKeyVault”.

class azure.mgmt.sql.models.ManagedInstanceEncryptionProtectorListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of managed instance encryption protectors.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedInstanceEncryptionProtector]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstanceFamilyCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The managed server family capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Family name.
sku (str) – SKU name.
supported_license_types (list[LicenseTypeCapability]) – List of supported license types.
supported_vcores_values (list[ManagedInstanceVcoresCapability]) – List of supported virtual cores values.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ManagedInstanceKey(*, server_key_type: Union[str, ServerKeyType, None] = None, uri: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A managed instance key.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Kind of encryption protector. This is metadata used for the Azure portal experience.
thumbprint (str) – Thumbprint of the key.
creation_date (datetime) – The key creation date.

Parameters

server_key_type (str or ServerKeyType) – The key type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: “ServiceManaged”, “AzureKeyVault”.
uri (str) – The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.

class azure.mgmt.sql.models.ManagedInstanceKeyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of managed instance keys.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedInstanceKey]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstanceListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of managed instances.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedInstance]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstanceLongTermRetentionBackup(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A long term retention backup for a managed database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
managed_instance_name (str) – The managed instance that the backup database belongs to.
managed_instance_create_time (datetime) – The create time of the instance.
database_name (str) – The name of the database the backup belong to.
database_deletion_time (datetime) – The delete time of the database.
backup_time (datetime) – The time the backup was taken.
backup_expiration_time (datetime) – The time the long term retention backup will expire.

class azure.mgmt.sql.models.ManagedInstanceLongTermRetentionBackupListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of long term retention backups for managed database(s).

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedInstanceLongTermRetentionBackup]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstanceLongTermRetentionPolicy(*, weekly_retention: Optional[str] = None, monthly_retention: Optional[str] = None, yearly_retention: Optional[str] = None, week_of_year: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A long term retention policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

weekly_retention (str) – The weekly retention policy for an LTR backup in an ISO 8601 format.
monthly_retention (str) – The monthly retention policy for an LTR backup in an ISO 8601 format.
yearly_retention (str) – The yearly retention policy for an LTR backup in an ISO 8601 format.
week_of_year (int) – The week of year to take the yearly backup in an ISO 8601 format.

class azure.mgmt.sql.models.ManagedInstanceLongTermRetentionPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of long term retention policies.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedInstanceLongTermRetentionPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstanceOperation(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A managed instance operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
managed_instance_name (str) – The name of the managed instance the operation is being performed on.
operation (str) – The name of operation.
operation_friendly_name (str) – The friendly name of operation.
percent_complete (int) – The percentage of the operation completed.
start_time (datetime) – The operation start time.
state (str or ManagementOperationState) – The operation state. Possible values include: “Pending”, “InProgress”, “Succeeded”, “Failed”, “CancelInProgress”, “Cancelled”.
error_code (int) – The operation error code.
error_description (str) – The operation error description.
error_severity (int) – The operation error severity.
is_user_error (bool) – Whether or not the error is a user error.
estimated_completion_time (datetime) – The estimated completion time of the operation.
description (str) – The operation description.
is_cancellable (bool) – Whether the operation can be cancelled.
operation_parameters (ManagedInstanceOperationParametersPair) – The operation parameters.
operation_steps (ManagedInstanceOperationSteps) – The operation steps.

class azure.mgmt.sql.models.ManagedInstanceOperationListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list managed instance operations request.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedInstanceOperation]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstanceOperationParametersPair(**kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters of a managed instance operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

current_parameters (UpsertManagedServerOperationParameters) – The current parameters.
requested_parameters (UpsertManagedServerOperationParameters) – The requested parameters.

class azure.mgmt.sql.models.ManagedInstanceOperationSteps(**kwargs)[source]¶

Bases: msrest.serialization.Model

The steps of a managed instance operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

total_steps (str) – The total number of operation steps.
current_step (int) – The number of current operation steps.
steps_list (list[UpsertManagedServerOperationStep]) – The operation steps list.

class azure.mgmt.sql.models.ManagedInstancePairInfo(*, primary_managed_instance_id: Optional[str] = None, partner_managed_instance_id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Pairs of Managed Instances in the failover group.

Parameters

primary_managed_instance_id (str) – Id of Primary Managed Instance in pair.
partner_managed_instance_id (str) – Id of Partner Managed Instance in pair.

class azure.mgmt.sql.models.ManagedInstancePrivateLinkServiceConnectionStateProperty(*, status: str, description: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

ManagedInstancePrivateLinkServiceConnectionStateProperty.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

status (str) – Required. The private link service connection status.
description (str) – Required. The private link service connection description.

Variables

actions_required (str) – The private link service connection description.

class azure.mgmt.sql.models.ManagedInstanceUpdate(*, sku: Optional[Sku] = None, tags: Optional[Dict[str, str]] = None, managed_instance_create_mode: Union[str, ManagedServerCreateMode, None] = None, administrator_login: Optional[str] = None, administrator_login_password: Optional[str] = None, subnet_id: Optional[str] = None, license_type: Union[str, ManagedInstanceLicenseType, None] = None, v_cores: Optional[int] = None, storage_size_in_gb: Optional[int] = None, collation: Optional[str] = None, dns_zone_partner: Optional[str] = None, public_data_endpoint_enabled: Optional[bool] = None, source_managed_instance_id: Optional[str] = None, restore_point_in_time: Optional[datetime.datetime] = None, proxy_override: Union[str, ManagedInstanceProxyOverride, None] = None, timezone_id: Optional[str] = None, instance_pool_id: Optional[str] = None, maintenance_configuration_id: Optional[str] = None, minimal_tls_version: Optional[str] = None, storage_account_type: Union[str, StorageAccountType, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An update request for an Azure SQL Database managed instance.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

sku (Sku) – Managed instance sku.
tags (dict[str, str]) – A set of tags. Resource tags.
managed_instance_create_mode (str or ManagedServerCreateMode) –
Specifies the mode of database creation.

Default: Regular instance creation.

Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified. Possible values include: “Default”, “PointInTimeRestore”.
administrator_login (str) – Administrator username for the managed instance. Can only be specified when the managed instance is being created (and is required for creation).
administrator_login_password (str) – The administrator login password (required for managed instance creation).
subnet_id (str) – Subnet resource ID for the managed instance.
license_type (str or ManagedInstanceLicenseType) – The license type. Possible values are ‘LicenseIncluded’ (regular price inclusive of a new SQL license) and ‘BasePrice’ (discounted AHB price for bringing your own SQL licenses). Possible values include: “LicenseIncluded”, “BasePrice”.
v_cores (int) – The number of vCores. Allowed values: 8, 16, 24, 32, 40, 64, 80.
storage_size_in_gb (int) – Storage size in GB. Minimum value: 32. Maximum value: 8192. Increments of 32 GB allowed only.
collation (str) – Collation of the managed instance.
dns_zone_partner (str) – The resource id of another managed instance whose DNS zone this managed instance will share after creation.
public_data_endpoint_enabled (bool) – Whether or not the public data endpoint is enabled.
source_managed_instance_id (str) – The resource identifier of the source managed instance associated with create operation of this instance.
restore_point_in_time (datetime) – Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
proxy_override (str or ManagedInstanceProxyOverride) – Connection type used for connecting to the instance. Possible values include: “Proxy”, “Redirect”, “Default”.
timezone_id (str) – Id of the timezone. Allowed values are timezones supported by Windows. Windows keeps details on supported timezones, including the id, in registry under KEY_LOCAL_MACHINESOFTWAREMicrosoftWindows NTCurrentVersionTime Zones. You can get those registry values via SQL Server by querying SELECT name AS timezone_id FROM sys.time_zone_info. List of Ids can also be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. An example of valid timezone id is “Pacific Standard Time” or “W. Europe Standard Time”.
instance_pool_id (str) – The Id of the instance pool this managed server belongs to.
maintenance_configuration_id (str) – Specifies maintenance configuration id to apply to this managed instance.
minimal_tls_version (str) – Minimal TLS version. Allowed values: ‘None’, ‘1.0’, ‘1.1’, ‘1.2’.
storage_account_type (str or StorageAccountType) – The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage). Possible values include: “GRS”, “LRS”, “ZRS”.

Variables

provisioning_state (str or ManagedInstancePropertiesProvisioningState) – Possible values include: “Creating”, “Deleting”, “Updating”, “Unknown”, “Succeeded”, “Failed”.
fully_qualified_domain_name (str) – The fully qualified domain name of the managed instance.
state (str) – The state of the managed instance.
dns_zone (str) – The Dns Zone that the managed instance is in.

class azure.mgmt.sql.models.ManagedInstanceVcoresCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The managed instance virtual cores capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The virtual cores identifier.
value (int) – The virtual cores value.
included_max_size (MaxSizeCapability) – Included size.
supported_storage_sizes (list[MaxSizeRangeCapability]) – Storage size ranges.
instance_pool_supported (bool) – True if this service objective is supported for managed instances in an instance pool.
standalone_supported (bool) – True if this service objective is supported for standalone managed instances.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ManagedInstanceVersionCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The managed instance capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The server version name.
supported_editions (list[ManagedInstanceEditionCapability]) – The list of supported managed instance editions.
supported_instance_pool_editions (list[InstancePoolEditionCapability]) – The list of supported instance pool editions.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ManagedInstanceVulnerabilityAssessment(*, storage_container_path: Optional[str] = None, storage_container_sas_key: Optional[str] = None, storage_account_access_key: Optional[str] = None, recurring_scans: Optional[VulnerabilityAssessmentRecurringScansProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A managed instance vulnerability assessment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

storage_container_path (str) – A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).
storage_container_sas_key (str) – A shared access signature (SAS Key) that has read and write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required.
storage_account_access_key (str) – Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required.
recurring_scans (VulnerabilityAssessmentRecurringScansProperties) – The recurring scans settings.

class azure.mgmt.sql.models.ManagedInstanceVulnerabilityAssessmentListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of the ManagedInstance’s vulnerability assessments.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedInstanceVulnerabilityAssessment]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedServerSecurityAlertPolicy(*, state: Union[str, SecurityAlertPolicyState, None] = None, disabled_alerts: Optional[List[str]] = None, email_addresses: Optional[List[str]] = None, email_account_admins: Optional[bool] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A managed server security alert policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
creation_time (datetime) – Specifies the UTC creation time of the policy.

Parameters

state (str or SecurityAlertPolicyState) – Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. Possible values include: “New”, “Enabled”, “Disabled”.
disabled_alerts (list[str]) – Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
email_addresses (list[str]) – Specifies an array of e-mail addresses to which the alert is sent.
email_account_admins (bool) – Specifies that the alert is sent to the account administrators.
storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
storage_account_access_key (str) – Specifies the identifier key of the Threat Detection audit storage account.
retention_days (int) – Specifies the number of days to keep in the Threat Detection audit logs.

class azure.mgmt.sql.models.ManagedServerSecurityAlertPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of the managed Server’s security alert policies.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ManagedServerSecurityAlertPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.MaxSizeCapability(**kwargs)[source]¶

Bases: msrest.serialization.Model

The maximum size capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

limit (int) – The maximum size limit (see ‘unit’ for the units).
unit (str or MaxSizeUnit) – The units that the limit is expressed in. Possible values include: “Megabytes”, “Gigabytes”, “Terabytes”, “Petabytes”.

class azure.mgmt.sql.models.MaxSizeRangeCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The maximum size range capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

min_value (MaxSizeCapability) – Minimum value.
max_value (MaxSizeCapability) – Maximum value.
scale_size (MaxSizeCapability) – Scale/step size for discrete values between the minimum value and the maximum value.
log_size (LogSizeCapability) – Size of transaction log.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.Metric(**kwargs)[source]¶

Bases: msrest.serialization.Model

Database metrics.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

start_time (datetime) – The start time for the metric (ISO-8601 format).
end_time (datetime) – The end time for the metric (ISO-8601 format).
time_grain (str) – The time step to be used to summarize the metric values.
unit (str or UnitType) – The unit of the metric. Possible values include: “count”, “bytes”, “seconds”, “percent”, “countPerSecond”, “bytesPerSecond”.
name (MetricName) – The name information for the metric.
metric_values (list[MetricValue]) – The metric values for the specified time window and timestep.

class azure.mgmt.sql.models.MetricAvailability(**kwargs)[source]¶

Bases: msrest.serialization.Model

A metric availability value.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

retention (str) – The length of retention for the database metric.
time_grain (str) – The granularity of the database metric.

class azure.mgmt.sql.models.MetricDefinition(**kwargs)[source]¶

Bases: msrest.serialization.Model

A database metric definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (MetricName) – The name information for the metric.
primary_aggregation_type (str or PrimaryAggregationType) – The primary aggregation type defining how metric values are displayed. Possible values include: “None”, “Average”, “Count”, “Minimum”, “Maximum”, “Total”.
resource_uri (str) – The resource uri of the database.
unit (str or UnitDefinitionType) – The unit of the metric. Possible values include: “Count”, “Bytes”, “Seconds”, “Percent”, “CountPerSecond”, “BytesPerSecond”.
metric_availabilities (list[MetricAvailability]) – The list of database metric availabilities for the metric.

class azure.mgmt.sql.models.MetricDefinitionListResult(*, value: List[MetricDefinition], **kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list database metric definitions request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[MetricDefinition]) – Required. The list of metric definitions for the database.

class azure.mgmt.sql.models.MetricListResult(*, value: List[Metric], **kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list database metrics request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[Metric]) – Required. The list of metrics for the database.

class azure.mgmt.sql.models.MetricName(**kwargs)[source]¶

Bases: msrest.serialization.Model

A database metric name.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (str) – The name of the database metric.
localized_value (str) – The friendly name of the database metric.

class azure.mgmt.sql.models.MetricValue(**kwargs)[source]¶

Bases: msrest.serialization.Model

Represents database metrics.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

count (int) – The number of values for the metric.
average (float) – The average value of the metric.
maximum (float) – The max value of the metric.
minimum (float) – The min value of the metric.
timestamp (datetime) – The metric timestamp (ISO-8601 format).
total (float) – The total value of the metric.

class azure.mgmt.sql.models.MinCapacityCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The min capacity capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (float) – Min capacity value.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.Name(*, value: Optional[str] = None, localized_value: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

ARM Usage Name.

Parameters

value (str) – Usage name value.
localized_value (str) – Usage name localized value.

class azure.mgmt.sql.models.Operation(**kwargs)[source]¶

Bases: msrest.serialization.Model

SQL REST API operation definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The name of the operation being performed on this particular object.
display (OperationDisplay) – The localized display information for this particular operation / action.
origin (str or OperationOrigin) – The intended executor of the operation. Possible values include: “user”, “system”.
properties (dict[str, object]) – Additional descriptions for the operation.

class azure.mgmt.sql.models.OperationDisplay(**kwargs)[source]¶

Bases: msrest.serialization.Model

Display metadata associated with the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provider (str) – The localized friendly form of the resource provider name.
resource (str) – The localized friendly form of the resource type related to this action/operation.
operation (str) – The localized friendly name for the operation.
description (str) – The localized friendly description for the operation.

class azure.mgmt.sql.models.OperationImpact(**kwargs)[source]¶

Bases: msrest.serialization.Model

The impact of an operation, both in absolute and relative terms.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The name of the impact dimension.
unit (str) – The unit in which estimated impact to dimension is measured.
change_value_absolute (float) – The absolute impact to dimension.
change_value_relative (float) – The relative impact to dimension (null if not applicable).

class azure.mgmt.sql.models.OperationListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

Result of the request to list SQL operations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Operation]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.PartnerInfo(*, id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Partner server information for the failover group.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

id (str) – Required. Resource identifier of the partner server.

Variables

location (str) – Geo location of the partner server.
replication_role (str or FailoverGroupReplicationRole) – Replication role of the partner server. Possible values include: “Primary”, “Secondary”.

class azure.mgmt.sql.models.PartnerRegionInfo(*, location: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Partner region information for the failover group.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters: location (str) – Geo location of the partner managed instances.
Variables: replication_role (str or InstanceFailoverGroupReplicationRole) – Replication role of the partner managed instances. Possible values include: “Primary”, “Secondary”.

class azure.mgmt.sql.models.PerformanceLevelCapability(**kwargs)[source]¶

Bases: msrest.serialization.Model

The performance level capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (float) – Performance level value.
unit (str or PerformanceLevelUnit) – Unit type used to measure performance level. Possible values include: “DTU”, “VCores”.

class azure.mgmt.sql.models.PrivateEndpointConnection(*, private_endpoint: Optional[PrivateEndpointProperty] = None, private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateProperty] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
provisioning_state (str) – State of the private endpoint connection.

Parameters

private_endpoint (PrivateEndpointProperty) – Private endpoint which the connection belongs to.
private_link_service_connection_state (PrivateLinkServiceConnectionStateProperty) – Connection state of the private endpoint connection.

class azure.mgmt.sql.models.PrivateEndpointConnectionListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of private endpoint connections.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[PrivateEndpointConnection]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.PrivateEndpointConnectionProperties(*, private_endpoint: Optional[PrivateEndpointProperty] = None, private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStatePropertyAutoGenerated] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of a private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

private_endpoint (PrivateEndpointProperty) – Private endpoint which the connection belongs to.
private_link_service_connection_state (PrivateLinkServiceConnectionStatePropertyAutoGenerated) – Connection state of the private endpoint connection.

Variables

provisioning_state (str or PrivateEndpointProvisioningState) – State of the private endpoint connection. Possible values include: “Approving”, “Ready”, “Dropping”, “Failed”, “Rejecting”.

class azure.mgmt.sql.models.PrivateEndpointProperty(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

PrivateEndpointProperty.

Parameters: id (str) – Resource id of the private endpoint.

class azure.mgmt.sql.models.PrivateLinkResource(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
properties (PrivateLinkResourceProperties) – The private link resource group id.

class azure.mgmt.sql.models.PrivateLinkResourceListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of private link resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[PrivateLinkResource]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.PrivateLinkResourceProperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of a private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.

class azure.mgmt.sql.models.PrivateLinkServiceConnectionStateProperty(*, status: str, description: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

PrivateLinkServiceConnectionStateProperty.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

status (str) – Required. The private link service connection status.
description (str) – Required. The private link service connection description.

Variables

actions_required (str) – The actions required for private link service connection.

class azure.mgmt.sql.models.PrivateLinkServiceConnectionStatePropertyAutoGenerated(*, status: Union[str, PrivateLinkServiceConnectionStateStatus], description: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

PrivateLinkServiceConnectionStatePropertyAutoGenerated.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

status (str or PrivateLinkServiceConnectionStateStatus) – Required. The private link service connection status. Possible values include: “Approved”, “Pending”, “Rejected”, “Disconnected”.
description (str) – Required. The private link service connection description.

Variables

actions_required (str or PrivateLinkServiceConnectionStateActionsRequire) – The actions required for private link service connection. Possible values include: “None”.

class azure.mgmt.sql.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

ARM proxy resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.sql.models.ReadScaleCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The read scale capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

max_number_of_replicas (int) – The maximum number of read scale replicas.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.RecommendedElasticPool(*, dtu: Optional[float] = None, database_dtu_min: Optional[float] = None, database_dtu_max: Optional[float] = None, storage_mb: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a recommended elastic pool.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
database_edition (str or ElasticPoolEdition) – The edition of the recommended elastic pool. The ElasticPoolEdition enumeration contains all the valid editions. Possible values include: “Basic”, “Standard”, “Premium”, “GeneralPurpose”, “BusinessCritical”.
observation_period_start (datetime) – The observation period start (ISO8601 format).
observation_period_end (datetime) – The observation period start (ISO8601 format).
max_observed_dtu (float) – Gets maximum observed DTU.
max_observed_storage_mb (float) – Gets maximum observed storage in megabytes.
databases (list[TrackedResource]) – The list of databases in this pool. Expanded property.
metrics (list[RecommendedElasticPoolMetric]) – The list of databases housed in the server. Expanded property.

Parameters

dtu (float) – The DTU for the recommended elastic pool.
database_dtu_min (float) – The minimum DTU for the database.
database_dtu_max (float) – The maximum DTU for the database.
storage_mb (float) – Gets storage size in megabytes.

class azure.mgmt.sql.models.RecommendedElasticPoolListMetricsResult(*, value: List[RecommendedElasticPoolMetric], **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a list recommended elastic pool metrics request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[RecommendedElasticPoolMetric]) – Required. The list of recommended elastic pools metrics.

class azure.mgmt.sql.models.RecommendedElasticPoolListResult(*, value: List[RecommendedElasticPool], **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a list recommended elastic pool request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[RecommendedElasticPool]) – Required. The list of recommended elastic pools hosted in the server.

class azure.mgmt.sql.models.RecommendedElasticPoolMetric(*, date_time: Optional[datetime.datetime] = None, dtu: Optional[float] = None, size_gb: Optional[float] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents recommended elastic pool metric.

Parameters

date_time (datetime) – The time of metric (ISO8601 format).
dtu (float) – Gets or sets the DTUs (Database Transaction Units). See https://azure.microsoft.com/documentation/articles/sql-database-what-is-a-dtu/.
size_gb (float) – Gets or sets size in gigabytes.

class azure.mgmt.sql.models.RecommendedIndex(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a database recommended index.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
action (str or RecommendedIndexAction) – The proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance. Possible values include: “Create”, “Drop”, “Rebuild”.
state (str or RecommendedIndexState) – The current recommendation state. Possible values include: “Active”, “Pending”, “Executing”, “Verifying”, “Pending Revert”, “Reverting”, “Reverted”, “Ignored”, “Expired”, “Blocked”, “Success”.
created (datetime) – The UTC datetime showing when this resource was created (ISO8601 format).
last_modified (datetime) – The UTC datetime of when was this resource last changed (ISO8601 format).
index_type (str or RecommendedIndexType) – The type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE). Possible values include: “CLUSTERED”, “NONCLUSTERED”, “COLUMNSTORE”, “CLUSTERED COLUMNSTORE”.
schema (str) – The schema where table to build index over resides.
table (str) – The table on which to build index.
columns (list[str]) – Columns over which to build index.
included_columns (list[str]) – The list of column names to be included in the index.
index_script (str) – The full build index script.
estimated_impact (list[OperationImpact]) – The estimated impact of doing recommended index action.
reported_impact (list[OperationImpact]) – The values reported after index action is complete.

class azure.mgmt.sql.models.RecoverableDatabase(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A recoverable database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
edition (str) – The edition of the database.
service_level_objective (str) – The service level objective name of the database.
elastic_pool_name (str) – The elastic pool name of the database.
last_available_backup_date (datetime) – The last available backup date of the database (ISO8601 format).

class azure.mgmt.sql.models.RecoverableDatabaseListResult(*, value: List[RecoverableDatabase], **kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list recoverable databases request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[RecoverableDatabase]) – Required. A list of recoverable databases.

class azure.mgmt.sql.models.RecoverableManagedDatabase(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A recoverable managed database resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
last_available_backup_date (str) – The last available backup date.

class azure.mgmt.sql.models.RecoverableManagedDatabaseListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of recoverable managed databases.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[RecoverableManagedDatabase]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ReplicationLink(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a database replication link.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Location of the server that contains this firewall rule.
is_termination_allowed (bool) – Legacy value indicating whether termination is allowed. Currently always returns true.
replication_mode (str) – Replication mode of this replication link.
partner_server (str) – The name of the server hosting the partner database.
partner_database (str) – The name of the partner database.
partner_location (str) – The Azure Region of the partner database.
role (str or ReplicationRole) – The role of the database in the replication link. Possible values include: “Primary”, “Secondary”, “NonReadableSecondary”, “Source”, “Copy”.
partner_role (str or ReplicationRole) – The role of the partner database in the replication link. Possible values include: “Primary”, “Secondary”, “NonReadableSecondary”, “Source”, “Copy”.
start_time (datetime) – The start time for the replication link.
percent_complete (int) – The percentage of seeding complete for the replication link.
replication_state (str or ReplicationState) – The replication state for the replication link. Possible values include: “PENDING”, “SEEDING”, “CATCH_UP”, “SUSPENDED”.

class azure.mgmt.sql.models.ReplicationLinkListResult(*, value: Optional[List[ReplicationLink]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a List database replication link request.

Parameters: value (list[ReplicationLink]) – The list of database replication links housed in the database.

class azure.mgmt.sql.models.Resource(**kwargs)[source]¶

Bases: msrest.serialization.Model

ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.sql.models.ResourceIdentity(*, type: Union[str, IdentityType, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Active Directory identity configuration for a resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

principal_id (str) – The Azure Active Directory principal id.
tenant_id (str) – The Azure Active Directory tenant id.

Parameters

type (str or IdentityType) – The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource. Possible values include: “SystemAssigned”.

class azure.mgmt.sql.models.ResourceMoveDefinition(*, id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains the information necessary to perform a resource move (rename).

All required parameters must be populated in order to send to Azure.

Parameters: id (str) – Required. The target ID for the resource.

class azure.mgmt.sql.models.RestorableDroppedDatabase(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A restorable dropped database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – The geo-location where the resource lives.
database_name (str) – The name of the database.
edition (str) – The edition of the database.
max_size_bytes (str) – The max size in bytes of the database.
service_level_objective (str) – The service level objective name of the database.
elastic_pool_name (str) – The elastic pool name of the database.
creation_date (datetime) – The creation date of the database (ISO8601 format).
deletion_date (datetime) – The deletion date of the database (ISO8601 format).
earliest_restore_date (datetime) – The earliest restore date of the database (ISO8601 format).

class azure.mgmt.sql.models.RestorableDroppedDatabaseListResult(*, value: List[RestorableDroppedDatabase], **kwargs)[source]¶

Bases: msrest.serialization.Model

The response to a list restorable dropped databases request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[RestorableDroppedDatabase]) – Required. A list of restorable dropped databases.

class azure.mgmt.sql.models.RestorableDroppedManagedDatabase(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

A restorable dropped managed database resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
database_name (str) – The name of the database.
creation_date (datetime) – The creation date of the database (ISO8601 format).
deletion_date (datetime) – The deletion date of the database (ISO8601 format).
earliest_restore_date (datetime) – The earliest restore date of the database (ISO8601 format).

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.sql.models.RestorableDroppedManagedDatabaseListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of restorable dropped managed databases.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[RestorableDroppedManagedDatabase]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.RestorePoint(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Database restore points.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location.
restore_point_type (str or RestorePointType) – The type of restore point. Possible values include: “CONTINUOUS”, “DISCRETE”.
earliest_restore_date (datetime) – The earliest time to which this database can be restored.
restore_point_creation_date (datetime) – The time the backup was taken.
restore_point_label (str) – The label of restore point for backup request by user.

class azure.mgmt.sql.models.RestorePointListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of long term retention backups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[RestorePoint]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SensitivityLabel(*, label_name: Optional[str] = None, label_id: Optional[str] = None, information_type: Optional[str] = None, information_type_id: Optional[str] = None, rank: Union[str, SensitivityLabelRank, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A sensitivity label.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
is_disabled (bool) – Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.

Parameters

label_name (str) – The label name.
label_id (str) – The label ID.
information_type (str) – The information type.
information_type_id (str) – The information type ID.
rank (str or SensitivityLabelRank) – Possible values include: “None”, “Low”, “Medium”, “High”, “Critical”.

class azure.mgmt.sql.models.SensitivityLabelListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of sensitivity labels.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SensitivityLabel]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.Server(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[ResourceIdentity] = None, administrator_login: Optional[str] = None, administrator_login_password: Optional[str] = None, version: Optional[str] = None, minimal_tls_version: Optional[str] = None, public_network_access: Union[str, ServerPublicNetworkAccess, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

An Azure SQL Database server.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Kind of sql server. This is metadata used for the Azure portal experience.
state (str) – The state of the server.
fully_qualified_domain_name (str) – The fully qualified domain name of the server.
private_endpoint_connections (list[ServerPrivateEndpointConnection]) – List of private endpoint connections on a server.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
identity (ResourceIdentity) – The Azure Active Directory identity of the server.
administrator_login (str) – Administrator username for the server. Once created it cannot be changed.
administrator_login_password (str) – The administrator login password (required for server creation).
version (str) – The version of the server.
minimal_tls_version (str) – Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’.
public_network_access (str or ServerPublicNetworkAccess) – Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.sql.models.ServerAutomaticTuning(*, desired_state: Union[str, AutomaticTuningServerMode, None] = None, options: Optional[Dict[str, AutomaticTuningServerOptions]] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Server-level Automatic Tuning.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
actual_state (str or AutomaticTuningServerMode) – Automatic tuning actual state. Possible values include: “Custom”, “Auto”, “Unspecified”.

Parameters

desired_state (str or AutomaticTuningServerMode) – Automatic tuning desired state. Possible values include: “Custom”, “Auto”, “Unspecified”.
options (dict[str, AutomaticTuningServerOptions]) – Automatic tuning options definition.

class azure.mgmt.sql.models.ServerAzureADAdministrator(*, administrator_type: Union[str, AdministratorType, None] = None, login: Optional[str] = None, sid: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Azure Active Directory administrator.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
azure_ad_only_authentication (bool) – Azure Active Directory only Authentication enabled.

Parameters

administrator_type (str or AdministratorType) – Type of the sever administrator. Possible values include: “ActiveDirectory”.
login (str) – Login name of the server administrator.
sid (str) – SID (object ID) of the server administrator.
tenant_id (str) – Tenant ID of the administrator.

class azure.mgmt.sql.models.ServerAzureADOnlyAuthentication(*, azure_ad_only_authentication: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Azure Active Directory only authentication.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

azure_ad_only_authentication (bool) – Azure Active Directory only Authentication enabled.

class azure.mgmt.sql.models.ServerBlobAuditingPolicy(*, state: Union[str, BlobAuditingPolicyState, None] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, audit_actions_and_groups: Optional[List[str]] = None, storage_account_subscription_id: Optional[str] = None, is_storage_secondary_key_in_use: Optional[bool] = None, is_azure_monitor_target_enabled: Optional[bool] = None, queue_delay_ms: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A server blob auditing policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

state (str or BlobAuditingPolicyState) – Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: “Enabled”, “Disabled”.
storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
storage_account_access_key (str) –
Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication:
1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
#. Grant SQL Server identity access to the storage account by adding ‘Storage Blob Data Contributor’ RBAC role to the server identity.

For more information, see `Auditing to storage using Managed Identity authentication

<https://go.microsoft.com/fwlink/?linkid=2114355>`_.
retention_days (int) – Specifies the number of days to keep in the audit logs in the storage account.
audit_actions_and_groups (list[str]) –
Specifies the Actions-Groups and Actions to audit.

The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:

BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP.

This above combination is also the set that is configured by default when enabling auditing from the Azure portal.

The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):

APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP

These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.

For more information, see Database-Level Audit Action Groups.

For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES

The general form for defining an action to be audited is: {action} ON {object} BY {principal}

Note that <object> in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.

For example: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public

For more information, see Database-Level Audit Actions.
storage_account_subscription_id (str) – Specifies the blob storage subscription Id.
is_storage_secondary_key_in_use (bool) – Specifies whether storageAccountAccessKey value is the storage’s secondary key.
is_azure_monitor_target_enabled (bool) –
Specifies whether audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘state’ as ‘Enabled’ and ‘isAzureMonitorTargetEnabled’ as true.

When using REST API to configure auditing, Diagnostic Settings with ‘SQLSecurityAuditEvents’ diagnostic logs category on the database should be also created. Note that for server level audit you should use the ‘master’ database as {databaseName}.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api- version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.
queue_delay_ms (int) – Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed. The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.

class azure.mgmt.sql.models.ServerBlobAuditingPolicyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of server auditing settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ServerBlobAuditingPolicy]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerCommunicationLink(*, partner_server: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Server communication link.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Communication link location.
kind (str) – Communication link kind. This property is used for Azure Portal metadata.
state (str) – The state.

Parameters

partner_server (str) – The name of the partner server.

class azure.mgmt.sql.models.ServerCommunicationLinkListResult(*, value: Optional[List[ServerCommunicationLink]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of server communication links.

Parameters: value (list[ServerCommunicationLink]) – The list of server communication links.

class azure.mgmt.sql.models.ServerConnectionPolicy(*, connection_type: Union[str, ServerConnectionType, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A server secure connection policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
kind (str) – Metadata used for the Azure portal experience.
location (str) – Resource location.

Parameters

connection_type (str or ServerConnectionType) – The server connection type. Possible values include: “Default”, “Proxy”, “Redirect”.

class azure.mgmt.sql.models.ServerDnsAlias(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A server DNS alias.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
azure_dns_record (str) – The fully qualified DNS record for alias.

class azure.mgmt.sql.models.ServerDnsAliasAcquisition(*, old_server_dns_alias_id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A server DNS alias acquisition request.

Parameters: old_server_dns_alias_id (str) – The id of the server alias that will be acquired to point to this server instead.

class azure.mgmt.sql.models.ServerDnsAliasListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of server DNS aliases.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ServerDnsAlias]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerKey(*, kind: Optional[str] = None, server_key_type: Union[str, ServerKeyType, None] = None, uri: Optional[str] = None, thumbprint: Optional[str] = None, creation_date: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A server key.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location.
subregion (str) – Subregion of the server key.

Parameters

kind (str) – Kind of encryption protector. This is metadata used for the Azure portal experience.
server_key_type (str or ServerKeyType) – The server key type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: “ServiceManaged”, “AzureKeyVault”.
uri (str) – The URI of the server key.
thumbprint (str) – Thumbprint of the server key.
creation_date (datetime) – The server key creation date.

class azure.mgmt.sql.models.ServerKeyListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of server keys.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ServerKey]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of servers.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Server]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerPrivateEndpointConnection(**kwargs)[source]¶

Bases: msrest.serialization.Model

A private endpoint connection under a server.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
properties (PrivateEndpointConnectionProperties) – Private endpoint connection properties.

class azure.mgmt.sql.models.ServerSecurityAlertPolicy(*, state: Union[str, SecurityAlertPolicyState, None] = None, disabled_alerts: Optional[List[str]] = None, email_addresses: Optional[List[str]] = None, email_account_admins: Optional[bool] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, retention_days: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A server security alert policy.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
creation_time (datetime) – Specifies the UTC creation time of the policy.

Parameters

state (str or SecurityAlertPolicyState) – Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database. Possible values include: “New”, “Enabled”, “Disabled”.
disabled_alerts (list[str]) – Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
email_addresses (list[str]) – Specifies an array of e-mail addresses to which the alert is sent.
email_account_admins (bool) – Specifies that the alert is sent to the account administrators.
storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
storage_account_access_key (str) – Specifies the identifier key of the Threat Detection audit storage account.
retention_days (int) – Specifies the number of days to keep in the Threat Detection audit logs.

class azure.mgmt.sql.models.ServerUpdate(*, tags: Optional[Dict[str, str]] = None, administrator_login: Optional[str] = None, administrator_login_password: Optional[str] = None, version: Optional[str] = None, minimal_tls_version: Optional[str] = None, public_network_access: Union[str, ServerPublicNetworkAccess, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An update request for an Azure SQL Database server.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.
administrator_login (str) – Administrator username for the server. Once created it cannot be changed.
administrator_login_password (str) – The administrator login password (required for server creation).
version (str) – The version of the server.
minimal_tls_version (str) – Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’.
public_network_access (str or ServerPublicNetworkAccess) – Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

Variables

state (str) – The state of the server.
fully_qualified_domain_name (str) – The fully qualified domain name of the server.
private_endpoint_connections (list[ServerPrivateEndpointConnection]) – List of private endpoint connections on a server.

class azure.mgmt.sql.models.ServerUsage(**kwargs)[source]¶

Bases: msrest.serialization.Model

Represents server metrics.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Name of the server usage metric.
resource_name (str) – The name of the resource.
display_name (str) – The metric display name.
current_value (float) – The current value of the metric.
limit (float) – The current limit of the metric.
unit (str) – The units of the metric.
next_reset_time (datetime) – The next reset time for the metric (ISO8601 format).

class azure.mgmt.sql.models.ServerUsageListResult(*, value: List[ServerUsage], **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a list server metrics request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[ServerUsage]) – Required. The list of server metrics for the server.

class azure.mgmt.sql.models.ServerVersionCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The server capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The server version name.
supported_editions (list[EditionCapability]) – The list of supported database editions.
supported_elastic_pool_editions (list[ElasticPoolEditionCapability]) – The list of supported elastic pool editions.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ServerVulnerabilityAssessment(*, storage_container_path: Optional[str] = None, storage_container_sas_key: Optional[str] = None, storage_account_access_key: Optional[str] = None, recurring_scans: Optional[VulnerabilityAssessmentRecurringScansProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A server vulnerability assessment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

storage_container_path (str) – A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).
storage_container_sas_key (str) – A shared access signature (SAS Key) that has read and write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required.
storage_account_access_key (str) – Specifies the identifier key of the storage account for vulnerability assessment scan results. If ‘StorageContainerSasKey’ isn’t specified, storageAccountAccessKey is required.
recurring_scans (VulnerabilityAssessmentRecurringScansProperties) – The recurring scans settings.

class azure.mgmt.sql.models.ServerVulnerabilityAssessmentListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of the server’s vulnerability assessments.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ServerVulnerabilityAssessment]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServiceObjective(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a database service objective.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
service_objective_name (str) – The name for the service objective.
is_default (bool) – Gets whether the service level objective is the default service objective.
is_system (bool) – Gets whether the service level objective is a system service objective.
description (str) – The description for the service level objective.
enabled (bool) – Gets whether the service level objective is enabled.

class azure.mgmt.sql.models.ServiceObjectiveCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The service objectives capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The unique ID of the service objective.
name (str) – The service objective name.
supported_max_sizes (list[MaxSizeRangeCapability]) – The list of supported maximum database sizes.
performance_level (PerformanceLevelCapability) – The performance level.
sku (Sku) – The sku.
supported_license_types (list[LicenseTypeCapability]) – List of supported license types.
included_max_size (MaxSizeCapability) – The included (free) max size.
zone_redundant (bool) – Whether or not zone redundancy is supported for the service objective.
supported_auto_pause_delay (AutoPauseDelayTimeRange) – Supported time range for auto pause delay.
supported_min_capacities (list[MinCapacityCapability]) – List of supported min capacities.
compute_model (str) – The compute model.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.ServiceObjectiveListResult(*, value: List[ServiceObjective], **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a get database service objectives request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[ServiceObjective]) – Required. The list of database service objectives.

class azure.mgmt.sql.models.ServiceTierAdvisor(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a Service Tier Advisor.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
observation_period_start (datetime) – The observation period start (ISO8601 format).
observation_period_end (datetime) – The observation period start (ISO8601 format).
active_time_ratio (float) – The activeTimeRatio for service tier advisor.
min_dtu (float) – Gets or sets minDtu for service tier advisor.
avg_dtu (float) – Gets or sets avgDtu for service tier advisor.
max_dtu (float) – Gets or sets maxDtu for service tier advisor.
max_size_in_gb (float) – Gets or sets maxSizeInGB for service tier advisor.
service_level_objective_usage_metrics (list[SloUsageMetric]) – Gets or sets serviceLevelObjectiveUsageMetrics for the service tier advisor.
current_service_level_objective (str) – Gets or sets currentServiceLevelObjective for service tier advisor.
current_service_level_objective_id (str) – Gets or sets currentServiceLevelObjectiveId for service tier advisor.
usage_based_recommendation_service_level_objective (str) – Gets or sets usageBasedRecommendationServiceLevelObjective for service tier advisor.
usage_based_recommendation_service_level_objective_id (str) – Gets or sets usageBasedRecommendationServiceLevelObjectiveId for service tier advisor.
database_size_based_recommendation_service_level_objective (str) – Gets or sets databaseSizeBasedRecommendationServiceLevelObjective for service tier advisor.
database_size_based_recommendation_service_level_objective_id (str) – Gets or sets databaseSizeBasedRecommendationServiceLevelObjectiveId for service tier advisor.
disaster_plan_based_recommendation_service_level_objective (str) – Gets or sets disasterPlanBasedRecommendationServiceLevelObjective for service tier advisor.
disaster_plan_based_recommendation_service_level_objective_id (str) – Gets or sets disasterPlanBasedRecommendationServiceLevelObjectiveId for service tier advisor.
overall_recommendation_service_level_objective (str) – Gets or sets overallRecommendationServiceLevelObjective for service tier advisor.
overall_recommendation_service_level_objective_id (str) – Gets or sets overallRecommendationServiceLevelObjectiveId for service tier advisor.
confidence (float) – Gets or sets confidence for service tier advisor.

class azure.mgmt.sql.models.ServiceTierAdvisorListResult(*, value: List[ServiceTierAdvisor], **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a list service tier advisor request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[ServiceTierAdvisor]) – Required. The list of service tier advisors for specified database.

class azure.mgmt.sql.models.Sku(*, name: str, tier: Optional[str] = None, size: Optional[str] = None, family: Optional[str] = None, capacity: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An ARM Resource SKU.

All required parameters must be populated in order to send to Azure.

Parameters

name (str) – Required. The name of the SKU, typically, a letter + Number code, e.g. P3.
tier (str) – The tier or edition of the particular SKU, e.g. Basic, Premium.
size (str) – Size of the particular SKU.
family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.
capacity (int) – Capacity of the particular SKU.

class azure.mgmt.sql.models.SloUsageMetric(**kwargs)[source]¶

Bases: msrest.serialization.Model

A Slo Usage Metric.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

service_level_objective (str or ServiceObjectiveName) – The serviceLevelObjective for SLO usage metric. Possible values include: “System”, “System0”, “System1”, “System2”, “System3”, “System4”, “System2L”, “System3L”, “System4L”, “Free”, “Basic”, “S0”, “S1”, “S2”, “S3”, “S4”, “S6”, “S7”, “S9”, “S12”, “P1”, “P2”, “P3”, “P4”, “P6”, “P11”, “P15”, “PRS1”, “PRS2”, “PRS4”, “PRS6”, “DW100”, “DW200”, “DW300”, “DW400”, “DW500”, “DW600”, “DW1000”, “DW1200”, “DW1000c”, “DW1500”, “DW1500c”, “DW2000”, “DW2000c”, “DW3000”, “DW2500c”, “DW3000c”, “DW6000”, “DW5000c”, “DW6000c”, “DW7500c”, “DW10000c”, “DW15000c”, “DW30000c”, “DS100”, “DS200”, “DS300”, “DS400”, “DS500”, “DS600”, “DS1000”, “DS1200”, “DS1500”, “DS2000”, “ElasticPool”.
service_level_objective_id (str) – The serviceLevelObjectiveId for SLO usage metric.
in_range_time_ratio (float) – Gets or sets inRangeTimeRatio for SLO usage metric.

class azure.mgmt.sql.models.StorageCapability(*, reason: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The storage account type capability.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

storage_account_type (str or StorageCapabilityStorageAccountType) – The storage account type for the database’s backups. Possible values include: “GRS”, “LRS”, “ZRS”.
status (str or CapabilityStatus) – The status of the capability. Possible values include: “Visible”, “Available”, “Default”, “Disabled”.

Parameters

reason (str) – The reason for the capability not being available.

class azure.mgmt.sql.models.SubscriptionUsage(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Usage Metric of a Subscription in a Location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
display_name (str) – User-readable name of the metric.
current_value (float) – Current value of the metric.
limit (float) – Boundary value of the metric.
unit (str) – Unit of the metric.

class azure.mgmt.sql.models.SubscriptionUsageListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of subscription usage metrics in a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SubscriptionUsage]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SyncAgent(*, sync_database_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An Azure SQL Database sync agent.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
name_properties_name (str) – Name of the sync agent.
last_alive_time (datetime) – Last alive time of the sync agent.
state (str or SyncAgentState) – State of the sync agent. Possible values include: “Online”, “Offline”, “NeverConnected”.
is_up_to_date (bool) – If the sync agent version is up to date.
expiry_time (datetime) – Expiration time of the sync agent version.
version (str) – Version of the sync agent.

Parameters

sync_database_id (str) – ARM resource id of the sync database in the sync agent.

class azure.mgmt.sql.models.SyncAgentKeyProperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of an Azure SQL Database sync agent key.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: sync_agent_key (str) – Key of sync agent.

class azure.mgmt.sql.models.SyncAgentLinkedDatabase(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An Azure SQL Database sync agent linked database.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
database_type (str or SyncMemberDbType) – Type of the sync agent linked database. Possible values include: “AzureSqlDatabase”, “SqlServerDatabase”.
database_id (str) – Id of the sync agent linked database.
description (str) – Description of the sync agent linked database.
server_name (str) – Server name of the sync agent linked database.
database_name (str) – Database name of the sync agent linked database.
user_name (str) – User name of the sync agent linked database.

class azure.mgmt.sql.models.SyncAgentLinkedDatabaseListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of sync agent linked databases.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SyncAgentLinkedDatabase]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SyncAgentListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of sync agents.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SyncAgent]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SyncDatabaseIdListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of sync database ID properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SyncDatabaseIdProperties]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SyncDatabaseIdProperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of the sync database id.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: id (str) – ARM resource id of sync database.

class azure.mgmt.sql.models.SyncFullSchemaProperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of the database full schema.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

tables (list[SyncFullSchemaTable]) – List of tables in the database full schema.
last_update_time (datetime) – Last update time of the database schema.

class azure.mgmt.sql.models.SyncFullSchemaPropertiesListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of sync schema properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SyncFullSchemaProperties]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SyncFullSchemaTable(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of the table in the database full schema.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

columns (list[SyncFullSchemaTableColumn]) – List of columns in the table of database full schema.
error_id (str) – Error id of the table.
has_error (bool) – If there is error in the table.
name (str) – Name of the table.
quoted_name (str) – Quoted name of the table.

class azure.mgmt.sql.models.SyncFullSchemaTableColumn(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of the column in the table of database full schema.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

data_size (str) – Data size of the column.
data_type (str) – Data type of the column.
error_id (str) – Error id of the column.
has_error (bool) – If there is error in the table.
is_primary_key (bool) – If it is the primary key of the table.
name (str) – Name of the column.
quoted_name (str) – Quoted name of the column.

class azure.mgmt.sql.models.SyncGroup(*, interval: Optional[int] = None, conflict_resolution_policy: Union[str, SyncConflictResolutionPolicy, None] = None, sync_database_id: Optional[str] = None, hub_database_user_name: Optional[str] = None, hub_database_password: Optional[str] = None, schema: Optional[SyncGroupSchema] = None, use_private_link_connection: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An Azure SQL Database sync group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
last_sync_time (datetime) – Last sync time of the sync group.
sync_state (str or SyncGroupState) – Sync state of the sync group. Possible values include: “NotReady”, “Error”, “Warning”, “Progressing”, “Good”.

Parameters

interval (int) – Sync interval of the sync group.
conflict_resolution_policy (str or SyncConflictResolutionPolicy) – Conflict resolution policy of the sync group. Possible values include: “HubWin”, “MemberWin”.
sync_database_id (str) – ARM resource id of the sync database in the sync group.
hub_database_user_name (str) – User name for the sync group hub database credential.
hub_database_password (str) – Password for the sync group hub database credential.
schema (SyncGroupSchema) – Sync schema of the sync group.
use_private_link_connection (bool) – If use private link connection is enabled.

class azure.mgmt.sql.models.SyncGroupListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of sync groups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SyncGroup]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SyncGroupLogListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of sync group log properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SyncGroupLogProperties]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SyncGroupLogProperties(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of an Azure SQL Database sync group log.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

timestamp (datetime) – Timestamp of the sync group log.
type (str or SyncGroupLogType) – Type of the sync group log. Possible values include: “All”, “Error”, “Warning”, “Success”.
source (str) – Source of the sync group log.
details (str) – Details of the sync group log.
tracing_id (str) – TracingId of the sync group log.
operation_status (str) – OperationStatus of the sync group log.

class azure.mgmt.sql.models.SyncGroupSchema(*, tables: Optional[List[SyncGroupSchemaTable]] = None, master_sync_member_name: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of sync group schema.

Parameters

tables (list[SyncGroupSchemaTable]) – List of tables in sync group schema.
master_sync_member_name (str) – Name of master sync member where the schema is from.

class azure.mgmt.sql.models.SyncGroupSchemaTable(*, columns: Optional[List[SyncGroupSchemaTableColumn]] = None, quoted_name: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of table in sync group schema.

Parameters

columns (list[SyncGroupSchemaTableColumn]) – List of columns in sync group schema.
quoted_name (str) – Quoted name of sync group schema table.

class azure.mgmt.sql.models.SyncGroupSchemaTableColumn(*, quoted_name: Optional[str] = None, data_size: Optional[str] = None, data_type: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of column in sync group table.

Parameters

quoted_name (str) – Quoted name of sync group table column.
data_size (str) – Data size of the column.
data_type (str) – Data type of the column.

class azure.mgmt.sql.models.SyncMember(*, database_type: Union[str, SyncMemberDbType, None] = None, sync_agent_id: Optional[str] = None, sql_server_database_id: Optional[str] = None, sync_member_azure_database_resource_id: Optional[str] = None, use_private_link_connection: Optional[bool] = None, server_name: Optional[str] = None, database_name: Optional[str] = None, user_name: Optional[str] = None, password: Optional[str] = None, sync_direction: Union[str, SyncDirection, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

An Azure SQL Database sync member.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
sync_state (str or SyncMemberState) – Sync state of the sync member. Possible values include: “SyncInProgress”, “SyncSucceeded”, “SyncFailed”, “DisabledTombstoneCleanup”, “DisabledBackupRestore”, “SyncSucceededWithWarnings”, “SyncCancelling”, “SyncCancelled”, “UnProvisioned”, “Provisioning”, “Provisioned”, “ProvisionFailed”, “DeProvisioning”, “DeProvisioned”, “DeProvisionFailed”, “Reprovisioning”, “ReprovisionFailed”, “UnReprovisioned”.

Parameters

database_type (str or SyncMemberDbType) – Database type of the sync member. Possible values include: “AzureSqlDatabase”, “SqlServerDatabase”.
sync_agent_id (str) – ARM resource id of the sync agent in the sync member.
sql_server_database_id (str) – SQL Server database id of the sync member.
sync_member_azure_database_resource_id (str) – ARM resource id of the sync member logical database, for sync members in Azure.
use_private_link_connection (bool) – Whether to use private link connection.
server_name (str) – Server name of the member database in the sync member.
database_name (str) – Database name of the member database in the sync member.
user_name (str) – User name of the member database in the sync member.
password (str) – Password of the member database in the sync member.
sync_direction (str or SyncDirection) – Sync direction of the sync member. Possible values include: “Bidirectional”, “OneWayMemberToHub”, “OneWayHubToMember”.

class azure.mgmt.sql.models.SyncMemberListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of Azure SQL Database sync members.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SyncMember]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.TdeCertificate(*, private_blob: Optional[str] = None, cert_password: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A TDE certificate that can be uploaded into a server.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

private_blob (str) – The base64 encoded certificate private blob.
cert_password (str) – The certificate password.

class azure.mgmt.sql.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.

class azure.mgmt.sql.models.TransparentDataEncryption(*, status: Union[str, TransparentDataEncryptionStatus, None] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a database transparent data encryption configuration.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location.

Parameters

status (str or TransparentDataEncryptionStatus) – The status of the database transparent data encryption. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.sql.models.TransparentDataEncryptionActivity(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Represents a database transparent data encryption Scan.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location.
status (str or TransparentDataEncryptionActivityStatus) – The status of the database. Possible values include: “Encrypting”, “Decrypting”.
percent_complete (float) – The percent complete of the transparent data encryption scan for a database.

class azure.mgmt.sql.models.TransparentDataEncryptionActivityListResult(*, value: List[TransparentDataEncryptionActivity], **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the response to a list database transparent data encryption activity request.

All required parameters must be populated in order to send to Azure.

Parameters: value (list[TransparentDataEncryptionActivity]) – Required. The list of database transparent data encryption activities.

class azure.mgmt.sql.models.UnlinkParameters(*, forced_termination: Optional[bool] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Represents the parameters for Unlink Replication Link request.

Parameters: forced_termination (bool) – Determines whether link will be terminated in a forced or a friendly way.

class azure.mgmt.sql.models.UpsertManagedServerOperationParameters(*, family: Optional[str] = None, tier: Optional[str] = None, v_cores: Optional[int] = None, storage_size_in_gb: Optional[int] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

UpsertManagedServerOperationParameters.

Parameters

family (str) –
tier (str) –
v_cores (int) –
storage_size_in_gb (int) –

class azure.mgmt.sql.models.UpsertManagedServerOperationStep(*, order: Optional[int] = None, name: Optional[str] = None, status: Union[str, UpsertManagedServerOperationStepStatus, None] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

UpsertManagedServerOperationStep.

Parameters

order (int) –
name (str) –
status (str or UpsertManagedServerOperationStepStatus) – Possible values include: “NotStarted”, “InProgress”, “SlowedDown”, “Completed”, “Failed”, “Canceled”.

class azure.mgmt.sql.models.Usage(**kwargs)[source]¶

Bases: msrest.serialization.Model

ARM usage.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (Name) – Resource name.
type (str) – Resource type.
unit (str) – Usage unit.
current_value (int) – Usage current value.
limit (int) – Usage limit.
requested_limit (int) – Usage requested limit.

class azure.mgmt.sql.models.UsageListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of usages.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Usage]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.VirtualCluster(*, location: str, tags: Optional[Dict[str, str]] = None, family: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.TrackedResource

An Azure SQL virtual cluster.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
subnet_id (str) – Subnet resource ID for the virtual cluster.
child_resources (list[str]) – List of resources in this virtual cluster.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – A set of tags. Resource tags.
family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

class azure.mgmt.sql.models.VirtualClusterListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of virtual clusters.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[VirtualCluster]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.VirtualClusterUpdate(*, tags: Optional[Dict[str, str]] = None, family: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An update request for an Azure SQL Database virtual cluster.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.
family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

Variables

subnet_id (str) – Subnet resource ID for the virtual cluster.
child_resources (list[str]) – List of resources in this virtual cluster.

class azure.mgmt.sql.models.VirtualNetworkRule(*, virtual_network_subnet_id: Optional[str] = None, ignore_missing_vnet_service_endpoint: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A virtual network rule.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
state (str or VirtualNetworkRuleState) – Virtual Network Rule State. Possible values include: “Initializing”, “InProgress”, “Ready”, “Deleting”, “Unknown”.

Parameters

virtual_network_subnet_id (str) – The ARM resource id of the virtual network subnet.
ignore_missing_vnet_service_endpoint (bool) – Create firewall rule before the virtual network has vnet service endpoint enabled.

class azure.mgmt.sql.models.VirtualNetworkRuleListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of virtual network rules.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[VirtualNetworkRule]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.VulnerabilityAssessmentRecurringScansProperties(*, is_enabled: Optional[bool] = None, email_subscription_admins: Optional[bool] = True, emails: Optional[List[str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of a Vulnerability Assessment recurring scans.

Parameters

is_enabled (bool) – Recurring scans state.
email_subscription_admins (bool) – Specifies that the schedule scan notification will be is sent to the subscription administrators.
emails (list[str]) – Specifies an array of e-mail addresses to which the scan notification is sent.

class azure.mgmt.sql.models.VulnerabilityAssessmentScanError(**kwargs)[source]¶

Bases: msrest.serialization.Model

Properties of a vulnerability assessment scan error.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

code (str) – The error code.
message (str) – The error message.

class azure.mgmt.sql.models.VulnerabilityAssessmentScanRecord(**kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

A vulnerability assessment scan record.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
scan_id (str) – The scan ID.
trigger_type (str or VulnerabilityAssessmentScanTriggerType) – The scan trigger type. Possible values include: “OnDemand”, “Recurring”.
state (str or VulnerabilityAssessmentScanState) – The scan status. Possible values include: “Passed”, “Failed”, “FailedToRun”, “InProgress”.
start_time (datetime) – The scan start time (UTC).
end_time (datetime) – The scan end time (UTC).
errors (list[VulnerabilityAssessmentScanError]) – The scan errors.
storage_container_path (str) – The scan results storage container path.
number_of_failed_security_checks (int) – The number of failed security checks.

class azure.mgmt.sql.models.VulnerabilityAssessmentScanRecordListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of vulnerability assessment scan records.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[VulnerabilityAssessmentScanRecord]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.WorkloadClassifier(*, member_name: Optional[str] = None, label: Optional[str] = None, context: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, importance: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Workload classifier operations for a data warehouse.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

member_name (str) – The workload classifier member name.
label (str) – The workload classifier label.
context (str) – The workload classifier context.
start_time (str) – The workload classifier start time for classification.
end_time (str) – The workload classifier end time for classification.
importance (str) – The workload classifier importance.

class azure.mgmt.sql.models.WorkloadClassifierListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of workload classifiers for a workload group.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[WorkloadClassifier]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.WorkloadGroup(*, min_resource_percent: Optional[int] = None, max_resource_percent: Optional[int] = None, min_resource_percent_per_request: Optional[float] = None, max_resource_percent_per_request: Optional[float] = None, importance: Optional[str] = None, query_execution_timeout: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.sql.models._models_py3.Resource

Workload group operations for a data warehouse.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

min_resource_percent (int) – The workload group minimum percentage resource.
max_resource_percent (int) – The workload group cap percentage resource.
min_resource_percent_per_request (float) – The workload group request minimum grant percentage.
max_resource_percent_per_request (float) – The workload group request maximum grant percentage.
importance (str) – The workload group importance level.
query_execution_timeout (int) – The workload group query execution timeout.

class azure.mgmt.sql.models.WorkloadGroupListResult(**kwargs)[source]¶

Bases: msrest.serialization.Model

A list of workload groups.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[WorkloadGroup]) – Array of results.
next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.AdministratorName[source]¶

Bases: str, enum.Enum

An enumeration.

ACTIVE_DIRECTORY = 'ActiveDirectory'¶

class azure.mgmt.sql.models.AdministratorType[source]¶

Bases: str, enum.Enum

Type of the sever administrator.

ACTIVE_DIRECTORY = 'ActiveDirectory'¶

class azure.mgmt.sql.models.AuthenticationName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'¶

class azure.mgmt.sql.models.AuthenticationType[source]¶

Bases: str, enum.Enum

The authentication type.

AD_PASSWORD = 'ADPassword'¶

SQL = 'SQL'¶

class azure.mgmt.sql.models.AutomaticTuningDisabledReason[source]¶

Bases: str, enum.Enum

Reason description if desired and actual state are different.

AUTO_CONFIGURED = 'AutoConfigured'¶

DEFAULT = 'Default'¶

DISABLED = 'Disabled'¶

INHERITED_FROM_SERVER = 'InheritedFromServer'¶

NOT_SUPPORTED = 'NotSupported'¶

QUERY_STORE_OFF = 'QueryStoreOff'¶

QUERY_STORE_READ_ONLY = 'QueryStoreReadOnly'¶

class azure.mgmt.sql.models.AutomaticTuningMode[source]¶

Bases: str, enum.Enum

Automatic tuning desired state.

AUTO = 'Auto'¶

CUSTOM = 'Custom'¶

INHERIT = 'Inherit'¶

UNSPECIFIED = 'Unspecified'¶

class azure.mgmt.sql.models.AutomaticTuningOptionModeActual[source]¶

Bases: str, enum.Enum

Automatic tuning option actual state.

OFF = 'Off'¶

ON = 'On'¶

class azure.mgmt.sql.models.AutomaticTuningOptionModeDesired[source]¶

Bases: str, enum.Enum

Automatic tuning option desired state.

DEFAULT = 'Default'¶

OFF = 'Off'¶

ON = 'On'¶

class azure.mgmt.sql.models.AutomaticTuningServerMode[source]¶

Bases: str, enum.Enum

Automatic tuning desired state.

AUTO = 'Auto'¶

CUSTOM = 'Custom'¶

UNSPECIFIED = 'Unspecified'¶

class azure.mgmt.sql.models.AutomaticTuningServerReason[source]¶

Bases: str, enum.Enum

Reason description if desired and actual state are different.

AUTO_CONFIGURED = 'AutoConfigured'¶

DEFAULT = 'Default'¶

DISABLED = 'Disabled'¶

class azure.mgmt.sql.models.BlobAuditingPolicyState[source]¶

Bases: str, enum.Enum

Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.CapabilityGroup[source]¶

Bases: str, enum.Enum

An enumeration.

SUPPORTED_EDITIONS = 'supportedEditions'¶

SUPPORTED_ELASTIC_POOL_EDITIONS = 'supportedElasticPoolEditions'¶

SUPPORTED_INSTANCE_POOL_EDITIONS = 'supportedInstancePoolEditions'¶

SUPPORTED_MANAGED_INSTANCE_EDITIONS = 'supportedManagedInstanceEditions'¶

SUPPORTED_MANAGED_INSTANCE_VERSIONS = 'supportedManagedInstanceVersions'¶

class azure.mgmt.sql.models.CapabilityStatus[source]¶

Bases: str, enum.Enum

The status of the capability.

AVAILABLE = 'Available'¶

DEFAULT = 'Default'¶

DISABLED = 'Disabled'¶

VISIBLE = 'Visible'¶

class azure.mgmt.sql.models.CatalogCollationType[source]¶

Bases: str, enum.Enum

Collation of the metadata catalog.

DATABASE_DEFAULT = 'DATABASE_DEFAULT'¶

SQL_LATIN1_GENERAL_CP1_CI_AS = 'SQL_Latin1_General_CP1_CI_AS'¶

class azure.mgmt.sql.models.CheckNameAvailabilityReason[source]¶

Bases: str, enum.Enum

The reason code explaining why the name is unavailable. Will be undefined if the name is available.

ALREADY_EXISTS = 'AlreadyExists'¶

INVALID = 'Invalid'¶

class azure.mgmt.sql.models.ConnectionPolicyName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

class azure.mgmt.sql.models.CreateMode[source]¶

Bases: str, enum.Enum

Specifies the mode of database creation.

Default: regular database creation.

Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.

Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.

PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.

Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.

Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database’s original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.

RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.

Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.

COPY = 'Copy'¶

DEFAULT = 'Default'¶

ONLINE_SECONDARY = 'OnlineSecondary'¶

POINT_IN_TIME_RESTORE = 'PointInTimeRestore'¶

RECOVERY = 'Recovery'¶

RESTORE = 'Restore'¶

RESTORE_EXTERNAL_BACKUP = 'RestoreExternalBackup'¶

RESTORE_EXTERNAL_BACKUP_SECONDARY = 'RestoreExternalBackupSecondary'¶

RESTORE_LONG_TERM_RETENTION_BACKUP = 'RestoreLongTermRetentionBackup'¶

SECONDARY = 'Secondary'¶

class azure.mgmt.sql.models.DataMaskingFunction[source]¶

Bases: str, enum.Enum

The masking function that is used for the data masking rule.

CCN = 'CCN'¶

DEFAULT = 'Default'¶

EMAIL = 'Email'¶

NUMBER = 'Number'¶

SSN = 'SSN'¶

TEXT = 'Text'¶

class azure.mgmt.sql.models.DataMaskingRuleState[source]¶

Bases: str, enum.Enum

The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn’t already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.DataMaskingState[source]¶

Bases: str, enum.Enum

The state of the data masking policy.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.DatabaseEdition[source]¶

Bases: str, enum.Enum

The edition for the database being created.

The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the Capabilities_ListByLocation REST API or one of the following commands:

az sql db list-editions -l <location> -o table
`

Get-AzSqlServerServiceObjective -Location <location>
`

BASIC = 'Basic'¶

BUSINESS = 'Business'¶

BUSINESS_CRITICAL = 'BusinessCritical'¶

DATA_WAREHOUSE = 'DataWarehouse'¶

FREE = 'Free'¶

GENERAL_PURPOSE = 'GeneralPurpose'¶

HYPERSCALE = 'Hyperscale'¶

PREMIUM = 'Premium'¶

PREMIUM_RS = 'PremiumRS'¶

STANDARD = 'Standard'¶

STRETCH = 'Stretch'¶

SYSTEM = 'System'¶

SYSTEM2 = 'System2'¶

WEB = 'Web'¶

class azure.mgmt.sql.models.DatabaseLicenseType[source]¶

Bases: str, enum.Enum

The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.

BASE_PRICE = 'BasePrice'¶

LICENSE_INCLUDED = 'LicenseIncluded'¶

class azure.mgmt.sql.models.DatabaseReadScale[source]¶

Bases: str, enum.Enum

If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica. This property is only settable for Premium and Business Critical databases.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.DatabaseState[source]¶

Bases: str, enum.Enum

An enumeration.

ALL = 'All'¶

DELETED = 'Deleted'¶

LIVE = 'Live'¶

class azure.mgmt.sql.models.DatabaseStatus[source]¶

Bases: str, enum.Enum

The status of the database.

AUTO_CLOSED = 'AutoClosed'¶

COPYING = 'Copying'¶

CREATING = 'Creating'¶

DISABLED = 'Disabled'¶

EMERGENCY_MODE = 'EmergencyMode'¶

INACCESSIBLE = 'Inaccessible'¶

OFFLINE = 'Offline'¶

OFFLINE_CHANGING_DW_PERFORMANCE_TIERS = 'OfflineChangingDwPerformanceTiers'¶

OFFLINE_SECONDARY = 'OfflineSecondary'¶

ONLINE = 'Online'¶

ONLINE_CHANGING_DW_PERFORMANCE_TIERS = 'OnlineChangingDwPerformanceTiers'¶

PAUSED = 'Paused'¶

PAUSING = 'Pausing'¶

RECOVERING = 'Recovering'¶

RECOVERY_PENDING = 'RecoveryPending'¶

RESTORING = 'Restoring'¶

RESUMING = 'Resuming'¶

SCALING = 'Scaling'¶

SHUTDOWN = 'Shutdown'¶

STANDBY = 'Standby'¶

SUSPECT = 'Suspect'¶

class azure.mgmt.sql.models.DiffBackupIntervalInHours[source]¶

Bases: int, enum.Enum

The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.

TWELVE = 12¶

TWENTY_FOUR = 24¶

class azure.mgmt.sql.models.ElasticPoolEdition[source]¶

Bases: str, enum.Enum

The edition of the recommended elastic pool. The ElasticPoolEdition enumeration contains all the valid editions.

BASIC = 'Basic'¶

BUSINESS_CRITICAL = 'BusinessCritical'¶

GENERAL_PURPOSE = 'GeneralPurpose'¶

PREMIUM = 'Premium'¶

STANDARD = 'Standard'¶

class azure.mgmt.sql.models.ElasticPoolLicenseType[source]¶

Bases: str, enum.Enum

The license type to apply for this elastic pool.

BASE_PRICE = 'BasePrice'¶

LICENSE_INCLUDED = 'LicenseIncluded'¶

class azure.mgmt.sql.models.ElasticPoolState[source]¶

Bases: str, enum.Enum

The state of the elastic pool.

CREATING = 'Creating'¶

DISABLED = 'Disabled'¶

READY = 'Ready'¶

class azure.mgmt.sql.models.EncryptionProtectorName[source]¶

Bases: str, enum.Enum

An enumeration.

CURRENT = 'current'¶

class azure.mgmt.sql.models.Enum65[source]¶

Bases: str, enum.Enum

An enumeration.

ALL = 'All'¶

ERROR = 'Error'¶

SUCCESS = 'Success'¶

WARNING = 'Warning'¶

class azure.mgmt.sql.models.ExtensionName[source]¶

Bases: str, enum.Enum

An enumeration.

IMPORT_ENUM = 'import'¶

class azure.mgmt.sql.models.FailoverGroupReplicationRole[source]¶

Bases: str, enum.Enum

Local replication role of the failover group instance.

PRIMARY = 'Primary'¶

SECONDARY = 'Secondary'¶

class azure.mgmt.sql.models.GeoBackupPolicyName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'¶

class azure.mgmt.sql.models.GeoBackupPolicyState[source]¶

Bases: str, enum.Enum

The state of the geo backup policy.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.IdentityType[source]¶

Bases: str, enum.Enum

The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource.

SYSTEM_ASSIGNED = 'SystemAssigned'¶

class azure.mgmt.sql.models.InstanceFailoverGroupReplicationRole[source]¶

Bases: str, enum.Enum

Local replication role of the failover group instance.

PRIMARY = 'Primary'¶

SECONDARY = 'Secondary'¶

class azure.mgmt.sql.models.InstancePoolLicenseType[source]¶

Bases: str, enum.Enum

The license type. Possible values are ‘LicenseIncluded’ (price for SQL license is included) and ‘BasePrice’ (without SQL license price).

BASE_PRICE = 'BasePrice'¶

LICENSE_INCLUDED = 'LicenseIncluded'¶

class azure.mgmt.sql.models.JobAgentState[source]¶

Bases: str, enum.Enum

The state of the job agent.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

DISABLED = 'Disabled'¶

READY = 'Ready'¶

UPDATING = 'Updating'¶

class azure.mgmt.sql.models.JobExecutionLifecycle[source]¶

Bases: str, enum.Enum

The detailed state of the job execution.

CANCELED = 'Canceled'¶

CREATED = 'Created'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

SKIPPED = 'Skipped'¶

SUCCEEDED = 'Succeeded'¶

SUCCEEDED_WITH_SKIPPED = 'SucceededWithSkipped'¶

TIMED_OUT = 'TimedOut'¶

WAITING_FOR_CHILD_JOB_EXECUTIONS = 'WaitingForChildJobExecutions'¶

WAITING_FOR_RETRY = 'WaitingForRetry'¶

class azure.mgmt.sql.models.JobScheduleType[source]¶

Bases: str, enum.Enum

Schedule interval type

ONCE = 'Once'¶

RECURRING = 'Recurring'¶

class azure.mgmt.sql.models.JobStepActionSource[source]¶

Bases: str, enum.Enum

The source of the action to execute.

INLINE = 'Inline'¶

class azure.mgmt.sql.models.JobStepActionType[source]¶

Bases: str, enum.Enum

Type of action being executed by the job step.

T_SQL = 'TSql'¶

class azure.mgmt.sql.models.JobStepOutputType[source]¶

Bases: str, enum.Enum

The output destination type.

SQL_DATABASE = 'SqlDatabase'¶

class azure.mgmt.sql.models.JobTargetGroupMembershipType[source]¶

Bases: str, enum.Enum

Whether the target is included or excluded from the group.

EXCLUDE = 'Exclude'¶

INCLUDE = 'Include'¶

class azure.mgmt.sql.models.JobTargetType[source]¶

Bases: str, enum.Enum

The type of the target.

SQL_DATABASE = 'SqlDatabase'¶

SQL_ELASTIC_POOL = 'SqlElasticPool'¶

SQL_SERVER = 'SqlServer'¶

SQL_SHARD_MAP = 'SqlShardMap'¶

TARGET_GROUP = 'TargetGroup'¶

class azure.mgmt.sql.models.LogSizeUnit[source]¶

Bases: str, enum.Enum

The units that the limit is expressed in.

GIGABYTES = 'Gigabytes'¶

MEGABYTES = 'Megabytes'¶

PERCENT = 'Percent'¶

PETABYTES = 'Petabytes'¶

TERABYTES = 'Terabytes'¶

class azure.mgmt.sql.models.LongTermRetentionDatabaseState[source]¶

Bases: str, enum.Enum

An enumeration.

ALL = 'All'¶

DELETED = 'Deleted'¶

LIVE = 'Live'¶

class azure.mgmt.sql.models.LongTermRetentionPolicyName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

class azure.mgmt.sql.models.ManagedDatabaseCreateMode[source]¶

Bases: str, enum.Enum

Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required).

DEFAULT = 'Default'¶

POINT_IN_TIME_RESTORE = 'PointInTimeRestore'¶

RECOVERY = 'Recovery'¶

RESTORE_EXTERNAL_BACKUP = 'RestoreExternalBackup'¶

RESTORE_LONG_TERM_RETENTION_BACKUP = 'RestoreLongTermRetentionBackup'¶

class azure.mgmt.sql.models.ManagedDatabaseStatus[source]¶

Bases: str, enum.Enum

Status of the database.

CREATING = 'Creating'¶

INACCESSIBLE = 'Inaccessible'¶

OFFLINE = 'Offline'¶

ONLINE = 'Online'¶

RESTORING = 'Restoring'¶

SHUTDOWN = 'Shutdown'¶

UPDATING = 'Updating'¶

class azure.mgmt.sql.models.ManagedInstanceAdministratorType[source]¶

Bases: str, enum.Enum

Type of the managed instance administrator.

ACTIVE_DIRECTORY = 'ActiveDirectory'¶

class azure.mgmt.sql.models.ManagedInstanceLicenseType[source]¶

Bases: str, enum.Enum

The license type. Possible values are ‘LicenseIncluded’ (regular price inclusive of a new SQL license) and ‘BasePrice’ (discounted AHB price for bringing your own SQL licenses).

BASE_PRICE = 'BasePrice'¶

LICENSE_INCLUDED = 'LicenseIncluded'¶

class azure.mgmt.sql.models.ManagedInstanceLongTermRetentionPolicyName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

class azure.mgmt.sql.models.ManagedInstancePropertiesProvisioningState[source]¶

Bases: str, enum.Enum

An enumeration.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UNKNOWN = 'Unknown'¶

UPDATING = 'Updating'¶

class azure.mgmt.sql.models.ManagedInstanceProxyOverride[source]¶

Bases: str, enum.Enum

Connection type used for connecting to the instance.

DEFAULT = 'Default'¶

PROXY = 'Proxy'¶

REDIRECT = 'Redirect'¶

class azure.mgmt.sql.models.ManagedServerCreateMode[source]¶

Bases: str, enum.Enum

Specifies the mode of database creation.

Default: Regular instance creation.

Restore: Creates an instance by restoring a set of backups to specific point in time. RestorePointInTime and SourceManagedInstanceId must be specified.

DEFAULT = 'Default'¶

POINT_IN_TIME_RESTORE = 'PointInTimeRestore'¶

class azure.mgmt.sql.models.ManagedShortTermRetentionPolicyName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

class azure.mgmt.sql.models.ManagementOperationState[source]¶

Bases: str, enum.Enum

The operation state.

CANCELLED = 'Cancelled'¶

CANCEL_IN_PROGRESS = 'CancelInProgress'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

PENDING = 'Pending'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.sql.models.MaxSizeUnit[source]¶

Bases: str, enum.Enum

The units that the limit is expressed in.

GIGABYTES = 'Gigabytes'¶

MEGABYTES = 'Megabytes'¶

PETABYTES = 'Petabytes'¶

TERABYTES = 'Terabytes'¶

class azure.mgmt.sql.models.OperationOrigin[source]¶

Bases: str, enum.Enum

The intended executor of the operation.

SYSTEM = 'system'¶

USER = 'user'¶

class azure.mgmt.sql.models.PauseDelayTimeUnit[source]¶

Bases: str, enum.Enum

Unit of time that delay is expressed in

MINUTES = 'Minutes'¶

class azure.mgmt.sql.models.PerformanceLevelUnit[source]¶

Bases: str, enum.Enum

Unit type used to measure performance level.

DTU = 'DTU'¶

V_CORES = 'VCores'¶

class azure.mgmt.sql.models.PrimaryAggregationType[source]¶

Bases: str, enum.Enum

The primary aggregation type defining how metric values are displayed.

AVERAGE = 'Average'¶

COUNT = 'Count'¶

MAXIMUM = 'Maximum'¶

MINIMUM = 'Minimum'¶

NONE = 'None'¶

TOTAL = 'Total'¶

class azure.mgmt.sql.models.PrivateEndpointProvisioningState[source]¶

Bases: str, enum.Enum

State of the private endpoint connection.

APPROVING = 'Approving'¶

DROPPING = 'Dropping'¶

FAILED = 'Failed'¶

READY = 'Ready'¶

REJECTING = 'Rejecting'¶

class azure.mgmt.sql.models.PrivateLinkServiceConnectionStateActionsRequire[source]¶

Bases: str, enum.Enum

The actions required for private link service connection.

NONE = 'None'¶

class azure.mgmt.sql.models.PrivateLinkServiceConnectionStateStatus[source]¶

Bases: str, enum.Enum

The private link service connection status.

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.sql.models.ProvisioningState[source]¶

Bases: str, enum.Enum

The ARM provisioning state of the job execution.

CANCELED = 'Canceled'¶

CREATED = 'Created'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.sql.models.ReadOnlyEndpointFailoverPolicy[source]¶

Bases: str, enum.Enum

Failover policy of the read-only endpoint for the failover group.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.ReadWriteEndpointFailoverPolicy[source]¶

Bases: str, enum.Enum

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

AUTOMATIC = 'Automatic'¶

MANUAL = 'Manual'¶

class azure.mgmt.sql.models.RecommendedIndexAction[source]¶

Bases: str, enum.Enum

The proposed index action. You can create a missing index, drop an unused index, or rebuild an existing index to improve its performance.

CREATE = 'Create'¶

DROP = 'Drop'¶

REBUILD = 'Rebuild'¶

class azure.mgmt.sql.models.RecommendedIndexState[source]¶

Bases: str, enum.Enum

The current recommendation state.

ACTIVE = 'Active'¶

BLOCKED = 'Blocked'¶

EXECUTING = 'Executing'¶

EXPIRED = 'Expired'¶

IGNORED = 'Ignored'¶

PENDING = 'Pending'¶

PENDING_REVERT = 'Pending Revert'¶

REVERTED = 'Reverted'¶

REVERTING = 'Reverting'¶

SUCCESS = 'Success'¶

VERIFYING = 'Verifying'¶

class azure.mgmt.sql.models.RecommendedIndexType[source]¶

Bases: str, enum.Enum

The type of index (CLUSTERED, NONCLUSTERED, COLUMNSTORE, CLUSTERED COLUMNSTORE)

CLUSTERED = 'CLUSTERED'¶

CLUSTERED_COLUMNSTORE = 'CLUSTERED COLUMNSTORE'¶

COLUMNSTORE = 'COLUMNSTORE'¶

NONCLUSTERED = 'NONCLUSTERED'¶

class azure.mgmt.sql.models.ReplicaType[source]¶

Bases: str, enum.Enum

An enumeration.

PRIMARY = 'Primary'¶

READABLE_SECONDARY = 'ReadableSecondary'¶

class azure.mgmt.sql.models.ReplicationRole[source]¶

Bases: str, enum.Enum

The role of the database in the replication link.

COPY = 'Copy'¶

NON_READABLE_SECONDARY = 'NonReadableSecondary'¶

PRIMARY = 'Primary'¶

SECONDARY = 'Secondary'¶

SOURCE = 'Source'¶

class azure.mgmt.sql.models.ReplicationState[source]¶

Bases: str, enum.Enum

The replication state for the replication link.

CATCH_UP = 'CATCH_UP'¶

PENDING = 'PENDING'¶

SEEDING = 'SEEDING'¶

SUSPENDED = 'SUSPENDED'¶

class azure.mgmt.sql.models.RestoreDetailsName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'¶

class azure.mgmt.sql.models.RestorePointType[source]¶

Bases: str, enum.Enum

The type of restore point

CONTINUOUS = 'CONTINUOUS'¶

DISCRETE = 'DISCRETE'¶

class azure.mgmt.sql.models.SampleName[source]¶

Bases: str, enum.Enum

The name of the sample schema to apply when creating this database.

ADVENTURE_WORKS_LT = 'AdventureWorksLT'¶

WIDE_WORLD_IMPORTERS_FULL = 'WideWorldImportersFull'¶

WIDE_WORLD_IMPORTERS_STD = 'WideWorldImportersStd'¶

class azure.mgmt.sql.models.SecurityAlertPolicyEmailAccountAdmins[source]¶

Bases: str, enum.Enum

Specifies that the alert is sent to the account administrators.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.SecurityAlertPolicyName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

class azure.mgmt.sql.models.SecurityAlertPolicyNameAutoGenerated[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'¶

class azure.mgmt.sql.models.SecurityAlertPolicyState[source]¶

Bases: str, enum.Enum

Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

NEW = 'New'¶

class azure.mgmt.sql.models.SecurityAlertPolicyUseServerDefault[source]¶

Bases: str, enum.Enum

Specifies whether to use the default server policy.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.SensitivityLabelRank[source]¶

Bases: str, enum.Enum

An enumeration.

CRITICAL = 'Critical'¶

HIGH = 'High'¶

LOW = 'Low'¶

MEDIUM = 'Medium'¶

NONE = 'None'¶

class azure.mgmt.sql.models.SensitivityLabelSource[source]¶

Bases: str, enum.Enum

An enumeration.

CURRENT = 'current'¶

RECOMMENDED = 'recommended'¶

class azure.mgmt.sql.models.ServerConnectionType[source]¶

Bases: str, enum.Enum

The server connection type.

DEFAULT = 'Default'¶

PROXY = 'Proxy'¶

REDIRECT = 'Redirect'¶

class azure.mgmt.sql.models.ServerKeyType[source]¶

Bases: str, enum.Enum

The encryption protector type like ‘ServiceManaged’, ‘AzureKeyVault’.

AZURE_KEY_VAULT = 'AzureKeyVault'¶

SERVICE_MANAGED = 'ServiceManaged'¶

class azure.mgmt.sql.models.ServerPublicNetworkAccess[source]¶

Bases: str, enum.Enum

Whether or not public endpoint access is allowed for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.ServiceObjectiveName[source]¶

Bases: str, enum.Enum

The name of the service objective to assign to the database.

BASIC = 'Basic'¶

DS100 = 'DS100'¶

DS1000 = 'DS1000'¶

DS1200 = 'DS1200'¶

DS1500 = 'DS1500'¶

DS200 = 'DS200'¶

DS2000 = 'DS2000'¶

DS300 = 'DS300'¶

DS400 = 'DS400'¶

DS500 = 'DS500'¶

DS600 = 'DS600'¶

DW100 = 'DW100'¶

DW1000 = 'DW1000'¶

DW10000_C = 'DW10000c'¶

DW1000_C = 'DW1000c'¶

DW1200 = 'DW1200'¶

DW1500 = 'DW1500'¶

DW15000_C = 'DW15000c'¶

DW1500_C = 'DW1500c'¶

DW200 = 'DW200'¶

DW2000 = 'DW2000'¶

DW2000_C = 'DW2000c'¶

DW2500_C = 'DW2500c'¶

DW300 = 'DW300'¶

DW3000 = 'DW3000'¶

DW30000_C = 'DW30000c'¶

DW3000_C = 'DW3000c'¶

DW400 = 'DW400'¶

DW500 = 'DW500'¶

DW5000_C = 'DW5000c'¶

DW600 = 'DW600'¶

DW6000 = 'DW6000'¶

DW6000_C = 'DW6000c'¶

DW7500_C = 'DW7500c'¶

ELASTIC_POOL = 'ElasticPool'¶

FREE = 'Free'¶

P1 = 'P1'¶

P11 = 'P11'¶

P15 = 'P15'¶

P2 = 'P2'¶

P3 = 'P3'¶

P4 = 'P4'¶

P6 = 'P6'¶

PRS1 = 'PRS1'¶

PRS2 = 'PRS2'¶

PRS4 = 'PRS4'¶

PRS6 = 'PRS6'¶

S0 = 'S0'¶

S1 = 'S1'¶

S12 = 'S12'¶

S2 = 'S2'¶

S3 = 'S3'¶

S4 = 'S4'¶

S6 = 'S6'¶

S7 = 'S7'¶

S9 = 'S9'¶

SYSTEM = 'System'¶

SYSTEM0 = 'System0'¶

SYSTEM1 = 'System1'¶

SYSTEM2 = 'System2'¶

SYSTEM2_L = 'System2L'¶

SYSTEM3 = 'System3'¶

SYSTEM3_L = 'System3L'¶

SYSTEM4 = 'System4'¶

SYSTEM4_L = 'System4L'¶

class azure.mgmt.sql.models.ShortTermRetentionPolicyName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

class azure.mgmt.sql.models.StorageAccountType[source]¶

Bases: str, enum.Enum

The storage account type used to store backups for this instance. The options are LRS (LocallyRedundantStorage), ZRS (ZoneRedundantStorage) and GRS (GeoRedundantStorage)

GRS = 'GRS'¶

LRS = 'LRS'¶

ZRS = 'ZRS'¶

class azure.mgmt.sql.models.StorageCapabilityStorageAccountType[source]¶

Bases: str, enum.Enum

The storage account type for the database’s backups.

GRS = 'GRS'¶

LRS = 'LRS'¶

ZRS = 'ZRS'¶

class azure.mgmt.sql.models.StorageKeyType[source]¶

Bases: str, enum.Enum

The type of the storage key to use.

SHARED_ACCESS_KEY = 'SharedAccessKey'¶

STORAGE_ACCESS_KEY = 'StorageAccessKey'¶

class azure.mgmt.sql.models.SyncAgentState[source]¶

Bases: str, enum.Enum

State of the sync agent.

NEVER_CONNECTED = 'NeverConnected'¶

OFFLINE = 'Offline'¶

ONLINE = 'Online'¶

class azure.mgmt.sql.models.SyncConflictResolutionPolicy[source]¶

Bases: str, enum.Enum

Conflict resolution policy of the sync group.

HUB_WIN = 'HubWin'¶

MEMBER_WIN = 'MemberWin'¶

class azure.mgmt.sql.models.SyncDirection[source]¶

Bases: str, enum.Enum

Sync direction of the sync member.

BIDIRECTIONAL = 'Bidirectional'¶

ONE_WAY_HUB_TO_MEMBER = 'OneWayHubToMember'¶

ONE_WAY_MEMBER_TO_HUB = 'OneWayMemberToHub'¶

class azure.mgmt.sql.models.SyncGroupLogType[source]¶

Bases: str, enum.Enum

Type of the sync group log.

ALL = 'All'¶

ERROR = 'Error'¶

SUCCESS = 'Success'¶

WARNING = 'Warning'¶

class azure.mgmt.sql.models.SyncGroupState[source]¶

Bases: str, enum.Enum

Sync state of the sync group.

ERROR = 'Error'¶

GOOD = 'Good'¶

NOT_READY = 'NotReady'¶

PROGRESSING = 'Progressing'¶

WARNING = 'Warning'¶

class azure.mgmt.sql.models.SyncMemberDbType[source]¶

Bases: str, enum.Enum

Type of the sync agent linked database.

AZURE_SQL_DATABASE = 'AzureSqlDatabase'¶

SQL_SERVER_DATABASE = 'SqlServerDatabase'¶

class azure.mgmt.sql.models.SyncMemberState[source]¶

Bases: str, enum.Enum

Sync state of the sync member.

DE_PROVISIONED = 'DeProvisioned'¶

DE_PROVISIONING = 'DeProvisioning'¶

DE_PROVISION_FAILED = 'DeProvisionFailed'¶

DISABLED_BACKUP_RESTORE = 'DisabledBackupRestore'¶

DISABLED_TOMBSTONE_CLEANUP = 'DisabledTombstoneCleanup'¶

PROVISIONED = 'Provisioned'¶

PROVISIONING = 'Provisioning'¶

PROVISION_FAILED = 'ProvisionFailed'¶

REPROVISIONING = 'Reprovisioning'¶

REPROVISION_FAILED = 'ReprovisionFailed'¶

SYNC_CANCELLED = 'SyncCancelled'¶

SYNC_CANCELLING = 'SyncCancelling'¶

SYNC_FAILED = 'SyncFailed'¶

SYNC_IN_PROGRESS = 'SyncInProgress'¶

SYNC_SUCCEEDED = 'SyncSucceeded'¶

SYNC_SUCCEEDED_WITH_WARNINGS = 'SyncSucceededWithWarnings'¶

UN_PROVISIONED = 'UnProvisioned'¶

UN_REPROVISIONED = 'UnReprovisioned'¶

class azure.mgmt.sql.models.TransparentDataEncryptionActivityStatus[source]¶

Bases: str, enum.Enum

The status of the database.

DECRYPTING = 'Decrypting'¶

ENCRYPTING = 'Encrypting'¶

class azure.mgmt.sql.models.TransparentDataEncryptionName[source]¶

Bases: str, enum.Enum

An enumeration.

CURRENT = 'current'¶

class azure.mgmt.sql.models.TransparentDataEncryptionStatus[source]¶

Bases: str, enum.Enum

The status of the database transparent data encryption.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.sql.models.UnitDefinitionType[source]¶

Bases: str, enum.Enum

The unit of the metric.

BYTES = 'Bytes'¶

BYTES_PER_SECOND = 'BytesPerSecond'¶

COUNT = 'Count'¶

COUNT_PER_SECOND = 'CountPerSecond'¶

PERCENT = 'Percent'¶

SECONDS = 'Seconds'¶

class azure.mgmt.sql.models.UnitType[source]¶

Bases: str, enum.Enum

The unit of the metric.

BYTES = 'bytes'¶

BYTES_PER_SECOND = 'bytesPerSecond'¶

COUNT = 'count'¶

COUNT_PER_SECOND = 'countPerSecond'¶

PERCENT = 'percent'¶

SECONDS = 'seconds'¶

class azure.mgmt.sql.models.UpsertManagedServerOperationStepStatus[source]¶

Bases: str, enum.Enum

An enumeration.

CANCELED = 'Canceled'¶

COMPLETED = 'Completed'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

NOT_STARTED = 'NotStarted'¶

SLOWED_DOWN = 'SlowedDown'¶

class azure.mgmt.sql.models.VirtualNetworkRuleState[source]¶

Bases: str, enum.Enum

Virtual Network Rule State

DELETING = 'Deleting'¶

INITIALIZING = 'Initializing'¶

IN_PROGRESS = 'InProgress'¶

READY = 'Ready'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.sql.models.VulnerabilityAssessmentName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

class azure.mgmt.sql.models.VulnerabilityAssessmentPolicyBaselineName[source]¶

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'¶

MASTER = 'master'¶

class azure.mgmt.sql.models.VulnerabilityAssessmentScanState[source]¶

Bases: str, enum.Enum

The scan status.

FAILED = 'Failed'¶

FAILED_TO_RUN = 'FailedToRun'¶

IN_PROGRESS = 'InProgress'¶

PASSED = 'Passed'¶

class azure.mgmt.sql.models.VulnerabilityAssessmentScanTriggerType[source]¶

Bases: str, enum.Enum

The scan trigger type.

ON_DEMAND = 'OnDemand'¶

RECURRING = 'Recurring'¶