azure.mgmt.sql.models module

class azure.mgmt.sql.models.AdministratorListResult(**kwargs)

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.AdministratorName(value)

Bases: str, enum.Enum

An enumeration.

ACTIVE_DIRECTORY = 'ActiveDirectory'

class azure.mgmt.sql.models.AdministratorType(value)

Bases: str, enum.Enum

Type of the sever administrator.

ACTIVE_DIRECTORY = 'ActiveDirectory'

class azure.mgmt.sql.models.Advisor(*, auto_execute_status: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.AutoExecuteStatus]] = None, **kwargs)

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

Database, Server or Elastic Pool 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.

• kind (str) – Resource kind.

• location (str) – Resource location.

• advisor_status (str or AdvisorStatus) – Gets the status of availability of this advisor to customers. Possible values are ‘GA’, ‘PublicPreview’, ‘LimitedPublicPreview’ and ‘PrivatePreview’. Possible values include: “GA”, “PublicPreview”, “LimitedPublicPreview”, “PrivatePreview”.

• auto_execute_status (str or AutoExecuteStatus) – Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are ‘Enabled’ and ‘Disabled’. Possible values include: “Enabled”, “Disabled”, “Default”.

• auto_execute_status_inherited_from (str or AutoExecuteStatusInheritedFrom) – Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are ‘Subscription’, ‘Server’, ‘ElasticPool’, ‘Database’ and ‘Default’ (when status is not explicitly set on any level). Possible values include: “Default”, “Subscription”, “Server”, “ElasticPool”, “Database”.

• recommendations_status (str) – Gets that status of recommendations for this advisor and reason for not having any recommendations. Possible values include, but are not limited to, ‘Ok’ (Recommendations available),LowActivity (not enough workload to analyze), ‘DbSeemsTuned’ (Database is doing well), etc.

• last_checked (datetime) – Gets the time when the current resource was analyzed for recommendations by this advisor.

• recommended_actions (list[RecommendedAction]) – Gets the recommended actions for this advisor.

Keyword Arguments

auto_execute_status (str or AutoExecuteStatus) – Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are ‘Enabled’ and ‘Disabled’. Possible values include: “Enabled”, “Disabled”, “Default”.

class azure.mgmt.sql.models.AdvisorStatus(value)

Bases: str, enum.Enum

Gets the status of availability of this advisor to customers. Possible values are ‘GA’, ‘PublicPreview’, ‘LimitedPublicPreview’ and ‘PrivatePreview’.

GA = 'GA'

LIMITED_PUBLIC_PREVIEW = 'LimitedPublicPreview'

PRIVATE_PREVIEW = 'PrivatePreview'

PUBLIC_PREVIEW = 'PublicPreview'

class azure.mgmt.sql.models.AggregationFunctionType(value)

Bases: str, enum.Enum

An enumeration.

AVG = 'avg'

MAX = 'max'

MIN = 'min'

STDEV = 'stdev'

SUM = 'sum'

class azure.mgmt.sql.models.AuthenticationName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'

class azure.mgmt.sql.models.AutoExecuteStatus(value)

Bases: str, enum.Enum

Gets the auto-execute status (whether to let the system execute the recommendations) of this advisor. Possible values are ‘Enabled’ and ‘Disabled’

DEFAULT = 'Default'

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.sql.models.AutoExecuteStatusInheritedFrom(value)

Bases: str, enum.Enum

Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are ‘Subscription’, ‘Server’, ‘ElasticPool’, ‘Database’ and ‘Default’ (when status is not explicitly set on any level).

DATABASE = 'Database'

DEFAULT = 'Default'

ELASTIC_POOL = 'ElasticPool'

SERVER = 'Server'

SUBSCRIPTION = 'Subscription'

class azure.mgmt.sql.models.AutoPauseDelayTimeRange(**kwargs)

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.AutomaticTuningDisabledReason(value)

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(value)

Bases: str, enum.Enum

Automatic tuning desired state.

AUTO = 'Auto'

CUSTOM = 'Custom'

INHERIT = 'Inherit'

UNSPECIFIED = 'Unspecified'

class azure.mgmt.sql.models.AutomaticTuningOptionModeActual(value)

Bases: str, enum.Enum

Automatic tuning option actual state.

OFF = 'Off'

ON = 'On'

class azure.mgmt.sql.models.AutomaticTuningOptionModeDesired(value)

Bases: str, enum.Enum

Automatic tuning option desired state.

DEFAULT = 'Default'

OFF = 'Off'

ON = 'On'

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

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.

Variables

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

• 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”.

Keyword Arguments

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

class azure.mgmt.sql.models.AutomaticTuningServerMode(value)

Bases: str, enum.Enum

Automatic tuning desired state.

AUTO = 'Auto'

CUSTOM = 'Custom'

UNSPECIFIED = 'Unspecified'

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

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.

Variables

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

• 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”.

Keyword Arguments

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

class azure.mgmt.sql.models.AutomaticTuningServerReason(value)

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.AzureADOnlyAuthListResult(**kwargs)

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.BackupShortTermRetentionPolicy(*, retention_days: Optional[int] = None, diff_backup_interval_in_hours: Optional[Union[int, azure.mgmt.sql.models._sql_management_client_enums.DiffBackupIntervalInHours]] = None, **kwargs)

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

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.

• 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 (int 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.

Keyword Arguments

• 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 (int 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)

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.BackupStorageRedundancy(value)

Bases: str, enum.Enum

The storage account type used to store backups for this database.

GEO = 'Geo'

GEO_ZONE = 'GeoZone'

LOCAL = 'Local'

ZONE = 'Zone'

class azure.mgmt.sql.models.BlobAuditingPolicyState(value)

Bases: str, enum.Enum

Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.sql.models.CapabilityGroup(value)

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(value)

Bases: str, enum.Enum

The status of the capability.

AVAILABLE = 'Available'

DEFAULT = 'Default'

DISABLED = 'Disabled'

VISIBLE = 'Visible'

class azure.mgmt.sql.models.CatalogCollationType(value)

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(value)

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.CheckNameAvailabilityRequest(*, name: str, **kwargs)

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.

Variables

• name (str) – Required.

• type (str) – Has constant value: “Microsoft.Sql/servers”.

Keyword Arguments

name (str) – Required.

type = 'Microsoft.Sql/servers'

class azure.mgmt.sql.models.CheckNameAvailabilityResponse(**kwargs)

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.ColumnDataType(value)

Bases: str, enum.Enum

The column data type.

BIGINT = 'bigint'

BINARY = 'binary'

BIT = 'bit'

CHAR = 'char'

DATE = 'date'

DATETIME = 'datetime'

DATETIME2 = 'datetime2'

DATETIMEOFFSET = 'datetimeoffset'

DECIMAL = 'decimal'

FLOAT = 'float'

GEOGRAPHY = 'geography'

GEOMETRY = 'geometry'

HIERARCHYID = 'hierarchyid'

IMAGE = 'image'

INT = 'int'

MONEY = 'money'

NCHAR = 'nchar'

NTEXT = 'ntext'

NUMERIC = 'numeric'

NVARCHAR = 'nvarchar'

REAL = 'real'

SMALLDATETIME = 'smalldatetime'

SMALLINT = 'smallint'

SMALLMONEY = 'smallmoney'

SQL_VARIANT = 'sql_variant'

SYSNAME = 'sysname'

TEXT = 'text'

TIME = 'time'

TIMESTAMP = 'timestamp'

TINYINT = 'tinyint'

UNIQUEIDENTIFIER = 'uniqueidentifier'

VARBINARY = 'varbinary'

VARCHAR = 'varchar'

XML = 'xml'

class azure.mgmt.sql.models.CompleteDatabaseRestoreDefinition(*, last_backup_name: str, **kwargs)

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.

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.ConnectionPolicyName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'

class azure.mgmt.sql.models.CopyLongTermRetentionBackupParameters(*, target_subscription_id: Optional[str] = None, target_resource_group: Optional[str] = None, target_server_resource_id: Optional[str] = None, target_server_fully_qualified_domain_name: Optional[str] = None, target_database_name: Optional[str] = None, target_backup_storage_redundancy: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BackupStorageRedundancy]] = None, **kwargs)

Bases: msrest.serialization.Model

Contains the information necessary to perform long term retention backup copy operation.

Variables

• target_subscription_id (str) – The subscription that owns the target server.

• target_resource_group (str) – The resource group that owns the target server.

• target_server_resource_id (str) – The resource Id of the target server that owns the database.

• target_server_fully_qualified_domain_name (str) – The fully qualified domain name of the target server.

• target_database_name (str) – The name of the database owns the copied backup.

• target_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the copied backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

Keyword Arguments

• target_subscription_id (str) – The subscription that owns the target server.

• target_resource_group (str) – The resource group that owns the target server.

• target_server_resource_id (str) – The resource Id of the target server that owns the database.

• target_server_fully_qualified_domain_name (str) – The fully qualified domain name of the target server.

• target_database_name (str) – The name of the database owns the copied backup.

• target_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the copied backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

class azure.mgmt.sql.models.CreateDatabaseRestorePointDefinition(*, restore_point_label: str, **kwargs)

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.

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.CreateMode(value)

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.CreatedByType(value)

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'

KEY = 'Key'

MANAGED_IDENTITY = 'ManagedIdentity'

USER = 'User'

class azure.mgmt.sql.models.DataMaskingFunction(value)

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.DataMaskingPolicy(*, data_masking_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DataMaskingState]] = None, exempt_principals: Optional[str] = None, **kwargs)

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

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.

• 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.

• 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.

Keyword Arguments

• 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DataMaskingRuleState]] = None, schema_name: Optional[str] = None, table_name: Optional[str] = None, column_name: Optional[str] = None, masking_function: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DataMaskingFunction]] = 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)

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

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.

• 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.

Keyword Arguments

• 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[azure.mgmt.sql.models._models_py3.DataMaskingRule]] = None, **kwargs)

Bases: msrest.serialization.Model

The response to a list data masking rules request.

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.DataMaskingRuleState(value)

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(value)

Bases: str, enum.Enum

The state of the data masking policy.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.sql.models.DataWarehouseUserActivities(**kwargs)

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

User activities of 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.

• active_queries_count (int) – Count of running and suspended queries.

class azure.mgmt.sql.models.DataWarehouseUserActivitiesListResult(**kwargs)

Bases: msrest.serialization.Model

User activities of a data warehouse.

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

Variables

• value (list[DataWarehouseUserActivities]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DataWarehouseUserActivityName(value)

Bases: str, enum.Enum

An enumeration.

CURRENT = 'current'

class azure.mgmt.sql.models.Database(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.mgmt.sql.models._models_py3.Sku] = None, identity: Optional[azure.mgmt.sql.models._models_py3.DatabaseIdentity] = None, create_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CreateMode]] = None, collation: Optional[str] = None, max_size_bytes: Optional[int] = None, sample_name: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SampleName]] = 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CatalogCollationType]] = None, zone_redundant: Optional[bool] = None, license_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseLicenseType]] = None, read_scale: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseReadScale]] = None, high_availability_replica_count: Optional[int] = None, secondary_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecondaryType]] = None, auto_pause_delay: Optional[int] = None, requested_backup_storage_redundancy: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BackupStorageRedundancy]] = None, min_capacity: Optional[float] = None, maintenance_configuration_id: Optional[str] = None, is_ledger_on: Optional[bool] = None, federated_client_id: Optional[str] = None, primary_delegated_identity_client_id: Optional[str] = None, **kwargs)

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.

• 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>
  `.
  

• kind (str) – Kind of database. This is metadata used for the Azure portal experience.

• managed_by (str) – Resource that manages the database.

• identity (DatabaseIdentity) – The Azure Active Directory identity of the database.

• 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.

• 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”, “Stopping”, “Stopped”, “Starting”.

• 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.

• 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”.

• 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).

• read_scale (str or DatabaseReadScale) – The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Possible values include: “Enabled”, “Disabled”.

• high_availability_replica_count (int) – The number of secondary replicas associated with the database that are used to provide high availability.

• secondary_type (str or SecondaryType) – The secondary type of the database if it is a secondary. Valid values are Geo and Named. Possible values include: “Geo”, “Named”.

• current_sku (Sku) – The name and tier of the SKU.

• auto_pause_delay (int) – Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled.

• current_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type used to store backups for this database. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type to be used to store backups for this database. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• min_capacity (float) – Minimal capacity that database will always have allocated, if not paused.

• 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.

• maintenance_configuration_id (str) – Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

• is_ledger_on (bool) – Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

• is_infra_encryption_enabled (bool) – Infra encryption is enabled for this database.

• federated_client_id (str) – The Client id used for cross tenant per database CMK scenario.

• primary_delegated_identity_client_id (str) – The Primary Delegated Identity Client id used for per database CMK - for internal use only.

Keyword Arguments

• 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>
  `.
  

• identity (DatabaseIdentity) – The Azure Active Directory identity of the database.

• 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) – The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Possible values include: “Enabled”, “Disabled”.

• high_availability_replica_count (int) – The number of secondary replicas associated with the database that are used to provide high availability.

• secondary_type (str or SecondaryType) – The secondary type of the database if it is a secondary. Valid values are Geo and Named. Possible values include: “Geo”, “Named”.

• auto_pause_delay (int) – Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type to be used to store backups for this database. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• min_capacity (float) – Minimal capacity that database will always have allocated, if not paused.

• maintenance_configuration_id (str) – Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

• is_ledger_on (bool) – Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

• federated_client_id (str) – The Client id used for cross tenant per database CMK scenario.

• primary_delegated_identity_client_id (str) – The Primary Delegated Identity Client id used for per database CMK - for internal use only.

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

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

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.

• desired_state (str or AutomaticTuningMode) – Automatic tuning desired state. Possible values include: “Inherit”, “Custom”, “Auto”, “Unspecified”.

• actual_state (str or AutomaticTuningMode) – Automatic tuning actual state. Possible values include: “Inherit”, “Custom”, “Auto”, “Unspecified”.

• options (dict[str, AutomaticTuningOptions]) – Automatic tuning options definition.

Keyword Arguments

• 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(*, retention_days: Optional[int] = None, audit_actions_and_groups: Optional[List[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, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BlobAuditingPolicyState]] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, storage_account_subscription_id: Optional[str] = None, **kwargs)

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

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.

• 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.

• 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.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

Keyword Arguments

• 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.

• 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.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

class azure.mgmt.sql.models.DatabaseBlobAuditingPolicyListResult(**kwargs)

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.DatabaseColumn(*, column_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ColumnDataType]] = None, temporal_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.TableTemporalType]] = None, memory_optimized: Optional[bool] = None, is_computed: Optional[bool] = None, **kwargs)

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

A database column 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.

• column_type (str or ColumnDataType) – The column data type. Possible values include: “image”, “text”, “uniqueidentifier”, “date”, “time”, “datetime2”, “datetimeoffset”, “tinyint”, “smallint”, “int”, “smalldatetime”, “real”, “money”, “datetime”, “float”, “sql_variant”, “ntext”, “bit”, “decimal”, “numeric”, “smallmoney”, “bigint”, “hierarchyid”, “geometry”, “geography”, “varbinary”, “varchar”, “binary”, “char”, “timestamp”, “nvarchar”, “nchar”, “xml”, “sysname”.

• temporal_type (str or TableTemporalType) – The table temporal type. Possible values include: “NonTemporalTable”, “HistoryTable”, “SystemVersionedTemporalTable”.

• memory_optimized (bool) – Whether or not the column belongs to a memory optimized table.

• is_computed (bool) – Whether or not the column is computed.

Keyword Arguments

• column_type (str or ColumnDataType) – The column data type. Possible values include: “image”, “text”, “uniqueidentifier”, “date”, “time”, “datetime2”, “datetimeoffset”, “tinyint”, “smallint”, “int”, “smalldatetime”, “real”, “money”, “datetime”, “float”, “sql_variant”, “ntext”, “bit”, “decimal”, “numeric”, “smallmoney”, “bigint”, “hierarchyid”, “geometry”, “geography”, “varbinary”, “varchar”, “binary”, “char”, “timestamp”, “nvarchar”, “nchar”, “xml”, “sysname”.

• temporal_type (str or TableTemporalType) – The table temporal type. Possible values include: “NonTemporalTable”, “HistoryTable”, “SystemVersionedTemporalTable”.

• memory_optimized (bool) – Whether or not the column belongs to a memory optimized table.

• is_computed (bool) – Whether or not the column is computed.

class azure.mgmt.sql.models.DatabaseColumnListResult(**kwargs)

Bases: msrest.serialization.Model

A list of database columns.

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

Variables

• value (list[DatabaseColumn]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseExtensions(*, operation_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.OperationMode]] = None, storage_key_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.StorageKeyType]] = None, storage_key: Optional[str] = None, storage_uri: Optional[str] = None, **kwargs)

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

An export managed database operation result 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.

• operation_mode (str or OperationMode) – Operation Mode. Possible values include: “PolybaseImport”.

• storage_key_type (str or StorageKeyType) – Storage key type. Possible values include: “SharedAccessKey”, “StorageAccessKey”.

• storage_key (str) – Storage key.

• storage_uri (str) – Storage Uri.

Keyword Arguments

• operation_mode (str or OperationMode) – Operation Mode. Possible values include: “PolybaseImport”.

• storage_key_type (str or StorageKeyType) – Storage key type. Possible values include: “SharedAccessKey”, “StorageAccessKey”.

• storage_key (str) – Storage key.

• storage_uri (str) – Storage Uri.

class azure.mgmt.sql.models.DatabaseIdentity(*, type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseIdentityType]] = None, user_assigned_identities: Optional[Dict[str, azure.mgmt.sql.models._models_py3.DatabaseUserIdentity]] = None, delegated_resources: Optional[Dict[str, azure.mgmt.sql.models._models_py3.Delegation]] = None, **kwargs)

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

• type (str or DatabaseIdentityType) – The identity type. Possible values include: “None”, “UserAssigned”.

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

• user_assigned_identities (dict[str, DatabaseUserIdentity]) – The resource ids of the user assigned identities to use.

• delegated_resources (dict[str, Delegation]) – Resources delegated to the database - Internal Use Only.

Keyword Arguments

• type (str or DatabaseIdentityType) – The identity type. Possible values include: “None”, “UserAssigned”.

• user_assigned_identities (dict[str, DatabaseUserIdentity]) – The resource ids of the user assigned identities to use.

• delegated_resources (dict[str, Delegation]) – Resources delegated to the database - Internal Use Only.

class azure.mgmt.sql.models.DatabaseIdentityType(value)

Bases: str, enum.Enum

The identity type

NONE = 'None'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.sql.models.DatabaseLicenseType(value)

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.DatabaseListResult(**kwargs)

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)

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

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)

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.DatabaseReadScale(value)

Bases: str, enum.Enum

The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.sql.models.DatabaseSchema(**kwargs)

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

A database schema 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.DatabaseSchemaListResult(**kwargs)

Bases: msrest.serialization.Model

A list of database schemas.

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

Variables

• value (list[DatabaseSchema]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseSecurityAlertListResult(**kwargs)

Bases: msrest.serialization.Model

A list of the database’s security alert policies.

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

Variables

• value (list[DatabaseSecurityAlertPolicy]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseSecurityAlertPolicy(*, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertsPolicyState]] = 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)

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

A 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.

• system_data (SystemData) – SystemData of SecurityAlertPolicyResource.

• state (str or SecurityAlertsPolicyState) – 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: “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, Brute_Force.

• 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.

• creation_time (datetime) – Specifies the UTC creation time of the policy.

Keyword Arguments

• state (str or SecurityAlertsPolicyState) – 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: “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, Brute_Force.

• 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.DatabaseState(value)

Bases: str, enum.Enum

An enumeration.

ALL = 'All'

DELETED = 'Deleted'

LIVE = 'Live'

class azure.mgmt.sql.models.DatabaseStatus(value)

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'

STARTING = 'Starting'

STOPPED = 'Stopped'

STOPPING = 'Stopping'

SUSPECT = 'Suspect'

class azure.mgmt.sql.models.DatabaseTable(*, temporal_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.TableTemporalType]] = None, memory_optimized: Optional[bool] = None, **kwargs)

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

A database table 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.

• temporal_type (str or TableTemporalType) – The table temporal type. Possible values include: “NonTemporalTable”, “HistoryTable”, “SystemVersionedTemporalTable”.

• memory_optimized (bool) – Whether or not the table is memory optimized.

Keyword Arguments

• temporal_type (str or TableTemporalType) – The table temporal type. Possible values include: “NonTemporalTable”, “HistoryTable”, “SystemVersionedTemporalTable”.

• memory_optimized (bool) – Whether or not the table is memory optimized.

class azure.mgmt.sql.models.DatabaseTableListResult(**kwargs)

Bases: msrest.serialization.Model

A list of database tables.

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

Variables

• value (list[DatabaseTable]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseUpdate(*, sku: Optional[azure.mgmt.sql.models._models_py3.Sku] = None, identity: Optional[azure.mgmt.sql.models._models_py3.DatabaseIdentity] = None, tags: Optional[Dict[str, str]] = None, create_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CreateMode]] = None, collation: Optional[str] = None, max_size_bytes: Optional[int] = None, sample_name: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SampleName]] = 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CatalogCollationType]] = None, zone_redundant: Optional[bool] = None, license_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseLicenseType]] = None, read_scale: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseReadScale]] = None, high_availability_replica_count: Optional[int] = None, secondary_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecondaryType]] = None, auto_pause_delay: Optional[int] = None, requested_backup_storage_redundancy: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BackupStorageRedundancy]] = None, min_capacity: Optional[float] = None, maintenance_configuration_id: Optional[str] = None, is_ledger_on: Optional[bool] = None, federated_client_id: Optional[str] = None, primary_delegated_identity_client_id: Optional[str] = None, **kwargs)

Bases: msrest.serialization.Model

A database resource.

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

Variables

• sku (Sku) – The name and tier of the SKU.

• identity (DatabaseIdentity) – Database identity.

• 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.

• 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”, “Stopping”, “Stopped”, “Starting”.

• 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.

• 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”.

• 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).

• read_scale (str or DatabaseReadScale) – The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Possible values include: “Enabled”, “Disabled”.

• high_availability_replica_count (int) – The number of secondary replicas associated with the database that are used to provide high availability.

• secondary_type (str or SecondaryType) – The secondary type of the database if it is a secondary. Valid values are Geo and Named. Possible values include: “Geo”, “Named”.

• current_sku (Sku) – The name and tier of the SKU.

• auto_pause_delay (int) – Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled.

• current_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type used to store backups for this database. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type to be used to store backups for this database. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• min_capacity (float) – Minimal capacity that database will always have allocated, if not paused.

• 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.

• maintenance_configuration_id (str) – Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

• is_ledger_on (bool) – Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

• is_infra_encryption_enabled (bool) – Infra encryption is enabled for this database.

• federated_client_id (str) – The Client id used for cross tenant per database CMK scenario.

• primary_delegated_identity_client_id (str) – The Primary Delegated Identity Client id used for per database CMK - for internal use only.

Keyword Arguments

• sku (Sku) – The name and tier of the SKU.

• identity (DatabaseIdentity) – Database identity.

• 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) – The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Possible values include: “Enabled”, “Disabled”.

• high_availability_replica_count (int) – The number of secondary replicas associated with the database that are used to provide high availability.

• secondary_type (str or SecondaryType) – The secondary type of the database if it is a secondary. Valid values are Geo and Named. Possible values include: “Geo”, “Named”.

• auto_pause_delay (int) – Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type to be used to store backups for this database. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• min_capacity (float) – Minimal capacity that database will always have allocated, if not paused.

• maintenance_configuration_id (str) – Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

• is_ledger_on (bool) – Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

• federated_client_id (str) – The Client id used for cross tenant per database CMK scenario.

• primary_delegated_identity_client_id (str) – The Primary Delegated Identity Client id used for per database CMK - for internal use only.

class azure.mgmt.sql.models.DatabaseUsage(**kwargs)

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

Usage metric of a 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.

• 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.DatabaseUsageListResult(**kwargs)

Bases: msrest.serialization.Model

A list of database usage metrics.

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

Variables

• value (list[DatabaseUsage]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DatabaseUserIdentity(**kwargs)

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.

• client_id (str) – The Azure Active Directory client id.

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[azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentRecurringScansProperties] = None, **kwargs)

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

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.

• 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 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.

Keyword Arguments

• 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 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)

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[azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaselineItem]] = None, **kwargs)

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

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.

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

Keyword Arguments

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

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

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.

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.DatabaseVulnerabilityAssessmentScansExport(**kwargs)

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

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.DayOfWeek(value)

Bases: str, enum.Enum

Day of maintenance window.

FRIDAY = 'Friday'

MONDAY = 'Monday'

SATURDAY = 'Saturday'

SUNDAY = 'Sunday'

THURSDAY = 'Thursday'

TUESDAY = 'Tuesday'

WEDNESDAY = 'Wednesday'

class azure.mgmt.sql.models.Delegation(*, resource_id: Optional[str] = None, **kwargs)

Bases: msrest.serialization.Model

Delegated Resource Properties - Internal Use Only.

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

Variables

• resource_id (str) – The resource id of the source resource - Internal Use Only.

• tenant_id (str) – AAD tenant guid of the source resource identity - Internal Use Only.

Keyword Arguments

resource_id (str) – The resource id of the source resource - Internal Use Only.

class azure.mgmt.sql.models.DeletedServer(**kwargs)

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

A deleted 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.

• version (str) – The version of the deleted server.

• deletion_time (datetime) – The deletion time of the deleted server.

• original_id (str) – The original ID of the server before deletion.

• fully_qualified_domain_name (str) – The fully qualified domain name of the server.

class azure.mgmt.sql.models.DeletedServerListResult(**kwargs)

Bases: msrest.serialization.Model

A list of deleted servers.

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

Variables

• value (list[DeletedServer]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DiffBackupIntervalInHours(value)

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.DistributedAvailabilityGroup(*, target_database: Optional[str] = None, source_endpoint: Optional[str] = None, primary_availability_group_name: Optional[str] = None, secondary_availability_group_name: Optional[str] = None, replication_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ReplicationMode]] = None, **kwargs)

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

Distributed availability group between box and Sql Managed Instance.

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.

• target_database (str) – The name of the target database.

• source_endpoint (str) – The source endpoint.

• primary_availability_group_name (str) – The primary availability group name.

• secondary_availability_group_name (str) – The secondary availability group name.

• replication_mode (str or ReplicationMode) – The replication mode of a distributed availability group. Parameter will be ignored during link creation. Possible values include: “Async”, “Sync”.

• distributed_availability_group_id (str) – The distributed availability group id.

• source_replica_id (str) – The source replica id.

• target_replica_id (str) – The target replica id.

• link_state (str) – The link state.

• last_hardened_lsn (str) – The last hardened lsn.

Keyword Arguments

• target_database (str) – The name of the target database.

• source_endpoint (str) – The source endpoint.

• primary_availability_group_name (str) – The primary availability group name.

• secondary_availability_group_name (str) – The secondary availability group name.

• replication_mode (str or ReplicationMode) – The replication mode of a distributed availability group. Parameter will be ignored during link creation. Possible values include: “Async”, “Sync”.

class azure.mgmt.sql.models.DistributedAvailabilityGroupsListResult(**kwargs)

Bases: msrest.serialization.Model

A list of distributed availability groups in instance.

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

Variables

• value (list[DistributedAvailabilityGroup]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.DnsRefreshConfigurationPropertiesStatus(value)

Bases: str, enum.Enum

The status of the DNS refresh operation.

FAILED = 'Failed'

SUCCEEDED = 'Succeeded'

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

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”.

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

Keyword Arguments

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[azure.mgmt.sql.models._models_py3.Sku] = None, max_size_bytes: Optional[int] = None, per_database_settings: Optional[azure.mgmt.sql.models._models_py3.ElasticPoolPerDatabaseSettings] = None, zone_redundant: Optional[bool] = None, license_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ElasticPoolLicenseType]] = None, maintenance_configuration_id: Optional[str] = None, high_availability_replica_count: Optional[int] = None, **kwargs)

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.

• 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
  `.
  

• 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).

• 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”.

• maintenance_configuration_id (str) – Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

• high_availability_replica_count (int) – The number of secondary replicas associated with the elastic pool that are used to provide high availability.

Keyword Arguments

• 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”.

• maintenance_configuration_id (str) – Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

• high_availability_replica_count (int) – The number of secondary replicas associated with the elastic pool that are used to provide high availability.

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

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

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.

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

• 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.

Keyword Arguments

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

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

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.

Variables

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

Keyword Arguments

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

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

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

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.

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

• 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.

Keyword Arguments

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

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

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.

Variables

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

Keyword Arguments

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

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

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”.

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

Keyword Arguments

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

class azure.mgmt.sql.models.ElasticPoolLicenseType(value)

Bases: str, enum.Enum

The license type to apply for this elastic pool.

BASE_PRICE = 'BasePrice'

LICENSE_INCLUDED = 'LicenseIncluded'

class azure.mgmt.sql.models.ElasticPoolListResult(**kwargs)

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)

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

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)

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)

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”.

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

Keyword Arguments

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

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

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”.

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

Keyword Arguments

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)

Bases: msrest.serialization.Model

Per database settings of an elastic pool.

Variables

• min_capacity (float) – The minimum capacity all databases are guaranteed.

• max_capacity (float) – The maximum capacity any one database can consume.

Keyword Arguments

• 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)

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.

• supported_maintenance_configurations (list[MaintenanceConfigurationCapability]) – List of supported maintenance configurations.

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

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

Keyword Arguments

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

class azure.mgmt.sql.models.ElasticPoolState(value)

Bases: str, enum.Enum

The state of the elastic pool.

CREATING = 'Creating'

DISABLED = 'Disabled'

READY = 'Ready'

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

Bases: msrest.serialization.Model

An elastic pool update.

Variables

• 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”.

• maintenance_configuration_id (str) – Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

• high_availability_replica_count (int) – The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

Keyword Arguments

• 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”.

• maintenance_configuration_id (str) – Maintenance configuration id assigned to the elastic pool. This configuration defines the period when the maintenance updates will will occur.

• high_availability_replica_count (int) – The number of secondary replicas associated with the elastic pool that are used to provide high availability. Applicable only to Hyperscale elastic pools.

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

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

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.

• 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”.

• uri (str) – The URI of the server key.

• thumbprint (str) – Thumbprint of the server key.

• auto_rotation_enabled (bool) – Key auto rotation opt-in flag. Either true or false.

Keyword Arguments

• 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”.

• auto_rotation_enabled (bool) – Key auto rotation opt-in flag. Either true or false.

class azure.mgmt.sql.models.EncryptionProtectorListResult(**kwargs)

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.EncryptionProtectorName(value)

Bases: str, enum.Enum

An enumeration.

CURRENT = 'current'

class azure.mgmt.sql.models.ExportDatabaseDefinition(*, storage_key_type: Union[str, azure.mgmt.sql.models._sql_management_client_enums.StorageKeyType], storage_key: str, storage_uri: str, administrator_login: str, administrator_login_password: str, authentication_type: Optional[str] = None, network_isolation: Optional[azure.mgmt.sql.models._models_py3.NetworkIsolationSettings] = None, **kwargs)

Bases: msrest.serialization.Model

Contains the information necessary to perform export database operation.

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

Variables

• storage_key_type (str or StorageKeyType) – Required. Storage key type. Possible values include: “SharedAccessKey”, “StorageAccessKey”.

• storage_key (str) – Required. Storage key.

• storage_uri (str) – Required. Storage Uri.

• administrator_login (str) – Required. Administrator login name.

• administrator_login_password (str) – Required. Administrator login password.

• authentication_type (str) – Authentication type.

• network_isolation (NetworkIsolationSettings) – Optional resource information to enable network isolation for request.

Keyword Arguments

• storage_key_type (str or StorageKeyType) – Required. Storage key type. Possible values include: “SharedAccessKey”, “StorageAccessKey”.

• storage_key (str) – Required. Storage key.

• storage_uri (str) – Required. Storage Uri.

• administrator_login (str) – Required. Administrator login name.

• administrator_login_password (str) – Required. Administrator login password.

• authentication_type (str) – Authentication type.

• network_isolation (NetworkIsolationSettings) – Optional resource information to enable network isolation for request.

class azure.mgmt.sql.models.ExtendedDatabaseBlobAuditingPolicy(*, predicate_expression: Optional[str] = None, retention_days: Optional[int] = None, audit_actions_and_groups: Optional[List[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, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BlobAuditingPolicyState]] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, storage_account_subscription_id: Optional[str] = None, **kwargs)

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

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.

• predicate_expression (str) – Specifies condition of where clause when creating an audit.

• 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.

• 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.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

Keyword Arguments

• predicate_expression (str) – Specifies condition of where clause when creating an audit.

• 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.

• 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.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

class azure.mgmt.sql.models.ExtendedDatabaseBlobAuditingPolicyListResult(**kwargs)

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(*, is_devops_audit_enabled: Optional[bool] = None, predicate_expression: Optional[str] = None, retention_days: Optional[int] = None, audit_actions_and_groups: Optional[List[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, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BlobAuditingPolicyState]] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, storage_account_subscription_id: Optional[str] = None, **kwargs)

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

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.

• is_devops_audit_enabled (bool) –

  Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true

  When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created.

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

  For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.

• predicate_expression (str) – Specifies condition of where clause when creating an audit.

• 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.

• 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.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

Keyword Arguments

• is_devops_audit_enabled (bool) –

  Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true

  When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created.

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

  For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.

• predicate_expression (str) – Specifies condition of where clause when creating an audit.

• 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.

• 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.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

class azure.mgmt.sql.models.ExtendedServerBlobAuditingPolicyListResult(**kwargs)

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[azure.mgmt.sql.models._models_py3.FailoverGroupReadWriteEndpoint] = None, read_only_endpoint: Optional[azure.mgmt.sql.models._models_py3.FailoverGroupReadOnlyEndpoint] = None, partner_servers: Optional[List[azure.mgmt.sql.models._models_py3.PartnerInfo]] = None, databases: Optional[List[str]] = None, **kwargs)

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

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.

• 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.

• 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.

• partner_servers (list[PartnerInfo]) – List of partner server information for the failover group.

• databases (list[str]) – List of databases in the failover group.

Keyword Arguments

• 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)

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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ReadOnlyEndpointFailoverPolicy]] = None, **kwargs)

Bases: msrest.serialization.Model

Read-only endpoint of the failover group instance.

Variables

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

Keyword Arguments

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, azure.mgmt.sql.models._sql_management_client_enums.ReadWriteEndpointFailoverPolicy], failover_with_data_loss_grace_period_minutes: Optional[int] = None, **kwargs)

Bases: msrest.serialization.Model

Read-write endpoint of the failover group instance.

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

Variables

• 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.

Keyword Arguments

• 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.FailoverGroupReplicationRole(value)

Bases: str, enum.Enum

Local replication role of the failover group instance.

PRIMARY = 'Primary'

SECONDARY = 'Secondary'

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

Bases: msrest.serialization.Model

A failover group update request.

Variables

• 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.

Keyword Arguments

• 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(*, name: Optional[str] = None, start_ip_address: Optional[str] = None, end_ip_address: Optional[str] = None, **kwargs)

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

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.

• start_ip_address (str) – The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ for 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’ for all Azure-internal IP addresses.

Keyword Arguments

• name (str) – Resource name.

• start_ip_address (str) – The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ for 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’ for all Azure-internal IP addresses.

class azure.mgmt.sql.models.FirewallRuleList(*, values: Optional[List[azure.mgmt.sql.models._models_py3.FirewallRule]] = None, **kwargs)

Bases: msrest.serialization.Model

A list of server firewall rules.

Variables

values (list[FirewallRule]) –

Keyword Arguments

values (list[FirewallRule]) –

class azure.mgmt.sql.models.FirewallRuleListResult(**kwargs)

Bases: msrest.serialization.Model

The response to a list firewall rules request.

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

Variables

• value (list[FirewallRule]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

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

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

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.

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

• storage_type (str) – The storage type of the geo backup policy.

Keyword Arguments

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[azure.mgmt.sql.models._models_py3.GeoBackupPolicy]] = None, **kwargs)

Bases: msrest.serialization.Model

The response to a list geo backup policies request.

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.GeoBackupPolicyName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'

class azure.mgmt.sql.models.GeoBackupPolicyState(value)

Bases: str, enum.Enum

The state of the geo backup policy.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.sql.models.IPv6FirewallRule(*, name: Optional[str] = None, start_i_pv6_address: Optional[str] = None, end_i_pv6_address: Optional[str] = None, **kwargs)

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

An IPv6 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.

• start_i_pv6_address (str) – The start IP address of the firewall rule. Must be IPv6 format.

• end_i_pv6_address (str) – The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress.

Keyword Arguments

• name (str) – Resource name.

• start_i_pv6_address (str) – The start IP address of the firewall rule. Must be IPv6 format.

• end_i_pv6_address (str) – The end IP address of the firewall rule. Must be IPv6 format. Must be greater than or equal to startIpAddress.

class azure.mgmt.sql.models.IPv6FirewallRuleList(*, values: Optional[List[azure.mgmt.sql.models._models_py3.IPv6FirewallRule]] = None, **kwargs)

Bases: msrest.serialization.Model

A list of IPv6 server firewall rules.

Variables

values (list[IPv6FirewallRule]) –

Keyword Arguments

values (list[IPv6FirewallRule]) –

class azure.mgmt.sql.models.IPv6FirewallRuleListResult(**kwargs)

Bases: msrest.serialization.Model

The response to a list IPv6 firewall rules request.

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

Variables

• value (list[IPv6FirewallRule]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.IdentityType(value)

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.

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned'

USER_ASSIGNED = 'UserAssigned'

class azure.mgmt.sql.models.ImplementationMethod(value)

Bases: str, enum.Enum

Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell.

AZURE_POWER_SHELL = 'AzurePowerShell'

T_SQL = 'TSql'

class azure.mgmt.sql.models.ImportExistingDatabaseDefinition(*, storage_key_type: Union[str, azure.mgmt.sql.models._sql_management_client_enums.StorageKeyType], storage_key: str, storage_uri: str, administrator_login: str, administrator_login_password: str, authentication_type: Optional[str] = None, network_isolation: Optional[azure.mgmt.sql.models._models_py3.NetworkIsolationSettings] = None, **kwargs)

Bases: msrest.serialization.Model

Contains the information necessary to perform import operation for existing database.

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

Variables

• storage_key_type (str or StorageKeyType) – Required. Storage key type. Possible values include: “SharedAccessKey”, “StorageAccessKey”.

• storage_key (str) – Required. Storage key.

• storage_uri (str) – Required. Storage Uri.

• administrator_login (str) – Required. Administrator login name.

• administrator_login_password (str) – Required. Administrator login password.

• authentication_type (str) – Authentication type.

• network_isolation (NetworkIsolationSettings) – Optional resource information to enable network isolation for request.

Keyword Arguments

• storage_key_type (str or StorageKeyType) – Required. Storage key type. Possible values include: “SharedAccessKey”, “StorageAccessKey”.

• storage_key (str) – Required. Storage key.

• storage_uri (str) – Required. Storage Uri.

• administrator_login (str) – Required. Administrator login name.

• administrator_login_password (str) – Required. Administrator login password.

• authentication_type (str) – Authentication type.

• network_isolation (NetworkIsolationSettings) – Optional resource information to enable network isolation for request.

class azure.mgmt.sql.models.ImportExportExtensionsOperationListResult(**kwargs)

Bases: msrest.serialization.Model

Import export operation extensions list.

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

Variables

• value (list[ImportExportExtensionsOperationResult]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ImportExportExtensionsOperationResult(**kwargs)

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

An Extension operation result 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.

• request_id (str) – Request Id.

• request_type (str) – Request type.

• last_modified_time (str) – Last modified time.

• server_name (str) – Server name.

• database_name (str) – Database name.

• status (str) – Operation status.

• error_message (str) – Error message.

class azure.mgmt.sql.models.ImportExportOperationResult(**kwargs)

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

An ImportExport operation result 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.

• request_id (str) – Request Id.

• request_type (str) – Request type.

• queued_time (str) – Queued time.

• last_modified_time (str) – Last modified time.

• blob_uri (str) – Blob Uri.

• server_name (str) – Server name.

• database_name (str) – Database name.

• status (str) – Operation status.

• error_message (str) – Error message.

• private_endpoint_connections (list[PrivateEndpointConnectionRequestStatus]) – Gets the status of private endpoints associated with this request.

class azure.mgmt.sql.models.ImportNewDatabaseDefinition(*, storage_key_type: Union[str, azure.mgmt.sql.models._sql_management_client_enums.StorageKeyType], storage_key: str, storage_uri: str, administrator_login: str, administrator_login_password: str, database_name: Optional[str] = None, edition: Optional[str] = None, service_objective_name: Optional[str] = None, max_size_bytes: Optional[str] = None, authentication_type: Optional[str] = None, network_isolation: Optional[azure.mgmt.sql.models._models_py3.NetworkIsolationSettings] = None, **kwargs)

Bases: msrest.serialization.Model

Contains the information necessary to perform import operation for new database.

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

Variables

• database_name (str) – Name of the import database.

• edition (str) – Edition of the import database.

• service_objective_name (str) – Service level objective name of the import database.

• max_size_bytes (str) – Max size in bytes for the import database.

• storage_key_type (str or StorageKeyType) – Required. Storage key type. Possible values include: “SharedAccessKey”, “StorageAccessKey”.

• storage_key (str) – Required. Storage key.

• storage_uri (str) – Required. Storage Uri.

• administrator_login (str) – Required. Administrator login name.

• administrator_login_password (str) – Required. Administrator login password.

• authentication_type (str) – Authentication type.

• network_isolation (NetworkIsolationSettings) – Optional resource information to enable network isolation for request.

Keyword Arguments

• database_name (str) – Name of the import database.

• edition (str) – Edition of the import database.

• service_objective_name (str) – Service level objective name of the import database.

• max_size_bytes (str) – Max size in bytes for the import database.

• storage_key_type (str or StorageKeyType) – Required. Storage key type. Possible values include: “SharedAccessKey”, “StorageAccessKey”.

• storage_key (str) – Required. Storage key.

• storage_uri (str) – Required. Storage Uri.

• administrator_login (str) – Required. Administrator login name.

• administrator_login_password (str) – Required. Administrator login password.

• authentication_type (str) – Authentication type.

• network_isolation (NetworkIsolationSettings) – Optional resource information to enable network isolation for request.

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

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

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.

• read_write_endpoint (InstanceFailoverGroupReadWriteEndpoint) – Read-write endpoint of the failover group instance.

• read_only_endpoint (InstanceFailoverGroupReadOnlyEndpoint) – Read-only endpoint of the failover group instance.

• 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.

• 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.

Keyword Arguments

• 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)

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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ReadOnlyEndpointFailoverPolicy]] = None, **kwargs)

Bases: msrest.serialization.Model

Read-only endpoint of the failover group instance.

Variables

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

Keyword Arguments

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, azure.mgmt.sql.models._sql_management_client_enums.ReadWriteEndpointFailoverPolicy], failover_with_data_loss_grace_period_minutes: Optional[int] = None, **kwargs)

Bases: msrest.serialization.Model

Read-write endpoint of the failover group instance.

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

Variables

• 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.

Keyword Arguments

• 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.InstanceFailoverGroupReplicationRole(value)

Bases: str, enum.Enum

Local replication role of the failover group instance.

PRIMARY = 'Primary'

SECONDARY = 'Secondary'

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

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.

• 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”.

Keyword Arguments

• 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)

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”.

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

Keyword Arguments

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

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

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”.

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

Keyword Arguments

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

class azure.mgmt.sql.models.InstancePoolLicenseType(value)

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.InstancePoolListResult(**kwargs)

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)

Bases: msrest.serialization.Model

An update to an Instance pool.

Variables

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

Keyword Arguments

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

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

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”.

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

Keyword Arguments

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

class azure.mgmt.sql.models.IsRetryable(value)

Bases: str, enum.Enum

Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No

NO = 'No'

YES = 'Yes'

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

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

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.

• description (str) – User-defined description of the job.

• version (int) – The job version number.

• schedule (JobSchedule) – Schedule properties of the job.

Keyword Arguments

• 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[azure.mgmt.sql.models._models_py3.Sku] = None, database_id: Optional[str] = None, **kwargs)

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.

• 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.

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

Keyword Arguments

• 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)

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.JobAgentState(value)

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.JobAgentUpdate(*, tags: Optional[Dict[str, str]] = None, **kwargs)

Bases: msrest.serialization.Model

An update to an Azure SQL job agent.

Variables

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

Keyword Arguments

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)

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

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.

• username (str) – The credential user name.

• password (str) – The credential password.

Keyword Arguments

• username (str) – The credential user name.

• password (str) – The credential password.

class azure.mgmt.sql.models.JobCredentialListResult(**kwargs)

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)

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

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_attempts (int) – Number of times the job execution has been attempted.

• 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.

Keyword Arguments

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

class azure.mgmt.sql.models.JobExecutionLifecycle(value)

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.JobExecutionListResult(**kwargs)

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)

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)

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:00+00:00', end_time: Optional[datetime.datetime] = '9999-12-31T11:59:59+00:00', type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.JobScheduleType]] = 'Once', enabled: Optional[bool] = None, interval: Optional[str] = None, **kwargs)

Bases: msrest.serialization.Model

Scheduling properties of a job.

Variables

• 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 ScheduleType is recurring. ISO8601 duration format.

Keyword Arguments

• 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 ScheduleType is recurring. ISO8601 duration format.

class azure.mgmt.sql.models.JobScheduleType(value)

Bases: str, enum.Enum

Schedule interval type

ONCE = 'Once'

RECURRING = 'Recurring'

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

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

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.

• 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.

Keyword Arguments

• 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.JobStepActionType]] = 'TSql', source: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.JobStepActionSource]] = 'Inline', **kwargs)

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.

Variables

• 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.

Keyword Arguments

• 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.JobStepActionSource(value)

Bases: str, enum.Enum

The source of the action to execute.

INLINE = 'Inline'

class azure.mgmt.sql.models.JobStepActionType(value)

Bases: str, enum.Enum

Type of action being executed by the job step.

T_SQL = 'TSql'

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)

Bases: msrest.serialization.Model

The execution options of a job step.

Variables

• 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.

Keyword Arguments

• 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)

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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.JobStepOutputType]] = 'SqlDatabase', subscription_id: Optional[str] = None, resource_group_name: Optional[str] = None, schema_name: Optional[str] = 'dbo', **kwargs)

Bases: msrest.serialization.Model

The output configuration of a job step.

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

Variables

• 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.

Keyword Arguments

• 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.JobStepOutputType(value)

Bases: str, enum.Enum

The output destination type.

SQL_DATABASE = 'SqlDatabase'

class azure.mgmt.sql.models.JobTarget(*, type: Union[str, azure.mgmt.sql.models._sql_management_client_enums.JobTargetType], membership_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.JobTargetGroupMembershipType]] = '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)

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.

Variables

• 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.

Keyword Arguments

• 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[azure.mgmt.sql.models._models_py3.JobTarget]] = None, **kwargs)

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

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.

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

Keyword Arguments

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

class azure.mgmt.sql.models.JobTargetGroupListResult(**kwargs)

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.JobTargetGroupMembershipType(value)

Bases: str, enum.Enum

Whether the target is included or excluded from the group.

EXCLUDE = 'Exclude'

INCLUDE = 'Include'

class azure.mgmt.sql.models.JobTargetType(value)

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.JobVersion(**kwargs)

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

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)

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[JobVersion]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.LedgerDigestUploads(*, digest_storage_endpoint: Optional[str] = None, **kwargs)

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

Azure SQL Database ledger digest upload settings.

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.

• digest_storage_endpoint (str) – The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger.

• state (str or LedgerDigestUploadsState) – Specifies the state of ledger digest upload. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

digest_storage_endpoint (str) – The digest storage endpoint, which must be either an Azure blob storage endpoint or an URI for Azure Confidential Ledger.

class azure.mgmt.sql.models.LedgerDigestUploadsListResult(**kwargs)

Bases: msrest.serialization.Model

A list of ledger digest upload settings.

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

Variables

• value (list[LedgerDigestUploads]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.LedgerDigestUploadsName(value)

Bases: str, enum.Enum

An enumeration.

CURRENT = 'current'

class azure.mgmt.sql.models.LedgerDigestUploadsState(value)

Bases: str, enum.Enum

Specifies the state of ledger digest upload.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

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

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”.

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

Keyword Arguments

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

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

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”.

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

Keyword Arguments

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

class azure.mgmt.sql.models.LogSizeCapability(**kwargs)

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.LogSizeUnit(value)

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.LogicalDatabaseTransparentDataEncryption(*, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionState]] = None, **kwargs)

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

A logical database transparent data encryption state.

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 TransparentDataEncryptionState) – Specifies the state of the transparent data encryption. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

state (str or TransparentDataEncryptionState) – Specifies the state of the transparent data encryption. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.sql.models.LogicalDatabaseTransparentDataEncryptionListResult(**kwargs)

Bases: msrest.serialization.Model

A list of transparent data encryptions.

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

Variables

• value (list[LogicalDatabaseTransparentDataEncryption]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.LogicalServerSecurityAlertPolicyListResult(**kwargs)

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(*, requested_backup_storage_redundancy: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BackupStorageRedundancy]] = None, **kwargs)

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

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.

• backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

Keyword Arguments

requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

class azure.mgmt.sql.models.LongTermRetentionBackupListResult(**kwargs)

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.LongTermRetentionBackupOperationResult(**kwargs)

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

A LongTermRetentionBackup operation result 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.

• request_id (str) – Request Id.

• operation_type (str) – Operation type.

• from_backup_resource_id (str) – Source backup resource id.

• to_backup_resource_id (str) – Target backup resource id.

• target_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the copied backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• status (str) – Operation status.

• message (str) – Progress message.

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

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

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.

• 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.

Keyword Arguments

• 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.LongTermRetentionPolicyListResult(**kwargs)

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[LongTermRetentionPolicy]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.LongTermRetentionPolicyName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'

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

Bases: msrest.serialization.Model

The maintenance configuration capability.

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

Variables

• name (str) – Maintenance configuration name.

• zone_redundant (bool) – Whether or not zone redundancy is supported for the maintenance configuration.

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

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

Keyword Arguments

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

class azure.mgmt.sql.models.MaintenanceWindowOptions(*, is_enabled: Optional[bool] = None, maintenance_window_cycles: Optional[List[azure.mgmt.sql.models._models_py3.MaintenanceWindowTimeRange]] = None, min_duration_in_minutes: Optional[int] = None, default_duration_in_minutes: Optional[int] = None, min_cycles: Optional[int] = None, time_granularity_in_minutes: Optional[int] = None, allow_multiple_maintenance_windows_per_cycle: Optional[bool] = None, **kwargs)

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

Maintenance window options.

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_enabled (bool) – Whether maintenance windows are enabled for the database.

• maintenance_window_cycles (list[MaintenanceWindowTimeRange]) – Available maintenance cycles e.g. {Saturday, 0, 4860}, {Wednesday, 0, 2460}.

• min_duration_in_minutes (int) – Minimum duration of maintenance window.

• default_duration_in_minutes (int) – Default duration for maintenance window.

• min_cycles (int) – Minimum number of maintenance windows cycles to be set on the database.

• time_granularity_in_minutes (int) – Time granularity in minutes for maintenance windows.

• allow_multiple_maintenance_windows_per_cycle (bool) – Whether we allow multiple maintenance windows per cycle.

Keyword Arguments

• is_enabled (bool) – Whether maintenance windows are enabled for the database.

• maintenance_window_cycles (list[MaintenanceWindowTimeRange]) – Available maintenance cycles e.g. {Saturday, 0, 4860}, {Wednesday, 0, 2460}.

• min_duration_in_minutes (int) – Minimum duration of maintenance window.

• default_duration_in_minutes (int) – Default duration for maintenance window.

• min_cycles (int) – Minimum number of maintenance windows cycles to be set on the database.

• time_granularity_in_minutes (int) – Time granularity in minutes for maintenance windows.

• allow_multiple_maintenance_windows_per_cycle (bool) – Whether we allow multiple maintenance windows per cycle.

class azure.mgmt.sql.models.MaintenanceWindowTimeRange(*, day_of_week: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DayOfWeek]] = None, start_time: Optional[str] = None, duration: Optional[str] = None, **kwargs)

Bases: msrest.serialization.Model

Maintenance window time range.

Variables

• day_of_week (str or DayOfWeek) – Day of maintenance window. Possible values include: “Sunday”, “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”.

• start_time (str) – Start time minutes offset from 12am.

• duration (str) – Duration of maintenance window in minutes.

Keyword Arguments

• day_of_week (str or DayOfWeek) – Day of maintenance window. Possible values include: “Sunday”, “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”.

• start_time (str) – Start time minutes offset from 12am.

• duration (str) – Duration of maintenance window in minutes.

class azure.mgmt.sql.models.MaintenanceWindows(*, time_ranges: Optional[List[azure.mgmt.sql.models._models_py3.MaintenanceWindowTimeRange]] = None, **kwargs)

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

Maintenance windows.

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.

• time_ranges (list[MaintenanceWindowTimeRange]) –

Keyword Arguments

time_ranges (list[MaintenanceWindowTimeRange]) –

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

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

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.

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

Keyword Arguments

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)

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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CatalogCollationType]] = None, create_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedDatabaseCreateMode]] = 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)

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.

• location (str) – Required. Resource location.

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

• collation (str) – Collation of the managed database.

• 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.

• 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.

• default_secondary_location (str) – Geo paired region.

• 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.

• failover_group_id (str) – Instance Failover Group resource identifier that this managed database belongs to.

• 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.

Keyword Arguments

• 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.ManagedDatabaseCreateMode(value)

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.ManagedDatabaseListResult(**kwargs)

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)

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

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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyState]] = 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)

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

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.

• 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, Brute_Force.

• 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.

• creation_time (datetime) – Specifies the UTC creation time of the policy.

Keyword Arguments

• 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, Brute_Force.

• 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)

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.ManagedDatabaseStatus(value)

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.ManagedDatabaseUpdate(*, tags: Optional[Dict[str, str]] = None, collation: Optional[str] = None, restore_point_in_time: Optional[datetime.datetime] = None, catalog_collation: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CatalogCollationType]] = None, create_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedDatabaseCreateMode]] = 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)

Bases: msrest.serialization.Model

An managed database update.

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

Variables

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

• collation (str) – Collation of the managed database.

• 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.

• 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.

• default_secondary_location (str) – Geo paired region.

• 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.

• failover_group_id (str) – Instance Failover Group resource identifier that this managed database belongs to.

• 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.

Keyword Arguments

• 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.ManagedInstance(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.sql.models._models_py3.ResourceIdentity] = None, sku: Optional[azure.mgmt.sql.models._models_py3.Sku] = None, managed_instance_create_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedServerCreateMode]] = None, administrator_login: Optional[str] = None, administrator_login_password: Optional[str] = None, subnet_id: Optional[str] = None, license_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedInstanceLicenseType]] = 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedInstanceProxyOverride]] = None, timezone_id: Optional[str] = None, instance_pool_id: Optional[str] = None, maintenance_configuration_id: Optional[str] = None, minimal_tls_version: Optional[str] = None, requested_backup_storage_redundancy: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BackupStorageRedundancy]] = None, zone_redundant: Optional[bool] = None, primary_user_assigned_identity_id: Optional[str] = None, key_id: Optional[str] = None, administrators: Optional[azure.mgmt.sql.models._models_py3.ManagedInstanceExternalAdministrator] = None, service_principal: Optional[azure.mgmt.sql.models._models_py3.ServicePrincipal] = None, **kwargs)

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.

• 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.

• provisioning_state (str or ManagedInstancePropertiesProvisioningState) – Possible values include: “Creating”, “Deleting”, “Updating”, “Unknown”, “Succeeded”, “Failed”, “Accepted”, “Created”, “Deleted”, “Unrecognized”, “Running”, “Canceled”, “NotSpecified”, “Registering”, “TimedOut”.

• 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”.

• fully_qualified_domain_name (str) – The fully qualified domain name of the managed instance.

• 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.

• state (str) – The state of 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 (str) – The Dns Zone that the managed instance is in.

• 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.

• private_endpoint_connections (list[ManagedInstancePecProperty]) – List of private endpoint connections on a managed instance.

• minimal_tls_version (str) – Minimal TLS version. Allowed values: ‘None’, ‘1.0’, ‘1.1’, ‘1.2’.

• current_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage). Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage). Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• zone_redundant (bool) – Whether or not the multi-az is enabled.

• primary_user_assigned_identity_id (str) – The resource id of a user assigned identity to be used by default.

• key_id (str) – A CMK URI of the key to use for encryption.

• administrators (ManagedInstanceExternalAdministrator) – The Azure Active Directory administrator of the server.

• service_principal (ServicePrincipal) – The managed instance’s service principal.

Keyword Arguments

• 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’.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage). Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• zone_redundant (bool) – Whether or not the multi-az is enabled.

• primary_user_assigned_identity_id (str) – The resource id of a user assigned identity to be used by default.

• key_id (str) – A CMK URI of the key to use for encryption.

• administrators (ManagedInstanceExternalAdministrator) – The Azure Active Directory administrator of the server.

• service_principal (ServicePrincipal) – The managed instance’s service principal.

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

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

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.

• 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.

Keyword Arguments

• 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)

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.ManagedInstanceAdministratorType(value)

Bases: str, enum.Enum

Type of the managed instance administrator.

ACTIVE_DIRECTORY = 'ActiveDirectory'

class azure.mgmt.sql.models.ManagedInstanceAzureADOnlyAuthListResult(**kwargs)

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[ManagedInstanceAzureADOnlyAuthentication]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

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

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

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.

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

Keyword Arguments

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

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

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.

• supported_storage_capabilities (list[StorageCapability]) – The list of supported storage capabilities for this 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”.

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

Keyword Arguments

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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServerKeyType]] = None, auto_rotation_enabled: Optional[bool] = None, **kwargs)

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

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.

• 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”.

• uri (str) – The URI of the server key.

• thumbprint (str) – Thumbprint of the server key.

• auto_rotation_enabled (bool) – Key auto rotation opt-in flag. Either true or false.

Keyword Arguments

• 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”.

• auto_rotation_enabled (bool) – Key auto rotation opt-in flag. Either true or false.

class azure.mgmt.sql.models.ManagedInstanceEncryptionProtectorListResult(**kwargs)

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.ManagedInstanceExternalAdministrator(*, administrator_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorType]] = None, principal_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.PrincipalType]] = None, login: Optional[str] = None, sid: Optional[str] = None, tenant_id: Optional[str] = None, azure_ad_only_authentication: Optional[bool] = None, **kwargs)

Bases: msrest.serialization.Model

Properties of a active directory administrator.

Variables

• administrator_type (str or AdministratorType) – Type of the sever administrator. Possible values include: “ActiveDirectory”.

• principal_type (str or PrincipalType) – Principal Type of the sever administrator. Possible values include: “User”, “Group”, “Application”.

• 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.

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

Keyword Arguments

• administrator_type (str or AdministratorType) – Type of the sever administrator. Possible values include: “ActiveDirectory”.

• principal_type (str or PrincipalType) – Principal Type of the sever administrator. Possible values include: “User”, “Group”, “Application”.

• 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.

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

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

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”.

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

Keyword Arguments

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

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

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

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.

• 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.

• thumbprint (str) – Thumbprint of the key.

• creation_date (datetime) – The key creation date.

• auto_rotation_enabled (bool) – Key auto rotation opt-in flag. Either true or false.

Keyword Arguments

• 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)

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.ManagedInstanceLicenseType(value)

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.ManagedInstanceListResult(**kwargs)

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)

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

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.

• backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

class azure.mgmt.sql.models.ManagedInstanceLongTermRetentionBackupListResult(**kwargs)

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)

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

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.

• 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.

Keyword Arguments

• 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)

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.ManagedInstanceLongTermRetentionPolicyName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'

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

Bases: msrest.serialization.Model

The maintenance configuration capability.

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

Variables

• name (str) – Maintenance configuration name.

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

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

Keyword Arguments

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

class azure.mgmt.sql.models.ManagedInstanceOperation(**kwargs)

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

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)

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)

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)

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)

Bases: msrest.serialization.Model

Pairs of Managed Instances in the failover group.

Variables

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

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

Keyword Arguments

• 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.ManagedInstancePecProperty(**kwargs)

Bases: msrest.serialization.Model

A private endpoint connection under a managed instance.

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

Variables

• id (str) – Resource ID.

• properties (ManagedInstancePrivateEndpointConnectionProperties) – Private endpoint connection properties.

class azure.mgmt.sql.models.ManagedInstancePrivateEndpointConnection(*, private_endpoint: Optional[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointProperty] = None, private_link_service_connection_state: Optional[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateLinkServiceConnectionStateProperty] = None, **kwargs)

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

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.

• private_endpoint (ManagedInstancePrivateEndpointProperty) – Private endpoint which the connection belongs to.

• private_link_service_connection_state (ManagedInstancePrivateLinkServiceConnectionStateProperty) – Connection State of the Private Endpoint Connection.

• provisioning_state (str) – State of the Private Endpoint Connection.

Keyword Arguments

• private_endpoint (ManagedInstancePrivateEndpointProperty) – Private endpoint which the connection belongs to.

• private_link_service_connection_state (ManagedInstancePrivateLinkServiceConnectionStateProperty) – Connection State of the Private Endpoint Connection.

class azure.mgmt.sql.models.ManagedInstancePrivateEndpointConnectionListResult(**kwargs)

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[ManagedInstancePrivateEndpointConnection]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstancePrivateEndpointConnectionProperties(*, private_endpoint: Optional[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointProperty] = None, private_link_service_connection_state: Optional[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateLinkServiceConnectionStateProperty] = None, **kwargs)

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.

Variables

• private_endpoint (ManagedInstancePrivateEndpointProperty) – Private endpoint which the connection belongs to.

• private_link_service_connection_state (ManagedInstancePrivateLinkServiceConnectionStateProperty) – Connection State of the Private Endpoint Connection.

• provisioning_state (str) – State of the Private Endpoint Connection.

Keyword Arguments

• private_endpoint (ManagedInstancePrivateEndpointProperty) – Private endpoint which the connection belongs to.

• private_link_service_connection_state (ManagedInstancePrivateLinkServiceConnectionStateProperty) – Connection State of the Private Endpoint Connection.

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

Bases: msrest.serialization.Model

ManagedInstancePrivateEndpointProperty.

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.ManagedInstancePrivateLink(**kwargs)

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

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 (ManagedInstancePrivateLinkProperties) – The private link resource group id.

class azure.mgmt.sql.models.ManagedInstancePrivateLinkListResult(**kwargs)

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[ManagedInstancePrivateLink]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstancePrivateLinkProperties(**kwargs)

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.ManagedInstancePrivateLinkServiceConnectionStateProperty(*, status: str, description: str, **kwargs)

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.

Variables

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

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

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

Keyword Arguments

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

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

class azure.mgmt.sql.models.ManagedInstancePropertiesProvisioningState(value)

Bases: str, enum.Enum

An enumeration.

ACCEPTED = 'Accepted'

CANCELED = 'Canceled'

CREATED = 'Created'

CREATING = 'Creating'

DELETED = 'Deleted'

DELETING = 'Deleting'

FAILED = 'Failed'

NOT_SPECIFIED = 'NotSpecified'

REGISTERING = 'Registering'

RUNNING = 'Running'

SUCCEEDED = 'Succeeded'

TIMED_OUT = 'TimedOut'

UNKNOWN = 'Unknown'

UNRECOGNIZED = 'Unrecognized'

UPDATING = 'Updating'

class azure.mgmt.sql.models.ManagedInstanceProxyOverride(value)

Bases: str, enum.Enum

Connection type used for connecting to the instance.

DEFAULT = 'Default'

PROXY = 'Proxy'

REDIRECT = 'Redirect'

class azure.mgmt.sql.models.ManagedInstanceQuery(*, query_text: Optional[str] = None, **kwargs)

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

Database query.

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.

• query_text (str) – Query text.

Keyword Arguments

query_text (str) – Query text.

class azure.mgmt.sql.models.ManagedInstanceQueryStatistics(**kwargs)

Bases: msrest.serialization.Model

Execution statistics for one particular query.

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

Variables

• value (list[QueryStatistics]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagedInstanceUpdate(*, sku: Optional[azure.mgmt.sql.models._models_py3.Sku] = None, identity: Optional[azure.mgmt.sql.models._models_py3.ResourceIdentity] = None, tags: Optional[Dict[str, str]] = None, managed_instance_create_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedServerCreateMode]] = None, administrator_login: Optional[str] = None, administrator_login_password: Optional[str] = None, subnet_id: Optional[str] = None, license_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedInstanceLicenseType]] = 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedInstanceProxyOverride]] = None, timezone_id: Optional[str] = None, instance_pool_id: Optional[str] = None, maintenance_configuration_id: Optional[str] = None, minimal_tls_version: Optional[str] = None, requested_backup_storage_redundancy: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BackupStorageRedundancy]] = None, zone_redundant: Optional[bool] = None, primary_user_assigned_identity_id: Optional[str] = None, key_id: Optional[str] = None, administrators: Optional[azure.mgmt.sql.models._models_py3.ManagedInstanceExternalAdministrator] = None, service_principal: Optional[azure.mgmt.sql.models._models_py3.ServicePrincipal] = None, **kwargs)

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.

Variables

• sku (Sku) – Managed instance sku.

• identity (ResourceIdentity) – Managed instance identity.

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

• provisioning_state (str or ManagedInstancePropertiesProvisioningState) – Possible values include: “Creating”, “Deleting”, “Updating”, “Unknown”, “Succeeded”, “Failed”, “Accepted”, “Created”, “Deleted”, “Unrecognized”, “Running”, “Canceled”, “NotSpecified”, “Registering”, “TimedOut”.

• 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”.

• fully_qualified_domain_name (str) – The fully qualified domain name of the managed instance.

• 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.

• state (str) – The state of 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 (str) – The Dns Zone that the managed instance is in.

• 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.

• private_endpoint_connections (list[ManagedInstancePecProperty]) – List of private endpoint connections on a managed instance.

• minimal_tls_version (str) – Minimal TLS version. Allowed values: ‘None’, ‘1.0’, ‘1.1’, ‘1.2’.

• current_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage). Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage). Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• zone_redundant (bool) – Whether or not the multi-az is enabled.

• primary_user_assigned_identity_id (str) – The resource id of a user assigned identity to be used by default.

• key_id (str) – A CMK URI of the key to use for encryption.

• administrators (ManagedInstanceExternalAdministrator) – The Azure Active Directory administrator of the server.

• service_principal (ServicePrincipal) – The managed instance’s service principal.

Keyword Arguments

• sku (Sku) – Managed instance sku.

• identity (ResourceIdentity) – Managed instance identity.

• 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’.

• requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type to be used to store backups for this instance. The options are Local (LocallyRedundantStorage), Zone (ZoneRedundantStorage), Geo (GeoRedundantStorage) and GeoZone(GeoZoneRedundantStorage). Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

• zone_redundant (bool) – Whether or not the multi-az is enabled.

• primary_user_assigned_identity_id (str) – The resource id of a user assigned identity to be used by default.

• key_id (str) – A CMK URI of the key to use for encryption.

• administrators (ManagedInstanceExternalAdministrator) – The Azure Active Directory administrator of the server.

• service_principal (ServicePrincipal) – The managed instance’s service principal.

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

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.

• supported_maintenance_configurations (list[ManagedInstanceMaintenanceConfigurationCapability]) – List of supported maintenance configurations.

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

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

Keyword Arguments

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

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

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”.

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

Keyword Arguments

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[azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentRecurringScansProperties] = None, **kwargs)

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

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.

• 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 write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall.

• 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. Applies only if the storage account is not behind a Vnet or a firewall.

• recurring_scans (VulnerabilityAssessmentRecurringScansProperties) – The recurring scans settings.

Keyword Arguments

• 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 write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall.

• 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. Applies only if the storage account is not behind a Vnet or a firewall.

• recurring_scans (VulnerabilityAssessmentRecurringScansProperties) – The recurring scans settings.

class azure.mgmt.sql.models.ManagedInstanceVulnerabilityAssessmentListResult(**kwargs)

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.ManagedServerCreateMode(value)

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.ManagedServerSecurityAlertPolicy(*, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertsPolicyState]] = 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)

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

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.

• system_data (SystemData) – SystemData of SecurityAlertPolicyResource.

• state (str or SecurityAlertsPolicyState) – 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: “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, Brute_Force.

• 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.

• creation_time (datetime) – Specifies the UTC creation time of the policy.

Keyword Arguments

• state (str or SecurityAlertsPolicyState) – 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: “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, Brute_Force.

• 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)

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.ManagedShortTermRetentionPolicyName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'

class azure.mgmt.sql.models.ManagedTransparentDataEncryption(*, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionState]] = None, **kwargs)

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

A managed database transparent data encryption state.

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 TransparentDataEncryptionState) – Specifies the state of the transparent data encryption. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

state (str or TransparentDataEncryptionState) – Specifies the state of the transparent data encryption. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.sql.models.ManagedTransparentDataEncryptionListResult(**kwargs)

Bases: msrest.serialization.Model

A list of managed transparent data encryptions.

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

Variables

• value (list[ManagedTransparentDataEncryption]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ManagementOperationState(value)

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.MaxSizeCapability(**kwargs)

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)

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”.

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

Keyword Arguments

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

class azure.mgmt.sql.models.MaxSizeUnit(value)

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.Metric(**kwargs)

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)

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)

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[azure.mgmt.sql.models._models_py3.MetricDefinition], **kwargs)

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.

Variables

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

Keyword Arguments

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

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

Bases: msrest.serialization.Model

The response to a list database metrics request.

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

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.MetricName(**kwargs)

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.MetricType(value)

Bases: str, enum.Enum

An enumeration.

CPU = 'cpu'

DTU = 'dtu'

DURATION = 'duration'

IO = 'io'

LOG_IO = 'logIo'

class azure.mgmt.sql.models.MetricValue(**kwargs)

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)

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”.

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

Keyword Arguments

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)

Bases: msrest.serialization.Model

ARM Usage Name.

Variables

• value (str) – Usage name value.

• localized_value (str) – Usage name localized value.

Keyword Arguments

• value (str) – Usage name value.

• localized_value (str) – Usage name localized value.

class azure.mgmt.sql.models.NetworkIsolationSettings(*, storage_account_resource_id: Optional[str] = None, sql_server_resource_id: Optional[str] = None, **kwargs)

Bases: msrest.serialization.Model

Contains the ARM resources for which to create private endpoint connection.

Variables

• storage_account_resource_id (str) – The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter.

• sql_server_resource_id (str) – The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation.

Keyword Arguments

• storage_account_resource_id (str) – The resource id for the storage account used to store BACPAC file. If set, private endpoint connection will be created for the storage account. Must match storage account used for StorageUri parameter.

• sql_server_resource_id (str) – The resource id for the SQL server which is the target of this request. If set, private endpoint connection will be created for the SQL server. Must match server which is target of the operation.

class azure.mgmt.sql.models.Operation(**kwargs)

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, any]) – Additional descriptions for the operation.

class azure.mgmt.sql.models.OperationDisplay(**kwargs)

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)

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)

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.OperationMode(value)

Bases: str, enum.Enum

Operation Mode.

POLYBASE_IMPORT = 'PolybaseImport'

class azure.mgmt.sql.models.OperationOrigin(value)

Bases: str, enum.Enum

The intended executor of the operation.

SYSTEM = 'system'

USER = 'user'

class azure.mgmt.sql.models.OutboundFirewallRule(**kwargs)

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

An Azure SQL DB Server Outbound 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.

• provisioning_state (str) – The state of the outbound rule.

class azure.mgmt.sql.models.OutboundFirewallRuleListResult(**kwargs)

Bases: msrest.serialization.Model

A list of outbound rules.

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

Variables

• value (list[OutboundFirewallRule]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.PartnerInfo(*, id: str, **kwargs)

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.

Variables

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

• location (str) – Geo location of the partner server.

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

Keyword Arguments

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

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

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.

Variables

• location (str) – Geo location of the partner managed instances.

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

Keyword Arguments

location (str) – Geo location of the partner managed instances.

class azure.mgmt.sql.models.PauseDelayTimeUnit(value)

Bases: str, enum.Enum

Unit of time that delay is expressed in

MINUTES = 'Minutes'

class azure.mgmt.sql.models.PerformanceLevelCapability(**kwargs)

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.PerformanceLevelUnit(value)

Bases: str, enum.Enum

Unit type used to measure performance level.

DTU = 'DTU'

V_CORES = 'VCores'

class azure.mgmt.sql.models.PrimaryAggregationType(value)

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.PrincipalType(value)

Bases: str, enum.Enum

Principal Type of the sever administrator.

APPLICATION = 'Application'

GROUP = 'Group'

USER = 'User'

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

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

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.

• private_endpoint (PrivateEndpointProperty) – Private endpoint which the connection belongs to.

• private_link_service_connection_state (PrivateLinkServiceConnectionStateProperty) – Connection state of the private endpoint connection.

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

Keyword Arguments

• 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)

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[azure.mgmt.sql.models._models_py3.PrivateEndpointProperty] = None, private_link_service_connection_state: Optional[azure.mgmt.sql.models._models_py3.PrivateLinkServiceConnectionStateProperty] = None, **kwargs)

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.

Variables

• private_endpoint (PrivateEndpointProperty) – Private endpoint which the connection belongs to.

• private_link_service_connection_state (PrivateLinkServiceConnectionStateProperty) – Connection state of the private endpoint connection.

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

Keyword Arguments

• 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.PrivateEndpointConnectionRequestStatus(**kwargs)

Bases: msrest.serialization.Model

Contains the private endpoint connection requests status.

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

Variables

• private_link_service_id (str) – Resource id for which the private endpoint is created.

• private_endpoint_connection_name (str) – The connection name for the private endpoint.

• status (str) – Status of this private endpoint connection.

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

Bases: msrest.serialization.Model

PrivateEndpointProperty.

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.PrivateEndpointProvisioningState(value)

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.PrivateLinkResource(**kwargs)

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

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)

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)

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.

• required_zone_names (list[str]) – The private link resource required zone names.

class azure.mgmt.sql.models.PrivateLinkServiceConnectionStateActionsRequire(value)

Bases: str, enum.Enum

The actions required for private link service connection.

NONE = 'None'

class azure.mgmt.sql.models.PrivateLinkServiceConnectionStateProperty(*, status: Union[str, azure.mgmt.sql.models._sql_management_client_enums.PrivateLinkServiceConnectionStateStatus], description: str, **kwargs)

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.

Variables

• 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.

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

Keyword Arguments

• 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.

class azure.mgmt.sql.models.PrivateLinkServiceConnectionStateStatus(value)

Bases: str, enum.Enum

The private link service connection status.

APPROVED = 'Approved'

DISCONNECTED = 'Disconnected'

PENDING = 'Pending'

REJECTED = 'Rejected'

class azure.mgmt.sql.models.ProvisioningState(value)

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.ProxyResource(**kwargs)

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.ProxyResourceWithWritableName(*, name: Optional[str] = None, **kwargs)

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

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.

Keyword Arguments

name (str) – Resource name.

class azure.mgmt.sql.models.QueryMetricInterval(*, metrics: Optional[List[azure.mgmt.sql.models._models_py3.QueryMetricProperties]] = None, **kwargs)

Bases: msrest.serialization.Model

Properties of a query metrics interval.

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

Variables

• interval_start_time (str) – The start time for the metric interval (ISO-8601 format).

• interval_type (str or QueryTimeGrainType) – Interval type (length). Possible values include: “PT1H”, “P1D”.

• execution_count (long) – Execution count of a query in this interval.

• metrics (list[QueryMetricProperties]) – List of metric objects for this interval.

Keyword Arguments

metrics (list[QueryMetricProperties]) – List of metric objects for this interval.

class azure.mgmt.sql.models.QueryMetricProperties(**kwargs)

Bases: msrest.serialization.Model

Properties of a topquery metric in one interval.

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

Variables

• name (str) – The name information for the metric.

• display_name (str) – The UI appropriate name for the metric.

• unit (str or QueryMetricUnitType) – The unit of the metric. Possible values include: “percentage”, “KB”, “microseconds”, “count”.

• value (float) – The value of the metric.

• min (float) – Metric value when min() aggregate function is used over the interval.

• max (float) – Metric value when max() aggregate function is used over the interval.

• avg (float) – Metric value when avg() aggregate function is used over the interval.

• sum (float) – Metric value when sum() aggregate function is used over the interval.

• stdev (float) – Metric value when stdev aggregate function is used over the interval.

class azure.mgmt.sql.models.QueryMetricUnitType(value)

Bases: str, enum.Enum

The unit of the metric.

COUNT = 'count'

KB = 'KB'

MICROSECONDS = 'microseconds'

PERCENTAGE = 'percentage'

class azure.mgmt.sql.models.QueryStatistics(*, intervals: Optional[List[azure.mgmt.sql.models._models_py3.QueryMetricInterval]] = None, **kwargs)

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

QueryStatistics.

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) – Database name of the database in which this query was executed.

• query_id (str) – Unique query id (unique within one database).

• start_time (str) – The start time for the metric (ISO-8601 format).

• end_time (str) – The end time for the metric (ISO-8601 format).

• intervals (list[QueryMetricInterval]) – List of intervals with appropriate metric data.

Keyword Arguments

intervals (list[QueryMetricInterval]) – List of intervals with appropriate metric data.

class azure.mgmt.sql.models.QueryStatisticsProperties(*, intervals: Optional[List[azure.mgmt.sql.models._models_py3.QueryMetricInterval]] = None, **kwargs)

Bases: msrest.serialization.Model

Properties of a query execution statistics.

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

Variables

• database_name (str) – Database name of the database in which this query was executed.

• query_id (str) – Unique query id (unique within one database).

• start_time (str) – The start time for the metric (ISO-8601 format).

• end_time (str) – The end time for the metric (ISO-8601 format).

• intervals (list[QueryMetricInterval]) – List of intervals with appropriate metric data.

Keyword Arguments

intervals (list[QueryMetricInterval]) – List of intervals with appropriate metric data.

class azure.mgmt.sql.models.QueryTimeGrainType(value)

Bases: str, enum.Enum

Interval type (length).

P1_D = 'P1D'

PT1_H = 'PT1H'

class azure.mgmt.sql.models.ReadOnlyEndpointFailoverPolicy(value)

Bases: str, enum.Enum

Failover policy of the read-only endpoint for the failover group.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

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

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”.

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

Keyword Arguments

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

class azure.mgmt.sql.models.ReadWriteEndpointFailoverPolicy(value)

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.RecommendedAction(*, state: Optional[azure.mgmt.sql.models._models_py3.RecommendedActionStateInfo] = None, **kwargs)

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

Database, Server or Elastic Pool Recommended Action.

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.

• location (str) – Resource location.

• recommendation_reason (str) – Gets the reason for recommending this action. e.g., DuplicateIndex.

• valid_since (datetime) – Gets the time since when this recommended action is valid.

• last_refresh (datetime) – Gets time when this recommended action was last refreshed.

• state (RecommendedActionStateInfo) – Gets the info of the current state the recommended action is in.

• is_executable_action (bool) – Gets if this recommended action is actionable by user.

• is_revertable_action (bool) – Gets if changes applied by this recommended action can be reverted by user.

• is_archived_action (bool) – Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again.

• execute_action_start_time (datetime) – Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time.

• execute_action_duration (str) – Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation.

• revert_action_start_time (datetime) – Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed.

• revert_action_duration (str) – Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index.

• execute_action_initiated_by (str or RecommendedActionInitiatedBy) – Gets if approval for applying this recommended action was given by user/system. Possible values include: “User”, “System”.

• execute_action_initiated_time (datetime) – Gets the time when this recommended action was approved for execution.

• revert_action_initiated_by (str or RecommendedActionInitiatedBy) – Gets if approval for reverting this recommended action was given by user/system. Possible values include: “User”, “System”.

• revert_action_initiated_time (datetime) – Gets the time when this recommended action was approved for revert.

• score (int) – Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact.

• implementation_details (RecommendedActionImplementationInfo) – Gets the implementation details of this recommended action for user to apply it manually.

• error_details (RecommendedActionErrorInfo) – Gets the error details if and why this recommended action is put to error state.

• estimated_impact (list[RecommendedActionImpactRecord]) – Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change.

• observed_impact (list[RecommendedActionImpactRecord]) – Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change.

• time_series (list[RecommendedActionMetricInfo]) – Gets the time series info of metrics for this recommended action e.g., CPU consumption time series.

• linked_objects (list[str]) – Gets the linked objects, if any.

• details (dict[str, any]) – Gets additional details specific to this recommended action.

Keyword Arguments

state (RecommendedActionStateInfo) – Gets the info of the current state the recommended action is in.

class azure.mgmt.sql.models.RecommendedActionCurrentState(value)

Bases: str, enum.Enum

Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action.

ACTIVE = 'Active'

ERROR = 'Error'

EXECUTING = 'Executing'

EXPIRED = 'Expired'

IGNORED = 'Ignored'

MONITORING = 'Monitoring'

PENDING = 'Pending'

PENDING_REVERT = 'PendingRevert'

RESOLVED = 'Resolved'

REVERTED = 'Reverted'

REVERTING = 'Reverting'

REVERT_CANCELLED = 'RevertCancelled'

SUCCESS = 'Success'

VERIFYING = 'Verifying'

class azure.mgmt.sql.models.RecommendedActionErrorInfo(**kwargs)

Bases: msrest.serialization.Model

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

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

Variables

• error_code (str) – Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists.

• is_retryable (str or IsRetryable) – Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No. Possible values include: “Yes”, “No”.

class azure.mgmt.sql.models.RecommendedActionImpactRecord(**kwargs)

Bases: msrest.serialization.Model

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

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

Variables

• dimension_name (str) – Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

• unit (str) – Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected.

• absolute_value (float) – Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected.

• change_value_absolute (float) – Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes.

• change_value_relative (float) – Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage.

class azure.mgmt.sql.models.RecommendedActionImplementationInfo(**kwargs)

Bases: msrest.serialization.Model

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

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

Variables

• method (str or ImplementationMethod) – Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. Possible values include: “TSql”, “AzurePowerShell”.

• script (str) – Gets the manual implementation script. e.g., T-SQL script that could be executed on the database.

class azure.mgmt.sql.models.RecommendedActionInitiatedBy(value)

Bases: str, enum.Enum

Gets if approval for applying this recommended action was given by user/system.

SYSTEM = 'System'

USER = 'User'

class azure.mgmt.sql.models.RecommendedActionMetricInfo(**kwargs)

Bases: msrest.serialization.Model

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

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

Variables

• metric_name (str) – Gets the name of the metric. e.g., CPU, Number of Queries.

• unit (str) – Gets the unit in which metric is measured. e.g., DTU, Frequency.

• time_grain (str) – Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour).

• start_time (datetime) – Gets the start time of time interval given by this MetricInfo.

• value (float) – Gets the value of the metric in the time interval given by this MetricInfo.

class azure.mgmt.sql.models.RecommendedActionStateInfo(*, current_value: Union[str, azure.mgmt.sql.models._sql_management_client_enums.RecommendedActionCurrentState], **kwargs)

Bases: msrest.serialization.Model

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

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

• current_value (str or RecommendedActionCurrentState) – Required. Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. Possible values include: “Active”, “Pending”, “Executing”, “Verifying”, “PendingRevert”, “RevertCancelled”, “Reverting”, “Reverted”, “Ignored”, “Expired”, “Monitoring”, “Resolved”, “Success”, “Error”.

• action_initiated_by (str or RecommendedActionInitiatedBy) – Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to ‘Enabled’, in which case the system applied it. Possible values include: “User”, “System”.

• last_modified (datetime) – Gets the time when the state was last modified.

Keyword Arguments

current_value (str or RecommendedActionCurrentState) – Required. Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. Possible values include: “Active”, “Pending”, “Executing”, “Verifying”, “PendingRevert”, “RevertCancelled”, “Reverting”, “Reverted”, “Ignored”, “Expired”, “Monitoring”, “Resolved”, “Success”, “Error”.

class azure.mgmt.sql.models.RecommendedSensitivityLabelUpdate(*, op: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.RecommendedSensitivityLabelUpdateKind]] = None, schema: Optional[str] = None, table: Optional[str] = None, column: Optional[str] = None, **kwargs)

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

A recommended sensitivity label update 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.

• op (str or RecommendedSensitivityLabelUpdateKind) – Possible values include: “enable”, “disable”.

• schema (str) – Schema name of the column to update.

• table (str) – Table name of the column to update.

• column (str) – Column name to update.

Keyword Arguments

• op (str or RecommendedSensitivityLabelUpdateKind) – Possible values include: “enable”, “disable”.

• schema (str) – Schema name of the column to update.

• table (str) – Table name of the column to update.

• column (str) – Column name to update.

class azure.mgmt.sql.models.RecommendedSensitivityLabelUpdateKind(value)

Bases: str, enum.Enum

An enumeration.

DISABLE = 'disable'

ENABLE = 'enable'

class azure.mgmt.sql.models.RecommendedSensitivityLabelUpdateList(*, operations: Optional[List[azure.mgmt.sql.models._models_py3.RecommendedSensitivityLabelUpdate]] = None, **kwargs)

Bases: msrest.serialization.Model

A list of recommended sensitivity label update operations.

Variables

operations (list[RecommendedSensitivityLabelUpdate]) –

Keyword Arguments

operations (list[RecommendedSensitivityLabelUpdate]) –

class azure.mgmt.sql.models.RecoverableDatabase(**kwargs)

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

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[azure.mgmt.sql.models._models_py3.RecoverableDatabase], **kwargs)

Bases: msrest.serialization.Model

The response to a list recoverable databases request.

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

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.RecoverableManagedDatabase(**kwargs)

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

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)

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.ReplicaType(value)

Bases: str, enum.Enum

An enumeration.

PRIMARY = 'Primary'

READABLE_SECONDARY = 'ReadableSecondary'

class azure.mgmt.sql.models.ReplicationLink(**kwargs)

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

A 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.

• partner_server (str) – Resource partner server.

• partner_database (str) – Resource partner database.

• partner_location (str) – Resource partner location.

• role (str or ReplicationRole) – Local replication role. Possible values include: “Primary”, “Secondary”, “NonReadableSecondary”, “Source”, “Copy”.

• partner_role (str or ReplicationRole) – Partner replication role. Possible values include: “Primary”, “Secondary”, “NonReadableSecondary”, “Source”, “Copy”.

• replication_mode (str) – Replication mode.

• start_time (datetime) – Time at which the link was created.

• percent_complete (int) – Seeding completion percentage for the link.

• replication_state (str or ReplicationState) – Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED). Possible values include: “PENDING”, “SEEDING”, “CATCH_UP”, “SUSPENDED”.

• is_termination_allowed (bool) – Whether the user is currently allowed to terminate the link.

• link_type (str or ReplicationLinkType) – Link type (GEO, NAMED). Possible values include: “GEO”, “NAMED”.

class azure.mgmt.sql.models.ReplicationLinkListResult(**kwargs)

Bases: msrest.serialization.Model

A list of replication links.

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

Variables

• value (list[ReplicationLink]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ReplicationLinkType(value)

Bases: str, enum.Enum

Link type (GEO, NAMED).

GEO = 'GEO'

NAMED = 'NAMED'

class azure.mgmt.sql.models.ReplicationMode(value)

Bases: str, enum.Enum

The replication mode of a distributed availability group. Parameter will be ignored during link creation.

ASYNC_ENUM = 'Async'

SYNC = 'Sync'

class azure.mgmt.sql.models.ReplicationRole(value)

Bases: str, enum.Enum

Local replication role.

COPY = 'Copy'

NON_READABLE_SECONDARY = 'NonReadableSecondary'

PRIMARY = 'Primary'

SECONDARY = 'Secondary'

SOURCE = 'Source'

class azure.mgmt.sql.models.ReplicationState(value)

Bases: str, enum.Enum

Replication state (PENDING, SEEDING, CATCHUP, SUSPENDED).

CATCH_UP = 'CATCH_UP'

PENDING = 'PENDING'

SEEDING = 'SEEDING'

SUSPENDED = 'SUSPENDED'

class azure.mgmt.sql.models.Resource(**kwargs)

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(*, user_assigned_identities: Optional[Dict[str, azure.mgmt.sql.models._models_py3.UserIdentity]] = None, type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.IdentityType]] = None, **kwargs)

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

• user_assigned_identities (dict[str, UserIdentity]) – The resource ids of the user assigned identities to use.

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

• 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: “None”, “SystemAssigned”, “UserAssigned”, “SystemAssigned,UserAssigned”.

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

Keyword Arguments

• user_assigned_identities (dict[str, UserIdentity]) – The resource ids of the user assigned identities to use.

• 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: “None”, “SystemAssigned”, “UserAssigned”, “SystemAssigned,UserAssigned”.

class azure.mgmt.sql.models.ResourceMoveDefinition(*, id: str, **kwargs)

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.

Variables

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

Keyword Arguments

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

class azure.mgmt.sql.models.ResourceWithWritableName(*, name: Optional[str] = None, **kwargs)

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.

Keyword Arguments

name (str) – Resource name.

class azure.mgmt.sql.models.RestorableDroppedDatabase(*, sku: Optional[azure.mgmt.sql.models._models_py3.Sku] = None, location: Optional[str] = None, tags: Optional[Dict[str, str]] = None, **kwargs)

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

A restorable dropped 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.

• sku (Sku) – The name and tier of the SKU.

• location (str) – Resource location.

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

• database_name (str) – The name of the database.

• max_size_bytes (long) – The max size of the database expressed in bytes.

• 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).

• backup_storage_redundancy (str or BackupStorageRedundancy) – The storage account type used to store backups for this database. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

Keyword Arguments

• sku (Sku) – The name and tier of the SKU.

• location (str) – Resource location.

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

class azure.mgmt.sql.models.RestorableDroppedDatabaseListResult(**kwargs)

Bases: msrest.serialization.Model

A list of restorable dropped databases.

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

Variables

• value (list[RestorableDroppedDatabase]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

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

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.

• location (str) – Required. Resource location.

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

• 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).

Keyword Arguments

• location (str) – Required. Resource location.

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

class azure.mgmt.sql.models.RestorableDroppedManagedDatabaseListResult(**kwargs)

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.RestoreDetailsName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'

class azure.mgmt.sql.models.RestorePoint(**kwargs)

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

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)

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.RestorePointType(value)

Bases: str, enum.Enum

The type of restore point

CONTINUOUS = 'CONTINUOUS'

DISCRETE = 'DISCRETE'

class azure.mgmt.sql.models.SampleName(value)

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.SecondaryType(value)

Bases: str, enum.Enum

The secondary type of the database if it is a secondary. Valid values are Geo and Named.

GEO = 'Geo'

NAMED = 'Named'

class azure.mgmt.sql.models.SecurityAlertPolicyName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'Default'

class azure.mgmt.sql.models.SecurityAlertPolicyState(value)

Bases: str, enum.Enum

Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

NEW = 'New'

class azure.mgmt.sql.models.SecurityAlertsPolicyState(value)

Bases: str, enum.Enum

Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.sql.models.SecurityEvent(**kwargs)

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

A security event.

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.

• event_time (datetime) – The time when the security event occurred.

• security_event_type (str or SecurityEventType) – The type of the security event. Possible values include: “Undefined”, “SqlInjectionVulnerability”, “SqlInjectionExploit”.

• subscription (str) – The subscription name.

• server (str) – The server name.

• database (str) – The database name.

• client_ip (str) – The IP address of the client who executed the statement.

• application_name (str) – The application used to execute the statement.

• principal_name (str) – The principal user who executed the statement.

• security_event_sql_injection_additional_properties (SecurityEventSqlInjectionAdditionalProperties) – The sql injection additional properties, populated only if the type of the security event is sql injection.

class azure.mgmt.sql.models.SecurityEventCollection(**kwargs)

Bases: msrest.serialization.Model

A list of security events.

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

Variables

• value (list[SecurityEvent]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.SecurityEventSqlInjectionAdditionalProperties(**kwargs)

Bases: msrest.serialization.Model

The properties of a security event sql injection additional properties.

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

Variables

• threat_id (str) – The threat ID.

• statement (str) – The statement.

• statement_highlight_offset (int) – The statement highlight offset.

• statement_highlight_length (int) – The statement highlight length.

• error_code (int) – The sql error code.

• error_severity (int) – The sql error severity.

• error_message (str) – The sql error message.

class azure.mgmt.sql.models.SecurityEventType(value)

Bases: str, enum.Enum

The type of the security event.

SQL_INJECTION_EXPLOIT = 'SqlInjectionExploit'

SQL_INJECTION_VULNERABILITY = 'SqlInjectionVulnerability'

UNDEFINED = 'Undefined'

class azure.mgmt.sql.models.SecurityEventsFilterParameters(*, event_time: Optional[datetime.datetime] = None, show_server_records: Optional[bool] = None, **kwargs)

Bases: msrest.serialization.Model

The properties that are supported in the $filter operation.

Variables

• event_time (datetime) – Filter on the event time.

• show_server_records (bool) – Whether to show server records or not.

Keyword Arguments

• event_time (datetime) – Filter on the event time.

• show_server_records (bool) – Whether to show server records or not.

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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SensitivityLabelRank]] = None, **kwargs)

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

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.

• managed_by (str) – Resource that manages the sensitivity label.

• schema_name (str) – The schema name.

• table_name (str) – The table name.

• column_name (str) – The column name.

• 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.

• 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.

• rank (str or SensitivityLabelRank) – Possible values include: “None”, “Low”, “Medium”, “High”, “Critical”.

Keyword Arguments

• 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)

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.SensitivityLabelRank(value)

Bases: str, enum.Enum

An enumeration.

CRITICAL = 'Critical'

HIGH = 'High'

LOW = 'Low'

MEDIUM = 'Medium'

NONE = 'None'

class azure.mgmt.sql.models.SensitivityLabelSource(value)

Bases: str, enum.Enum

An enumeration.

CURRENT = 'current'

RECOMMENDED = 'recommended'

class azure.mgmt.sql.models.SensitivityLabelUpdate(*, op: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SensitivityLabelUpdateKind]] = None, schema: Optional[str] = None, table: Optional[str] = None, column: Optional[str] = None, sensitivity_label: Optional[azure.mgmt.sql.models._models_py3.SensitivityLabel] = None, **kwargs)

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

A sensitivity label update 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.

• op (str or SensitivityLabelUpdateKind) – Possible values include: “set”, “remove”.

• schema (str) – Schema name of the column to update.

• table (str) – Table name of the column to update.

• column (str) – Column name to update.

• sensitivity_label (SensitivityLabel) – The sensitivity label information to apply on a column.

Keyword Arguments

• op (str or SensitivityLabelUpdateKind) – Possible values include: “set”, “remove”.

• schema (str) – Schema name of the column to update.

• table (str) – Table name of the column to update.

• column (str) – Column name to update.

• sensitivity_label (SensitivityLabel) – The sensitivity label information to apply on a column.

class azure.mgmt.sql.models.SensitivityLabelUpdateKind(value)

Bases: str, enum.Enum

An enumeration.

REMOVE = 'remove'

SET = 'set'

class azure.mgmt.sql.models.SensitivityLabelUpdateList(*, operations: Optional[List[azure.mgmt.sql.models._models_py3.SensitivityLabelUpdate]] = None, **kwargs)

Bases: msrest.serialization.Model

A list of sensitivity label update operations.

Variables

operations (list[SensitivityLabelUpdate]) –

Keyword Arguments

operations (list[SensitivityLabelUpdate]) –

class azure.mgmt.sql.models.Server(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.sql.models._models_py3.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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServerNetworkAccessFlag]] = None, primary_user_assigned_identity_id: Optional[str] = None, federated_client_id: Optional[str] = None, key_id: Optional[str] = None, administrators: Optional[azure.mgmt.sql.models._models_py3.ServerExternalAdministrator] = None, restrict_outbound_network_access: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServerNetworkAccessFlag]] = None, **kwargs)

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.

• 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.

• kind (str) – Kind of sql server. This is metadata used for the Azure portal experience.

• 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.

• 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.

• minimal_tls_version (str) – Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’.

• public_network_access (str or ServerNetworkAccessFlag) – 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”.

• workspace_feature (str or ServerWorkspaceFeature) – Whether or not existing server has a workspace created and if it allows connection from workspace. Possible values include: “Connected”, “Disconnected”.

• primary_user_assigned_identity_id (str) – The resource id of a user assigned identity to be used by default.

• federated_client_id (str) – The Client id used for cross tenant CMK scenario.

• key_id (str) – A CMK URI of the key to use for encryption.

• administrators (ServerExternalAdministrator) – The Azure Active Directory identity of the server.

• restrict_outbound_network_access (str or ServerNetworkAccessFlag) – Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

• 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 ServerNetworkAccessFlag) – 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”.

• primary_user_assigned_identity_id (str) – The resource id of a user assigned identity to be used by default.

• federated_client_id (str) – The Client id used for cross tenant CMK scenario.

• key_id (str) – A CMK URI of the key to use for encryption.

• administrators (ServerExternalAdministrator) – The Azure Active Directory identity of the server.

• restrict_outbound_network_access (str or ServerNetworkAccessFlag) – Whether or not to restrict outbound network access 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.AutomaticTuningServerMode]] = None, options: Optional[Dict[str, azure.mgmt.sql.models._models_py3.AutomaticTuningServerOptions]] = None, **kwargs)

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

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.

• desired_state (str or AutomaticTuningServerMode) – Automatic tuning desired state. Possible values include: “Custom”, “Auto”, “Unspecified”.

• actual_state (str or AutomaticTuningServerMode) – Automatic tuning actual state. Possible values include: “Custom”, “Auto”, “Unspecified”.

• options (dict[str, AutomaticTuningServerOptions]) – Automatic tuning options definition.

Keyword Arguments

• 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorType]] = None, login: Optional[str] = None, sid: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs)

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

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.

• 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.

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

Keyword Arguments

• 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)

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

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.

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

Keyword Arguments

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

class azure.mgmt.sql.models.ServerBlobAuditingPolicy(*, is_devops_audit_enabled: Optional[bool] = None, retention_days: Optional[int] = None, audit_actions_and_groups: Optional[List[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, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BlobAuditingPolicyState]] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, storage_account_subscription_id: Optional[str] = None, **kwargs)

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

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.

• is_devops_audit_enabled (bool) –

  Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true

  When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created.

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

  For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.

• 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.

• 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.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

Keyword Arguments

• is_devops_audit_enabled (bool) –

  Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify ‘State’ as ‘Enabled’, ‘IsAzureMonitorTargetEnabled’ as true and ‘IsDevopsAuditEnabled’ as true

  When using REST API to configure auditing, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should also be created.

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

  For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.

• 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.

• 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.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

class azure.mgmt.sql.models.ServerBlobAuditingPolicyListResult(**kwargs)

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)

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

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.

• partner_server (str) – The name of the partner server.

Keyword Arguments

partner_server (str) – The name of the partner server.

class azure.mgmt.sql.models.ServerCommunicationLinkListResult(*, value: Optional[List[azure.mgmt.sql.models._models_py3.ServerCommunicationLink]] = None, **kwargs)

Bases: msrest.serialization.Model

A list of server communication links.

Variables

value (list[ServerCommunicationLink]) – The list of server communication links.

Keyword Arguments

value (list[ServerCommunicationLink]) – The list of server communication links.

class azure.mgmt.sql.models.ServerConnectionPolicy(*, connection_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServerConnectionType]] = None, **kwargs)

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

A server 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.

• location (str) – Resource location.

• kind (str) – Metadata used for the Azure portal experience.

• connection_type (str or ServerConnectionType) – The server connection type. Possible values include: “Default”, “Redirect”, “Proxy”.

Keyword Arguments

connection_type (str or ServerConnectionType) – The server connection type. Possible values include: “Default”, “Redirect”, “Proxy”.

class azure.mgmt.sql.models.ServerConnectionPolicyListResult(**kwargs)

Bases: msrest.serialization.Model

A list of server connection policy objects.

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

Variables

• value (list[ServerConnectionPolicy]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerConnectionType(value)

Bases: str, enum.Enum

The server connection type.

DEFAULT = 'Default'

PROXY = 'Proxy'

REDIRECT = 'Redirect'

class azure.mgmt.sql.models.ServerDevOpsAuditSettingsListResult(**kwargs)

Bases: msrest.serialization.Model

A list of server DevOps audit settings.

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

Variables

• value (list[ServerDevOpsAuditingSettings]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerDevOpsAuditingSettings(*, is_azure_monitor_target_enabled: Optional[bool] = None, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BlobAuditingPolicyState]] = None, storage_endpoint: Optional[str] = None, storage_account_access_key: Optional[str] = None, storage_account_subscription_id: Optional[str] = None, **kwargs)

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

A server DevOps auditing settings.

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.

• system_data (SystemData) – SystemData of ServerDevOpsAuditSettingsResource.

• is_azure_monitor_target_enabled (bool) –

  Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should be also created.

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

  For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

Keyword Arguments

• is_azure_monitor_target_enabled (bool) –

  Specifies whether DevOps 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 DevOps audit, Diagnostic Settings with ‘DevOpsOperationsAudit’ diagnostic logs category on the master database should be also created.

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

  For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell.

• state (str or BlobAuditingPolicyState) – Specifies the state of the audit. 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>`_.

• storage_account_subscription_id (str) – Specifies the blob storage subscription Id.

class azure.mgmt.sql.models.ServerDnsAlias(**kwargs)

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

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: str, **kwargs)

Bases: msrest.serialization.Model

A server dns alias acquisition request.

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

Variables

old_server_dns_alias_id (str) – Required. The id of the server alias that will be acquired to point to this server instead.

Keyword Arguments

old_server_dns_alias_id (str) – Required. The id of the server alias that will be acquired to point to this server instead.

class azure.mgmt.sql.models.ServerDnsAliasListResult(**kwargs)

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.ServerExternalAdministrator(*, administrator_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorType]] = None, principal_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.PrincipalType]] = None, login: Optional[str] = None, sid: Optional[str] = None, tenant_id: Optional[str] = None, azure_ad_only_authentication: Optional[bool] = None, **kwargs)

Bases: msrest.serialization.Model

Properties of a active directory administrator.

Variables

• administrator_type (str or AdministratorType) – Type of the sever administrator. Possible values include: “ActiveDirectory”.

• principal_type (str or PrincipalType) – Principal Type of the sever administrator. Possible values include: “User”, “Group”, “Application”.

• 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.

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

Keyword Arguments

• administrator_type (str or AdministratorType) – Type of the sever administrator. Possible values include: “ActiveDirectory”.

• principal_type (str or PrincipalType) – Principal Type of the sever administrator. Possible values include: “User”, “Group”, “Application”.

• 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.

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

class azure.mgmt.sql.models.ServerInfo(*, server_id: str, **kwargs)

Bases: msrest.serialization.Model

Server info for the server trust group.

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

Variables

server_id (str) – Required. Server Id.

Keyword Arguments

server_id (str) – Required. Server Id.

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

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

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.

• kind (str) – Kind of encryption protector. This is metadata used for the Azure portal experience.

• location (str) – Resource location.

• subregion (str) – Subregion of the server key.

• 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. If the ServerKeyType is AzureKeyVault, then the URI is required.

• thumbprint (str) – Thumbprint of the server key.

• creation_date (datetime) – The server key creation date.

• auto_rotation_enabled (bool) – Key auto rotation opt-in flag. Either true or false.

Keyword Arguments

• 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. If the ServerKeyType is AzureKeyVault, then the URI is required.

class azure.mgmt.sql.models.ServerKeyListResult(**kwargs)

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.ServerKeyType(value)

Bases: str, enum.Enum

The encryption protector type like ‘ServiceManaged’, ‘AzureKeyVault’.

AZURE_KEY_VAULT = 'AzureKeyVault'

SERVICE_MANAGED = 'ServiceManaged'

class azure.mgmt.sql.models.ServerListResult(**kwargs)

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.ServerNetworkAccessFlag(value)

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.ServerOperation(**kwargs)

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

A server 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.

• 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.ServerOperationListResult(**kwargs)

Bases: msrest.serialization.Model

The response to a list server operations request.

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

Variables

• value (list[ServerOperation]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerPrivateEndpointConnection(**kwargs)

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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertsPolicyState]] = 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)

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

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.

• system_data (SystemData) – SystemData of SecurityAlertPolicyResource.

• state (str or SecurityAlertsPolicyState) – 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: “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, Brute_Force.

• 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.

• creation_time (datetime) – Specifies the UTC creation time of the policy.

Keyword Arguments

• state (str or SecurityAlertsPolicyState) – 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: “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, Brute_Force.

• 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.ServerTrustCertificate(*, public_blob: Optional[str] = None, **kwargs)

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

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

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.

• public_blob (str) – The certificate public blob.

• thumbprint (str) – The certificate thumbprint.

• certificate_name (str) – The certificate name.

Keyword Arguments

public_blob (str) – The certificate public blob.

class azure.mgmt.sql.models.ServerTrustCertificatesListResult(**kwargs)

Bases: msrest.serialization.Model

A list of the server trust certificates which are used for secure communication between SQL On-Prem instance and the given Sql Managed Instance.

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

Variables

• value (list[ServerTrustCertificate]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerTrustGroup(*, group_members: Optional[List[azure.mgmt.sql.models._models_py3.ServerInfo]] = None, trust_scopes: Optional[List[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServerTrustGroupPropertiesTrustScopesItem]]] = None, **kwargs)

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

A server trust 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.

• group_members (list[ServerInfo]) – Group members information for the server trust group.

• trust_scopes (list[str or ServerTrustGroupPropertiesTrustScopesItem]) – Trust scope of the server trust group.

Keyword Arguments

• group_members (list[ServerInfo]) – Group members information for the server trust group.

• trust_scopes (list[str or ServerTrustGroupPropertiesTrustScopesItem]) – Trust scope of the server trust group.

class azure.mgmt.sql.models.ServerTrustGroupListResult(**kwargs)

Bases: msrest.serialization.Model

A list of server trust groups.

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

Variables

• value (list[ServerTrustGroup]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.ServerTrustGroupPropertiesTrustScopesItem(value)

Bases: str, enum.Enum

An enumeration.

GLOBAL_TRANSACTIONS = 'GlobalTransactions'

SERVICE_BROKER = 'ServiceBroker'

class azure.mgmt.sql.models.ServerUpdate(*, identity: Optional[azure.mgmt.sql.models._models_py3.ResourceIdentity] = None, 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServerNetworkAccessFlag]] = None, primary_user_assigned_identity_id: Optional[str] = None, federated_client_id: Optional[str] = None, key_id: Optional[str] = None, administrators: Optional[azure.mgmt.sql.models._models_py3.ServerExternalAdministrator] = None, restrict_outbound_network_access: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServerNetworkAccessFlag]] = None, **kwargs)

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.

Variables

• identity (ResourceIdentity) – Server identity.

• 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.

• 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.

• minimal_tls_version (str) – Minimal TLS version. Allowed values: ‘1.0’, ‘1.1’, ‘1.2’.

• public_network_access (str or ServerNetworkAccessFlag) – 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”.

• workspace_feature (str or ServerWorkspaceFeature) – Whether or not existing server has a workspace created and if it allows connection from workspace. Possible values include: “Connected”, “Disconnected”.

• primary_user_assigned_identity_id (str) – The resource id of a user assigned identity to be used by default.

• federated_client_id (str) – The Client id used for cross tenant CMK scenario.

• key_id (str) – A CMK URI of the key to use for encryption.

• administrators (ServerExternalAdministrator) – The Azure Active Directory identity of the server.

• restrict_outbound_network_access (str or ServerNetworkAccessFlag) – Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

• identity (ResourceIdentity) – Server identity.

• 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 ServerNetworkAccessFlag) – 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”.

• primary_user_assigned_identity_id (str) – The resource id of a user assigned identity to be used by default.

• federated_client_id (str) – The Client id used for cross tenant CMK scenario.

• key_id (str) – A CMK URI of the key to use for encryption.

• administrators (ServerExternalAdministrator) – The Azure Active Directory identity of the server.

• restrict_outbound_network_access (str or ServerNetworkAccessFlag) – Whether or not to restrict outbound network access 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.ServerUsage(**kwargs)

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[azure.mgmt.sql.models._models_py3.ServerUsage], **kwargs)

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.

Variables

value (list[ServerUsage]) – Required. The list of server metrics for the server.

Keyword Arguments

value (list[ServerUsage]) – Required. The list of server metrics for the server.

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

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”.

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

Keyword Arguments

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[azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentRecurringScansProperties] = None, **kwargs)

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

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.

• 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 write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall.

• 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. Applies only if the storage account is not behind a Vnet or a firewall.

• recurring_scans (VulnerabilityAssessmentRecurringScansProperties) – The recurring scans settings.

Keyword Arguments

• 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 write access to the blob container specified in ‘storageContainerPath’ parameter. If ‘storageAccountAccessKey’ isn’t specified, StorageContainerSasKey is required. Applies only if the storage account is not behind a Vnet or a firewall.

• 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. Applies only if the storage account is not behind a Vnet or a firewall.

• recurring_scans (VulnerabilityAssessmentRecurringScansProperties) – The recurring scans settings.

class azure.mgmt.sql.models.ServerVulnerabilityAssessmentListResult(**kwargs)

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.ServerWorkspaceFeature(value)

Bases: str, enum.Enum

Whether or not existing server has a workspace created and if it allows connection from workspace

CONNECTED = 'Connected'

DISCONNECTED = 'Disconnected'

class azure.mgmt.sql.models.ServiceObjective(**kwargs)

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

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)

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.

• supported_maintenance_configurations (list[MaintenanceConfigurationCapability]) – List of supported maintenance configurations.

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

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

Keyword Arguments

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

class azure.mgmt.sql.models.ServiceObjectiveListResult(*, value: List[azure.mgmt.sql.models._models_py3.ServiceObjective], **kwargs)

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.

Variables

value (list[ServiceObjective]) – Required. The list of database service objectives.

Keyword Arguments

value (list[ServiceObjective]) – Required. The list of database service objectives.

class azure.mgmt.sql.models.ServiceObjectiveName(value)

Bases: str, enum.Enum

The serviceLevelObjective for SLO usage metric.

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.ServicePrincipal(*, type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServicePrincipalType]] = None, **kwargs)

Bases: msrest.serialization.Model

The managed instance’s service principal 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 application object id.

• client_id (str) – The Azure Active Directory application client id.

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

• type (str or ServicePrincipalType) – Service principal type. Possible values include: “None”, “SystemAssigned”.

Keyword Arguments

type (str or ServicePrincipalType) – Service principal type. Possible values include: “None”, “SystemAssigned”.

class azure.mgmt.sql.models.ServicePrincipalType(value)

Bases: str, enum.Enum

Service principal type.

NONE = 'None'

SYSTEM_ASSIGNED = 'SystemAssigned'

class azure.mgmt.sql.models.ShortTermRetentionPolicyName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'

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)

Bases: msrest.serialization.Model

An ARM Resource SKU.

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

Variables

• 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.

Keyword Arguments

• 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)

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.SqlAgentConfiguration(*, state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SqlAgentConfigurationPropertiesState]] = None, **kwargs)

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

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.

• state (str or SqlAgentConfigurationPropertiesState) – The state of Sql Agent. Possible values include: “Enabled”, “Disabled”.

Keyword Arguments

state (str or SqlAgentConfigurationPropertiesState) – The state of Sql Agent. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.sql.models.SqlAgentConfigurationPropertiesState(value)

Bases: str, enum.Enum

The state of Sql Agent.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

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

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”.

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

Keyword Arguments

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

class azure.mgmt.sql.models.StorageCapabilityStorageAccountType(value)

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(value)

Bases: str, enum.Enum

Storage key type.

SHARED_ACCESS_KEY = 'SharedAccessKey'

STORAGE_ACCESS_KEY = 'StorageAccessKey'

class azure.mgmt.sql.models.SubscriptionUsage(**kwargs)

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

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)

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)

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

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.

• sync_database_id (str) – ARM resource id of the sync database in 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.

Keyword Arguments

sync_database_id (str) – ARM resource id of the sync database in the sync agent.

class azure.mgmt.sql.models.SyncAgentKeyProperties(**kwargs)

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)

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

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)

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)

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.SyncAgentState(value)

Bases: str, enum.Enum

State of the sync agent.

NEVER_CONNECTED = 'NeverConnected'

OFFLINE = 'Offline'

ONLINE = 'Online'

class azure.mgmt.sql.models.SyncConflictResolutionPolicy(value)

Bases: str, enum.Enum

Conflict resolution policy of the sync group.

HUB_WIN = 'HubWin'

MEMBER_WIN = 'MemberWin'

class azure.mgmt.sql.models.SyncDatabaseIdListResult(**kwargs)

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)

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.SyncDirection(value)

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.SyncFullSchemaProperties(**kwargs)

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)

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)

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)

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(*, sku: Optional[azure.mgmt.sql.models._models_py3.Sku] = None, interval: Optional[int] = None, conflict_resolution_policy: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SyncConflictResolutionPolicy]] = None, sync_database_id: Optional[str] = None, hub_database_user_name: Optional[str] = None, hub_database_password: Optional[str] = None, schema: Optional[azure.mgmt.sql.models._models_py3.SyncGroupSchema] = None, enable_conflict_logging: Optional[bool] = None, conflict_logging_retention_in_days: Optional[int] = None, use_private_link_connection: Optional[bool] = None, **kwargs)

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

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.

• sku (Sku) – The name and capacity of the SKU.

• interval (int) – Sync interval of the sync group.

• last_sync_time (datetime) – Last sync time 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.

• sync_state (str or SyncGroupState) – Sync state of the sync group. Possible values include: “NotReady”, “Error”, “Warning”, “Progressing”, “Good”.

• schema (SyncGroupSchema) – Sync schema of the sync group.

• enable_conflict_logging (bool) – If conflict logging is enabled.

• conflict_logging_retention_in_days (int) – Conflict logging retention period.

• use_private_link_connection (bool) – If use private link connection is enabled.

• private_endpoint_name (str) – Private endpoint name of the sync group if use private link connection is enabled.

Keyword Arguments

• sku (Sku) – The name and capacity of the SKU.

• 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.

• enable_conflict_logging (bool) – If conflict logging is enabled.

• conflict_logging_retention_in_days (int) – Conflict logging retention period.

• use_private_link_connection (bool) – If use private link connection is enabled.

class azure.mgmt.sql.models.SyncGroupListResult(**kwargs)

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)

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)

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.SyncGroupLogType(value)

Bases: str, enum.Enum

Type of the sync group log.

ALL = 'All'

ERROR = 'Error'

SUCCESS = 'Success'

WARNING = 'Warning'

class azure.mgmt.sql.models.SyncGroupSchema(*, tables: Optional[List[azure.mgmt.sql.models._models_py3.SyncGroupSchemaTable]] = None, master_sync_member_name: Optional[str] = None, **kwargs)

Bases: msrest.serialization.Model

Properties of sync group schema.

Variables

• 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.

Keyword Arguments

• 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[azure.mgmt.sql.models._models_py3.SyncGroupSchemaTableColumn]] = None, quoted_name: Optional[str] = None, **kwargs)

Bases: msrest.serialization.Model

Properties of table in sync group schema.

Variables

• columns (list[SyncGroupSchemaTableColumn]) – List of columns in sync group schema.

• quoted_name (str) – Quoted name of sync group schema table.

Keyword Arguments

• 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)

Bases: msrest.serialization.Model

Properties of column in sync group table.

Variables

• 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.

Keyword Arguments

• 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.SyncGroupState(value)

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.SyncGroupsType(value)

Bases: str, enum.Enum

An enumeration.

ALL = 'All'

ERROR = 'Error'

SUCCESS = 'Success'

WARNING = 'Warning'

class azure.mgmt.sql.models.SyncMember(*, database_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SyncMemberDbType]] = 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.SyncDirection]] = None, **kwargs)

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

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.

• 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.

• private_endpoint_name (str) – Private endpoint name of the sync member if use private link connection is enabled, for sync members in Azure.

• 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”.

• 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”.

Keyword Arguments

• 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.SyncMemberDbType(value)

Bases: str, enum.Enum

Type of the sync agent linked database.

AZURE_SQL_DATABASE = 'AzureSqlDatabase'

SQL_SERVER_DATABASE = 'SqlServerDatabase'

class azure.mgmt.sql.models.SyncMemberListResult(**kwargs)

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.SyncMemberState(value)

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.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)

Bases: msrest.serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

• created_by (str) – The identity that created the resource.

• created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

• created_at (datetime) – The timestamp of resource creation (UTC).

• last_modified_by (str) – The identity that last modified the resource.

• last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

• last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

• created_by (str) – The identity that created the resource.

• created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

• created_at (datetime) – The timestamp of resource creation (UTC).

• last_modified_by (str) – The identity that last modified the resource.

• last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.

• last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.sql.models.TableTemporalType(value)

Bases: str, enum.Enum

The table temporal type.

HISTORY_TABLE = 'HistoryTable'

NON_TEMPORAL_TABLE = 'NonTemporalTable'

SYSTEM_VERSIONED_TEMPORAL_TABLE = 'SystemVersionedTemporalTable'

class azure.mgmt.sql.models.TdeCertificate(*, private_blob: Optional[str] = None, cert_password: Optional[str] = None, **kwargs)

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

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.

• private_blob (str) – The base64 encoded certificate private blob.

• cert_password (str) – The certificate password.

Keyword Arguments

• private_blob (str) – The base64 encoded certificate private blob.

• cert_password (str) – The certificate password.

class azure.mgmt.sql.models.TimeZone(**kwargs)

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

Time Zone.

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.

• time_zone_id (str) – The time zone id.

• display_name (str) – The time zone display name.

class azure.mgmt.sql.models.TimeZoneListResult(**kwargs)

Bases: msrest.serialization.Model

A list of time zones.

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

Variables

• value (list[TimeZone]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sql.models.TopQueries(*, queries: Optional[List[azure.mgmt.sql.models._models_py3.QueryStatisticsProperties]] = None, **kwargs)

Bases: msrest.serialization.Model

TopQueries.

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

Variables

• number_of_queries (int) – Requested number of top queries.

• aggregation_function (str) – Aggregation function used to calculate query metrics.

• observation_metric (str) – Metric used to rank queries.

• interval_type (str or QueryTimeGrainType) – Interval type (length). Possible values include: “PT1H”, “P1D”.

• start_time (str) – The start time for the metric (ISO-8601 format).

• end_time (str) – The end time for the metric (ISO-8601 format).

• queries (list[QueryStatisticsProperties]) – List of top resource consuming queries with appropriate metric data.

Keyword Arguments

queries (list[QueryStatisticsProperties]) – List of top resource consuming queries with appropriate metric data.

class azure.mgmt.sql.models.TopQueriesListResult(**kwargs)

Bases: msrest.serialization.Model

A list of top resource consuming queries on managed instance.

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

Variables

• value (list[TopQueries]) – Array of results.

• next_link (str) – Link to retrieve next page of results.

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

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.

• location (str) – Required. Resource location.

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

Keyword Arguments

• location (str) – Required. Resource location.

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

class azure.mgmt.sql.models.TransparentDataEncryptionName(value)

Bases: str, enum.Enum

An enumeration.

CURRENT = 'current'

class azure.mgmt.sql.models.TransparentDataEncryptionState(value)

Bases: str, enum.Enum

Specifies the state of the transparent data encryption.

DISABLED = 'Disabled'

ENABLED = 'Enabled'

class azure.mgmt.sql.models.UnitDefinitionType(value)

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(value)

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.UnlinkParameters(*, forced_termination: Optional[bool] = None, **kwargs)

Bases: msrest.serialization.Model

Represents the parameters for Unlink Replication Link request.

Variables

forced_termination (bool) – Determines whether link will be terminated in a forced or a friendly way.

Keyword Arguments

forced_termination (bool) – Determines whether link will be terminated in a forced or a friendly way.

class azure.mgmt.sql.models.UpdateLongTermRetentionBackupParameters(*, requested_backup_storage_redundancy: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.BackupStorageRedundancy]] = None, **kwargs)

Bases: msrest.serialization.Model

Contains the information necessary to perform long term retention backup update operation.

Variables

requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the copied backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

Keyword Arguments

requested_backup_storage_redundancy (str or BackupStorageRedundancy) – The storage redundancy type of the copied backup. Possible values include: “Geo”, “Local”, “Zone”, “GeoZone”.

class azure.mgmt.sql.models.UpdateManagedInstanceDnsServersOperation(**kwargs)

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

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.

• status (str or DnsRefreshConfigurationPropertiesStatus) – The status of the DNS refresh operation. Possible values include: “Succeeded”, “Failed”.

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)

Bases: msrest.serialization.Model

UpsertManagedServerOperationParameters.

Variables

• family (str) –

• tier (str) –

• v_cores (int) –

• storage_size_in_gb (int) –

Keyword Arguments

• 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: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.UpsertManagedServerOperationStepStatus]] = None, **kwargs)

Bases: msrest.serialization.Model

UpsertManagedServerOperationStep.

Variables

• order (int) –

• name (str) –

• status (str or UpsertManagedServerOperationStepStatus) – Possible values include: “NotStarted”, “InProgress”, “SlowedDown”, “Completed”, “Failed”, “Canceled”.

Keyword Arguments

• order (int) –

• name (str) –

• status (str or UpsertManagedServerOperationStepStatus) – Possible values include: “NotStarted”, “InProgress”, “SlowedDown”, “Completed”, “Failed”, “Canceled”.

class azure.mgmt.sql.models.UpsertManagedServerOperationStepStatus(value)

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.Usage(**kwargs)

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)

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.UserIdentity(**kwargs)

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.

• client_id (str) – The Azure Active Directory client id.

class azure.mgmt.sql.models.VirtualCluster(*, location: str, tags: Optional[Dict[str, str]] = None, family: Optional[str] = None, maintenance_configuration_id: Optional[str] = None, **kwargs)

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.

• location (str) – Required. Resource location.

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

• subnet_id (str) – Subnet resource ID for the virtual cluster.

• family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

• child_resources (list[str]) – List of resources in this virtual cluster.

• maintenance_configuration_id (str) – Specifies maintenance configuration id to apply to this virtual cluster.

Keyword Arguments

• 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.

• maintenance_configuration_id (str) – Specifies maintenance configuration id to apply to this virtual cluster.

class azure.mgmt.sql.models.VirtualClusterListResult(**kwargs)

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, maintenance_configuration_id: Optional[str] = None, **kwargs)

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.

Variables

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

• subnet_id (str) – Subnet resource ID for the virtual cluster.

• family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.

• child_resources (list[str]) – List of resources in this virtual cluster.

• maintenance_configuration_id (str) – Specifies maintenance configuration id to apply to this virtual cluster.

Keyword Arguments

• 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.

• maintenance_configuration_id (str) – Specifies maintenance configuration id to apply to 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)

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

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.

• 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.

• state (str or VirtualNetworkRuleState) – Virtual Network Rule State. Possible values include: “Initializing”, “InProgress”, “Ready”, “Failed”, “Deleting”, “Unknown”.

Keyword Arguments

• 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)

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.VirtualNetworkRuleState(value)

Bases: str, enum.Enum

Virtual Network Rule State

DELETING = 'Deleting'

FAILED = 'Failed'

INITIALIZING = 'Initializing'

IN_PROGRESS = 'InProgress'

READY = 'Ready'

UNKNOWN = 'Unknown'

class azure.mgmt.sql.models.VulnerabilityAssessmentName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'

class azure.mgmt.sql.models.VulnerabilityAssessmentPolicyBaselineName(value)

Bases: str, enum.Enum

An enumeration.

DEFAULT = 'default'

MASTER = 'master'

class azure.mgmt.sql.models.VulnerabilityAssessmentRecurringScansProperties(*, is_enabled: Optional[bool] = None, email_subscription_admins: Optional[bool] = True, emails: Optional[List[str]] = None, **kwargs)

Bases: msrest.serialization.Model

Properties of a Vulnerability Assessment recurring scans.

Variables

• 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.

Keyword Arguments

• 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)

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)

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

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)

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.VulnerabilityAssessmentScanState(value)

Bases: str, enum.Enum

The scan status.

FAILED = 'Failed'

FAILED_TO_RUN = 'FailedToRun'

IN_PROGRESS = 'InProgress'

PASSED = 'Passed'

class azure.mgmt.sql.models.VulnerabilityAssessmentScanTriggerType(value)

Bases: str, enum.Enum

The scan trigger type.

ON_DEMAND = 'OnDemand'

RECURRING = 'Recurring'

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)

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

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.

• 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.

Keyword Arguments

• 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)

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)

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

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.

• 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.

Keyword Arguments

• 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)

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.