azure.mgmt.sql.models module

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

Bases: azure.mgmt.sql.models.proxy_resource_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.RestorableDroppedDatabase(**kwargs)[source]

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

A restorable dropped database.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • location (str) – The geo-location where the resource lives
  • database_name (str) – The name of the database
  • edition (str) – The edition of the database
  • max_size_bytes (str) – The max size in bytes of the database
  • service_level_objective (str) – The service level objective name of the database
  • elastic_pool_name (str) – The elastic pool name of the database
  • creation_date (datetime) – The creation date of the database (ISO8601 format)
  • deletion_date (datetime) – The deletion date of the database (ISO8601 format)
  • earliest_restore_date (datetime) – The earliest restore date of the database (ISO8601 format)
class azure.mgmt.sql.models.TrackedResource(*, location: str, tags=None, **kwargs)[source]

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

ARM tracked top level resource.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
class azure.mgmt.sql.models.Resource(**kwargs)[source]

Bases: msrest.serialization.Model

ARM resource.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
class azure.mgmt.sql.models.ProxyResource(**kwargs)[source]

Bases: azure.mgmt.sql.models.resource_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.CheckNameAvailabilityRequest(*, name: str, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

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

Parameters:name (str) – Required. The name whose availability is to be checked.
Variables:type (str) – Required. The type of resource that is used as the scope of the availability check. Default value: “Microsoft.Sql/servers” .
type = 'Microsoft.Sql/servers'
class azure.mgmt.sql.models.CheckNameAvailabilityResponse(**kwargs)[source]

Bases: msrest.serialization.Model

A response indicating whether the specified name for a resource is available.

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

Variables:
  • available (bool) – True if the name is available, otherwise false.
  • message (str) – A message explaining why the name is unavailable. Will be null if the name is available.
  • name (str) – The name whose availability was checked.
  • reason (str or CheckNameAvailabilityReason) – The reason code explaining why the name is unavailable. Will be null if the name is available. Possible values include: ‘Invalid’, ‘AlreadyExists’
class azure.mgmt.sql.models.ServerConnectionPolicy(*, connection_type, **kwargs)[source]

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

A server secure connection 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) – Metadata used for the Azure portal experience.
  • location (str) – Resource location.
Parameters:

connection_type (str or ServerConnectionType) – Required. The server connection type. Possible values include: ‘Default’, ‘Proxy’, ‘Redirect’

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

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

Contains information about a database Threat Detection 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) – Resource kind.
Parameters:
  • location (str) – The geo-location where the resource lives
  • state (str or SecurityAlertPolicyState) – Required. Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required. Possible values include: ‘New’, ‘Enabled’, ‘Disabled’
  • disabled_alerts (str) – Specifies the semicolon-separated list of alerts that are disabled, or empty string to disable no alerts. Possible values: Sql_Injection; Sql_Injection_Vulnerability; Access_Anomaly; Usage_Anomaly.
  • email_addresses (str) – Specifies the semicolon-separated list of e-mail addresses to which the alert is sent.
  • email_account_admins (str or SecurityAlertPolicyEmailAccountAdmins) – Specifies that the alert is sent to the account administrators. Possible values include: ‘Enabled’, ‘Disabled’
  • storage_endpoint (str) – Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. If state is Enabled, storageEndpoint is required.
  • storage_account_access_key (str) – Specifies the identifier key of the Threat Detection audit storage account. If state is Enabled, storageAccountAccessKey is required.
  • retention_days (int) – Specifies the number of days to keep in the Threat Detection audit logs.
  • use_server_default (str or SecurityAlertPolicyUseServerDefault) – Specifies whether to use the default server policy. Possible values include: ‘Enabled’, ‘Disabled’
class azure.mgmt.sql.models.DataMaskingPolicy(*, data_masking_state, exempt_principals: str = None, **kwargs)[source]

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

Represents a database data masking 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.
  • 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.
  • location (str) – The location of the data masking policy.
  • kind (str) – The kind of data masking policy. Metadata, used for Azure portal.
Parameters:
  • data_masking_state (str or DataMaskingState) – Required. 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(*, schema_name: str, table_name: str, column_name: str, masking_function, alias_name: str = None, rule_state=None, number_from: str = None, number_to: str = None, prefix_size: str = None, suffix_size: str = None, replacement_string: str = None, **kwargs)[source]

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

Represents a database data masking rule.

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.
  • data_masking_rule_id (str) – The rule Id.
  • location (str) – The location of the data masking rule.
  • kind (str) – The kind of Data Masking Rule. Metadata, used for Azure portal.
Parameters:
  • alias_name (str) – The alias name. This is a legacy parameter and is no longer used.
  • rule_state (str or DataMaskingRuleState) – The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn’t already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState. Possible values include: ‘Disabled’, ‘Enabled’
  • schema_name (str) – Required. The schema name on which the data masking rule is applied.
  • table_name (str) – Required. The table name on which the data masking rule is applied.
  • column_name (str) – Required. The column name on which the data masking rule is applied.
  • masking_function (str or DataMaskingFunction) – Required. 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.FirewallRule(*, start_ip_address: str, end_ip_address: str, **kwargs)[source]

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

Represents a server firewall rule.

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 server that contains this firewall rule.
  • location (str) – Location of the server that contains this firewall rule.
Parameters:
  • start_ip_address (str) – Required. The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ to represent all Azure-internal IP addresses.
  • end_ip_address (str) – Required. The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ to represent all Azure-internal IP addresses.
class azure.mgmt.sql.models.GeoBackupPolicy(*, state, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • storage_type (str) – The storage type of the geo backup policy.
  • kind (str) – Kind of geo backup policy. This is metadata used for the Azure portal experience.
  • location (str) – Backup policy location.
Parameters:

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

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

Bases: msrest.serialization.Model

Import database parameters.

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

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

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

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

operation_mode = 'Import'
class azure.mgmt.sql.models.ImportExportResponse(**kwargs)[source]

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

Response for Import/Export Get operation.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • request_type (str) – The request type of the operation.
  • request_id (str) – The request type of the operation.
  • server_name (str) – The name of the server.
  • database_name (str) – The name of the database.
  • status (str) – The status message returned from the server.
  • last_modified_time (str) – The operation status last modified time.
  • queued_time (str) – The operation queued time.
  • blob_uri (str) – The blob uri.
  • error_message (str) – The error message returned from the server.
class azure.mgmt.sql.models.ImportRequest(*, storage_key_type, storage_key: str, storage_uri: str, administrator_login: str, administrator_login_password: str, database_name: str, edition, service_objective_name, max_size_bytes: str, authentication_type='SQL', **kwargs)[source]

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

Import database parameters.

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

Parameters:
  • storage_key_type (str or StorageKeyType) – Required. The type of the storage key to use. Possible values include: ‘StorageAccessKey’, ‘SharedAccessKey’
  • storage_key (str) – Required. The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a “?.”
  • storage_uri (str) – Required. The storage uri to use.
  • administrator_login (str) – Required. The name of the SQL administrator.
  • administrator_login_password (str) – Required. The password of the SQL administrator.
  • authentication_type (str or AuthenticationType) – The authentication type. Possible values include: ‘SQL’, ‘ADPassword’. Default value: “SQL” .
  • database_name (str) – Required. The name of the database to import.
  • edition (str or DatabaseEdition) – Required. The edition for the database being created. Possible values include: ‘Web’, ‘Business’, ‘Basic’, ‘Standard’, ‘Premium’, ‘PremiumRS’, ‘Free’, ‘Stretch’, ‘DataWarehouse’, ‘System’, ‘System2’
  • service_objective_name (str or ServiceObjectiveName) – Required. The name of the service objective to assign to the database. Possible values include: ‘System’, ‘System0’, ‘System1’, ‘System2’, ‘System3’, ‘System4’, ‘System2L’, ‘System3L’, ‘System4L’, ‘Free’, ‘Basic’, ‘S0’, ‘S1’, ‘S2’, ‘S3’, ‘S4’, ‘S6’, ‘S7’, ‘S9’, ‘S12’, ‘P1’, ‘P2’, ‘P3’, ‘P4’, ‘P6’, ‘P11’, ‘P15’, ‘PRS1’, ‘PRS2’, ‘PRS4’, ‘PRS6’, ‘DW100’, ‘DW200’, ‘DW300’, ‘DW400’, ‘DW500’, ‘DW600’, ‘DW1000’, ‘DW1200’, ‘DW1000c’, ‘DW1500’, ‘DW1500c’, ‘DW2000’, ‘DW2000c’, ‘DW3000’, ‘DW2500c’, ‘DW3000c’, ‘DW6000’, ‘DW5000c’, ‘DW6000c’, ‘DW7500c’, ‘DW10000c’, ‘DW15000c’, ‘DW30000c’, ‘DS100’, ‘DS200’, ‘DS300’, ‘DS400’, ‘DS500’, ‘DS600’, ‘DS1000’, ‘DS1200’, ‘DS1500’, ‘DS2000’, ‘ElasticPool’
  • max_size_bytes (str) – Required. The maximum size for the newly imported database.
class azure.mgmt.sql.models.ExportRequest(*, storage_key_type, storage_key: str, storage_uri: str, administrator_login: str, administrator_login_password: str, authentication_type='SQL', **kwargs)[source]

Bases: msrest.serialization.Model

Export database parameters.

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

Parameters:
  • storage_key_type (str or StorageKeyType) – Required. The type of the storage key to use. Possible values include: ‘StorageAccessKey’, ‘SharedAccessKey’
  • storage_key (str) – Required. The storage key to use. If storage key type is SharedAccessKey, it must be preceded with a “?.”
  • storage_uri (str) – Required. The storage uri to use.
  • administrator_login (str) – Required. The name of the SQL administrator.
  • administrator_login_password (str) – Required. The password of the SQL administrator.
  • authentication_type (str or AuthenticationType) – The authentication type. Possible values include: ‘SQL’, ‘ADPassword’. Default value: “SQL” .
class azure.mgmt.sql.models.MetricValue(**kwargs)[source]

Bases: msrest.serialization.Model

Represents database metrics.

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

Variables:
  • count (float) – 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.MetricName(**kwargs)[source]

Bases: msrest.serialization.Model

A database metric name.

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

Variables:
  • value (str) – The name of the database metric.
  • localized_value (str) – The friendly name of the database metric.
class azure.mgmt.sql.models.Metric(**kwargs)[source]

Bases: msrest.serialization.Model

Database metrics.

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

Variables:
  • start_time (datetime) – The start time for the metric (ISO-8601 format).
  • end_time (datetime) – The end time for the metric (ISO-8601 format).
  • time_grain (str) – The time step to be used to summarize the metric values.
  • unit (str or UnitType) – The unit of the metric. Possible values include: ‘count’, ‘bytes’, ‘seconds’, ‘percent’, ‘countPerSecond’, ‘bytesPerSecond’
  • name (MetricName) – The name information for the metric.
  • metric_values (list[MetricValue]) – The metric values for the specified time window and timestep.
class azure.mgmt.sql.models.MetricAvailability(**kwargs)[source]

Bases: msrest.serialization.Model

A metric availability value.

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

Variables:
  • retention (str) – The length of retention for the database metric.
  • time_grain (str) – The granularity of the database metric.
class azure.mgmt.sql.models.MetricDefinition(**kwargs)[source]

Bases: msrest.serialization.Model

A database metric definition.

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

Variables:
  • name (MetricName) – The name information for the metric.
  • primary_aggregation_type (str or PrimaryAggregationType) – The primary aggregation type defining how metric values are displayed. Possible values include: ‘None’, ‘Average’, ‘Count’, ‘Minimum’, ‘Maximum’, ‘Total’
  • resource_uri (str) – The resource uri of the database.
  • unit (str or UnitDefinitionType) – The unit of the metric. Possible values include: ‘Count’, ‘Bytes’, ‘Seconds’, ‘Percent’, ‘CountPerSecond’, ‘BytesPerSecond’
  • metric_availabilities (list[MetricAvailability]) – The list of database metric availabities for the metric.
class azure.mgmt.sql.models.RecommendedElasticPoolMetric(*, date_time_property=None, dtu: float = None, size_gb: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

Represents recommended elastic pool metric.

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

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

Represents a recommented elastic pool.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • database_edition (str or ElasticPoolEdition) – The edition of the recommended elastic pool. The ElasticPoolEdition enumeration contains all the valid editions. Possible values include: ‘Basic’, ‘Standard’, ‘Premium’
  • observation_period_start (datetime) – The observation period start (ISO8601 format).
  • observation_period_end (datetime) – The observation period start (ISO8601 format).
  • max_observed_dtu (float) – Gets maximum observed DTU.
  • max_observed_storage_mb (float) – Gets maximum observed storage in megabytes.
  • databases (list[TrackedResource]) – The list of databases in this pool. Expanded property
  • metrics (list[RecommendedElasticPoolMetric]) – The list of databases housed in the server. Expanded property
Parameters:
  • dtu (float) – The DTU for the recommended elastic pool.
  • database_dtu_min (float) – The minimum DTU for the database.
  • database_dtu_max (float) – The maximum DTU for the database.
  • storage_mb (float) – Gets storage size in megabytes.

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

Represents a database replication link.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • location (str) – Location of the server that contains this firewall rule.
  • is_termination_allowed (bool) – Legacy value indicating whether termination is allowed. Currently always returns true.
  • replication_mode (str) – Replication mode of this replication link.
  • partner_server (str) – The name of the server hosting the partner database.
  • partner_database (str) – The name of the partner database.
  • partner_location (str) – The Azure Region of the partner database.
  • role (str or ReplicationRole) – The role of the database in the replication link. Possible values include: ‘Primary’, ‘Secondary’, ‘NonReadableSecondary’, ‘Source’, ‘Copy’
  • partner_role (str or ReplicationRole) – The role of the partner database in the replication link. Possible values include: ‘Primary’, ‘Secondary’, ‘NonReadableSecondary’, ‘Source’, ‘Copy’
  • start_time (datetime) – The start time for the replication link.
  • percent_complete (int) – The percentage of seeding complete for the replication link.
  • replication_state (str or ReplicationState) – The replication state for the replication link. Possible values include: ‘PENDING’, ‘SEEDING’, ‘CATCH_UP’, ‘SUSPENDED’
class azure.mgmt.sql.models.ServerAzureADAdministrator(*, login: str, sid: str, tenant_id: str, **kwargs)[source]

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

An server Active Directory Administrator.

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.
  • administrator_type (str) – Required. The type of administrator. Default value: “ActiveDirectory” .
Parameters:
  • login (str) – Required. The server administrator login value.
  • sid (str) – Required. The server administrator Sid (Secure ID).
  • tenant_id (str) – Required. The server Active Directory Administrator tenant id.
administrator_type = 'ActiveDirectory'

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

Server communication link.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • state (str) – The state.
  • location (str) – Communication link location.
  • kind (str) – Communication link kind. This property is used for Azure Portal metadata.
Parameters:

partner_server (str) – Required. The name of the partner server.

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

Bases: azure.mgmt.sql.models.proxy_resource_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.ElasticPoolActivity(*, location: str = None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • end_time (datetime) – The time the operation finished (ISO8601 format).
  • error_code (int) – The error code if available.
  • error_message (str) – The error message if available.
  • error_severity (int) – The error severity if available.
  • operation (str) – The operation name.
  • operation_id (str) – The unique operation ID.
  • percent_complete (int) – The percentage complete if available.
  • requested_database_dtu_max (int) – The requested max DTU per database if available.
  • requested_database_dtu_min (int) – The requested min DTU per database if available.
  • requested_dtu (int) – The requested DTU for the pool if available.
  • requested_elastic_pool_name (str) – The requested name for the elastic pool if available.
  • requested_storage_limit_in_gb (long) – The requested storage limit for the pool in GB if available.
  • elastic_pool_name (str) – The name of the elastic pool.
  • server_name (str) – The name of the server the elastic pool is in.
  • start_time (datetime) – The time the operation started (ISO8601 format).
  • state (str) – The current state of the operation.
  • requested_storage_limit_in_mb (int) – The requested storage limit in MB.
  • requested_database_dtu_guarantee (int) – The requested per database DTU guarantee.
  • requested_database_dtu_cap (int) – The requested per database DTU cap.
  • requested_dtu_guarantee (int) – The requested DTU guarantee.
Parameters:

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

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

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • database_name (str) – The database name.
  • end_time (datetime) – The time the operation finished (ISO8601 format).
  • error_code (int) – The error code if available.
  • error_message (str) – The error message if available.
  • error_severity (int) – The error severity if available.
  • operation (str) – The operation name.
  • operation_id (str) – The unique operation ID.
  • percent_complete (int) – The percentage complete if available.
  • requested_elastic_pool_name (str) – The name for the elastic pool the database is moving into if available.
  • current_elastic_pool_name (str) – The name of the current elastic pool the database is in if available.
  • current_service_objective (str) – The name of the current service objective if available.
  • requested_service_objective (str) – The name of the requested service objective if available.
  • server_name (str) – The name of the server the elastic pool is in.
  • start_time (datetime) – The time the operation started (ISO8601 format).
  • state (str) – The current state of the operation.
Parameters:

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

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

Bases: msrest.serialization.Model

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

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

Variables:
  • name (str) – The name of the impact dimension.
  • unit (str) – The unit in which estimated impact to dimension is measured.
  • change_value_absolute (float) – The absolute impact to dimension.
  • change_value_relative (float) – The relative impact to dimension (null if not applicable)
class azure.mgmt.sql.models.RecommendedIndex(**kwargs)[source]

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

Represents a database recommended index.

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

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

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

Represents a database transparent data encryption configuration.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • location (str) – Resource location.
Parameters:

status (str or TransparentDataEncryptionStatus) – The status of the database transparent data encryption. Possible values include: ‘Enabled’, ‘Disabled’

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

Bases: msrest.serialization.Model

A Slo Usage Metric.

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

Variables:
  • service_level_objective (str or ServiceObjectiveName) – The serviceLevelObjective for SLO usage metric. Possible values include: ‘System’, ‘System0’, ‘System1’, ‘System2’, ‘System3’, ‘System4’, ‘System2L’, ‘System3L’, ‘System4L’, ‘Free’, ‘Basic’, ‘S0’, ‘S1’, ‘S2’, ‘S3’, ‘S4’, ‘S6’, ‘S7’, ‘S9’, ‘S12’, ‘P1’, ‘P2’, ‘P3’, ‘P4’, ‘P6’, ‘P11’, ‘P15’, ‘PRS1’, ‘PRS2’, ‘PRS4’, ‘PRS6’, ‘DW100’, ‘DW200’, ‘DW300’, ‘DW400’, ‘DW500’, ‘DW600’, ‘DW1000’, ‘DW1200’, ‘DW1000c’, ‘DW1500’, ‘DW1500c’, ‘DW2000’, ‘DW2000c’, ‘DW3000’, ‘DW2500c’, ‘DW3000c’, ‘DW6000’, ‘DW5000c’, ‘DW6000c’, ‘DW7500c’, ‘DW10000c’, ‘DW15000c’, ‘DW30000c’, ‘DS100’, ‘DS200’, ‘DS300’, ‘DS400’, ‘DS500’, ‘DS600’, ‘DS1000’, ‘DS1200’, ‘DS1500’, ‘DS2000’, ‘ElasticPool’
  • service_level_objective_id (str) – The serviceLevelObjectiveId for SLO usage metric.
  • in_range_time_ratio (float) – Gets or sets inRangeTimeRatio for SLO usage metric.
class azure.mgmt.sql.models.ServiceTierAdvisor(**kwargs)[source]

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

Represents a Service Tier Advisor.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • observation_period_start (datetime) – The observation period start (ISO8601 format).
  • observation_period_end (datetime) – The observation period start (ISO8601 format).
  • active_time_ratio (float) – The activeTimeRatio for service tier advisor.
  • min_dtu (float) – Gets or sets minDtu for service tier advisor.
  • avg_dtu (float) – Gets or sets avgDtu for service tier advisor.
  • max_dtu (float) – Gets or sets maxDtu for service tier advisor.
  • max_size_in_gb (float) – Gets or sets maxSizeInGB for service tier advisor.
  • service_level_objective_usage_metrics (list[SloUsageMetric]) – Gets or sets serviceLevelObjectiveUsageMetrics for the service tier advisor.
  • current_service_level_objective (str) – Gets or sets currentServiceLevelObjective for service tier advisor.
  • current_service_level_objective_id (str) – Gets or sets currentServiceLevelObjectiveId for service tier advisor.
  • usage_based_recommendation_service_level_objective (str) – Gets or sets usageBasedRecommendationServiceLevelObjective for service tier advisor.
  • usage_based_recommendation_service_level_objective_id (str) – Gets or sets usageBasedRecommendationServiceLevelObjectiveId for service tier advisor.
  • database_size_based_recommendation_service_level_objective (str) – Gets or sets databaseSizeBasedRecommendationServiceLevelObjective for service tier advisor.
  • database_size_based_recommendation_service_level_objective_id (str) – Gets or sets databaseSizeBasedRecommendationServiceLevelObjectiveId for service tier advisor.
  • disaster_plan_based_recommendation_service_level_objective (str) – Gets or sets disasterPlanBasedRecommendationServiceLevelObjective for service tier advisor.
  • disaster_plan_based_recommendation_service_level_objective_id (str) – Gets or sets disasterPlanBasedRecommendationServiceLevelObjectiveId for service tier advisor.
  • overall_recommendation_service_level_objective (str) – Gets or sets overallRecommendationServiceLevelObjective for service tier advisor.
  • overall_recommendation_service_level_objective_id (str) – Gets or sets overallRecommendationServiceLevelObjectiveId for service tier advisor.
  • confidence (float) – Gets or sets confidence for service tier advisor.
class azure.mgmt.sql.models.TransparentDataEncryptionActivity(**kwargs)[source]

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

Represents a database transparent data encryption Scan.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • location (str) – Resource location.
  • status (str or TransparentDataEncryptionActivityStatus) – The status of the database. Possible values include: ‘Encrypting’, ‘Decrypting’
  • percent_complete (float) – The percent complete of the transparent data encryption scan for a database.
class azure.mgmt.sql.models.ServerUsage(**kwargs)[source]

Bases: msrest.serialization.Model

Represents server metrics.

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

Variables:
  • name (str) – Name of the server usage metric.
  • resource_name (str) – The name of the resource.
  • display_name (str) – The metric display name.
  • current_value (float) – The current value of the metric.
  • limit (float) – The current limit of the metric.
  • unit (str) – The units of the metric.
  • next_reset_time (datetime) – The next reset time for the metric (ISO8601 format).
class azure.mgmt.sql.models.DatabaseUsage(**kwargs)[source]

Bases: msrest.serialization.Model

The database usages.

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

Variables:
  • name (str) – The name of the usage metric.
  • resource_name (str) – The name of the resource.
  • display_name (str) – The usage metric display name.
  • current_value (float) – The current value of the usage metric.
  • limit (float) – The current limit of the usage metric.
  • unit (str) – The units of the usage metric.
  • next_reset_time (datetime) – The next reset time for the usage metric (ISO8601 format).
class azure.mgmt.sql.models.DatabaseBlobAuditingPolicy(*, state, storage_endpoint: str = None, storage_account_access_key: str = None, retention_days: int = None, audit_actions_and_groups=None, storage_account_subscription_id: str = None, is_storage_secondary_key_in_use: bool = None, **kwargs)[source]

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

A database blob auditing 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) – Resource kind.
Parameters:
  • state (str or BlobAuditingPolicyState) – Required. Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey 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 is required.
  • storage_account_access_key (str) – Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.
  • retention_days (int) – Specifies the number of days to keep in the audit logs.
  • audit_actions_and_groups (list[str]) – Specifies the Actions and Actions-Groups to audit.
  • storage_account_subscription_id (str) – Specifies the blob storage subscription Id.
  • is_storage_secondary_key_in_use (bool) – Specifies whether storageAccountAccessKey value is the storage’s secondary key.
class azure.mgmt.sql.models.AutomaticTuningOptions(*, desired_state=None, **kwargs)[source]

Bases: msrest.serialization.Model

Automatic tuning properties for individual advisors.

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

Parameters:

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

Variables:
  • actual_state (str or AutomaticTuningOptionModeActual) – Automatic tuning option actual state. Possible values include: ‘Off’, ‘On’
  • reason_code (int) – Reason code if desired and actual state are different.
  • reason_desc (str or AutomaticTuningDisabledReason) – Reason description if desired and actual state are different. Possible values include: ‘Default’, ‘Disabled’, ‘AutoConfigured’, ‘InheritedFromServer’, ‘QueryStoreOff’, ‘QueryStoreReadOnly’, ‘NotSupported’
class azure.mgmt.sql.models.DatabaseAutomaticTuning(*, desired_state=None, options=None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • actual_state (str or AutomaticTuningMode) – Automatic tuning actual state. Possible values include: ‘Inherit’, ‘Custom’, ‘Auto’, ‘Unspecified’
Parameters:
  • desired_state (str or AutomaticTuningMode) – Automatic tuning desired state. Possible values include: ‘Inherit’, ‘Custom’, ‘Auto’, ‘Unspecified’
  • options (dict[str, AutomaticTuningOptions]) – Automatic tuning options definition.
class azure.mgmt.sql.models.EncryptionProtector(*, server_key_type, kind: str = None, server_key_name: str = None, **kwargs)[source]

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

The server encryption protector.

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) – Resource location.
  • subregion (str) – Subregion of the encryption protector.
  • uri (str) – The URI of the server key.
  • thumbprint (str) – Thumbprint of the server key.
Parameters:
  • kind (str) – Kind of encryption protector. This is metadata used for the Azure portal experience.
  • server_key_name (str) – The name of the server key.
  • server_key_type (str or ServerKeyType) – Required. The encryption protector type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: ‘ServiceManaged’, ‘AzureKeyVault’
class azure.mgmt.sql.models.FailoverGroupReadWriteEndpoint(*, failover_policy, failover_with_data_loss_grace_period_minutes: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Read-write endpoint of the failover group instance.

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

Parameters:
  • failover_policy (str or ReadWriteEndpointFailoverPolicy) – Required. Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. Possible values include: ‘Manual’, ‘Automatic’
  • failover_with_data_loss_grace_period_minutes (int) – Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
class azure.mgmt.sql.models.FailoverGroupReadOnlyEndpoint(*, failover_policy=None, **kwargs)[source]

Bases: msrest.serialization.Model

Read-only endpoint of the failover group instance.

Parameters:failover_policy (str or ReadOnlyEndpointFailoverPolicy) – Failover policy of the read-only endpoint for the failover group. Possible values include: ‘Disabled’, ‘Enabled’
class azure.mgmt.sql.models.PartnerInfo(*, id: str, **kwargs)[source]

Bases: msrest.serialization.Model

Partner server information for the failover group.

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

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

Parameters:

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

Variables:
  • location (str) – Geo location of the partner server.
  • replication_role (str or FailoverGroupReplicationRole) – Replication role of the partner server. Possible values include: ‘Primary’, ‘Secondary’
class azure.mgmt.sql.models.FailoverGroup(*, read_write_endpoint, partner_servers, tags=None, read_only_endpoint=None, databases=None, **kwargs)[source]

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

A 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) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • location (str) – Resource location.
  • replication_role (str or FailoverGroupReplicationRole) – Local replication role of the failover group instance. Possible values include: ‘Primary’, ‘Secondary’
  • replication_state (str) – Replication state of the failover group instance.
Parameters:
  • tags (dict[str, str]) – Resource tags.
  • read_write_endpoint (FailoverGroupReadWriteEndpoint) – Required. Read-write endpoint of the failover group instance.
  • read_only_endpoint (FailoverGroupReadOnlyEndpoint) – Read-only endpoint of the failover group instance.
  • partner_servers (list[PartnerInfo]) – Required. List of partner server information for the failover group.
  • databases (list[str]) – List of databases in the failover group.
class azure.mgmt.sql.models.FailoverGroupUpdate(*, read_write_endpoint=None, read_only_endpoint=None, databases=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

A failover group update request.

Parameters:
  • 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.
  • tags (dict[str, str]) – Resource tags.
class azure.mgmt.sql.models.ResourceIdentity(*, type=None, **kwargs)[source]

Bases: msrest.serialization.Model

Azure Active Directory identity configuration for a resource.

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

Variables:
  • principal_id (str) – The Azure Active Directory principal id.
  • tenant_id (str) – The Azure Active Directory tenant id.
Parameters:

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

class azure.mgmt.sql.models.Sku(*, name: str, tier: str = None, size: str = None, family: str = None, capacity: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

The resource model definition representing SKU.

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

Parameters:
  • name (str) – Required. The name of the SKU. Ex - P3. It is typically a letter+number code
  • tier (str) – This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
  • size (str) – The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
  • family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.
  • capacity (int) – If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
class azure.mgmt.sql.models.ManagedInstance(*, location: str, tags=None, identity=None, sku=None, administrator_login: str = None, administrator_login_password: str = None, subnet_id: str = None, license_type: str = None, v_cores: int = None, storage_size_in_gb: int = None, **kwargs)[source]

Bases: azure.mgmt.sql.models.tracked_resource_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.
  • fully_qualified_domain_name (str) – The fully qualified domain name of the managed instance.
  • state (str) – The state of the managed instance.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
  • identity (ResourceIdentity) – The Azure Active Directory identity of the managed instance.
  • sku (Sku) – Managed instance sku
  • 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) – The license type. Possible values are ‘LicenseIncluded’ and ‘BasePrice’.
  • v_cores (int) – The number of VCores.
  • storage_size_in_gb (int) – The maximum storage size in GB.
class azure.mgmt.sql.models.ManagedInstanceUpdate(*, sku=None, administrator_login: str = None, administrator_login_password: str = None, subnet_id: str = None, license_type: str = None, v_cores: int = None, storage_size_in_gb: int = None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

An update request for an Azure SQL Database managed instance.

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

Parameters:
  • sku (Sku) – Managed instance sku
  • 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) – The license type. Possible values are ‘LicenseIncluded’ and ‘BasePrice’.
  • v_cores (int) – The number of VCores.
  • storage_size_in_gb (int) – The maximum storage size in GB.
  • tags (dict[str, str]) – Resource tags.
Variables:
  • fully_qualified_domain_name (str) – The fully qualified domain name of the managed instance.
  • state (str) – The state of the managed instance.
class azure.mgmt.sql.models.OperationDisplay(**kwargs)[source]

Bases: msrest.serialization.Model

Display metadata associated with the operation.

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

Variables:
  • provider (str) – The localized friendly form of the resource provider name.
  • resource (str) – The localized friendly form of the resource type related to this action/operation.
  • operation (str) – The localized friendly name for the operation.
  • description (str) – The localized friendly description for the operation.
class azure.mgmt.sql.models.Operation(**kwargs)[source]

Bases: msrest.serialization.Model

SQL REST API operation definition.

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

Variables:
  • name (str) – The name of the operation being performed on this particular object.
  • display (OperationDisplay) – The localized display information for this particular operation / action.
  • origin (str or OperationOrigin) – The intended executor of the operation. Possible values include: ‘user’, ‘system’
  • properties (dict[str, object]) – Additional descriptions for the operation.
class azure.mgmt.sql.models.ServerKey(*, server_key_type, kind: str = None, uri: str = None, thumbprint: str = None, creation_date=None, **kwargs)[source]

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

A server key.

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) – Resource location.
  • subregion (str) – Subregion of the server key.
Parameters:
  • kind (str) – Kind of encryption protector. This is metadata used for the Azure portal experience.
  • server_key_type (str or ServerKeyType) – Required. The server key type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: ‘ServiceManaged’, ‘AzureKeyVault’
  • uri (str) – The URI of the server key.
  • thumbprint (str) – Thumbprint of the server key.
  • creation_date (datetime) – The server key creation date.
class azure.mgmt.sql.models.Server(*, location: str, tags=None, identity=None, administrator_login: str = None, administrator_login_password: str = None, version: str = None, **kwargs)[source]

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

An Azure SQL Database server.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • kind (str) – Kind of sql server. This is metadata used for the Azure portal experience.
  • state (str) – The state of the server.
  • fully_qualified_domain_name (str) – The fully qualified domain name of the server.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – 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.
class azure.mgmt.sql.models.ServerUpdate(*, administrator_login: str = None, administrator_login_password: str = None, version: str = None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

An update request for an Azure SQL Database server.

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

Parameters:
  • 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.
  • tags (dict[str, str]) – Resource tags.
Variables:
  • state (str) – The state of the server.
  • fully_qualified_domain_name (str) – The fully qualified domain name of the server.
class azure.mgmt.sql.models.SyncAgent(*, sync_database_id: str = None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • sync_agent_name (str) – Name of the sync agent.
  • last_alive_time (datetime) – Last alive time of the sync agent.
  • state (str or SyncAgentState) – State of the sync agent. Possible values include: ‘Online’, ‘Offline’, ‘NeverConnected’
  • is_up_to_date (bool) – If the sync agent version is up to date.
  • expiry_time (datetime) – Expiration time of the sync agent version.
  • version (str) – Version of the sync agent.
Parameters:

sync_database_id (str) – ARM resource id of the sync database in the sync agent.

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

Bases: msrest.serialization.Model

Properties of an Azure SQL Database sync agent key.

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

Variables:sync_agent_key (str) – Key of sync agent.
class azure.mgmt.sql.models.SyncAgentLinkedDatabase(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.SyncDatabaseIdProperties(**kwargs)[source]

Bases: msrest.serialization.Model

Properties of the sync database id.

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

Variables:id (str) – ARM resource id of sync database.
class azure.mgmt.sql.models.SyncFullSchemaTableColumn(**kwargs)[source]

Bases: msrest.serialization.Model

Properties of the column in the table of database full schema.

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

Variables:
  • data_size (str) – Data size of the column.
  • data_type (str) – Data type of the column.
  • error_id (str) – Error id of the column.
  • has_error (bool) – If there is error in the table.
  • is_primary_key (bool) – If it is the primary key of the table.
  • name (str) – Name of the column.
  • quoted_name (str) – Quoted name of the column.
class azure.mgmt.sql.models.SyncFullSchemaTable(**kwargs)[source]

Bases: msrest.serialization.Model

Properties of the table in the database full schema.

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

Variables:
  • columns (list[SyncFullSchemaTableColumn]) – List of columns in the table of database full schema.
  • error_id (str) – Error id of the table.
  • has_error (bool) – If there is error in the table.
  • name (str) – Name of the table.
  • quoted_name (str) – Quoted name of the table.
class azure.mgmt.sql.models.SyncFullSchemaProperties(**kwargs)[source]

Bases: msrest.serialization.Model

Properties of the database full schema.

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

Variables:
  • tables (list[SyncFullSchemaTable]) – List of tables in the database full schema.
  • last_update_time (datetime) – Last update time of the database schema.
class azure.mgmt.sql.models.SyncGroupLogProperties(**kwargs)[source]

Bases: msrest.serialization.Model

Properties of an Azure SQL Database sync group log.

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

Variables:
  • timestamp (datetime) – Timestamp of the sync group log.
  • type (str or SyncGroupLogType) – Type of the sync group log. Possible values include: ‘All’, ‘Error’, ‘Warning’, ‘Success’
  • source (str) – Source of the sync group log.
  • details (str) – Details of the sync group log.
  • tracing_id (str) – TracingId of the sync group log.
  • operation_status (str) – OperationStatus of the sync group log.
class azure.mgmt.sql.models.SyncGroupSchemaTableColumn(*, quoted_name: str = None, data_size: str = None, data_type: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of column in sync group table.

Parameters:
  • quoted_name (str) – Quoted name of sync group table column.
  • data_size (str) – Data size of the column.
  • data_type (str) – Data type of the column.
class azure.mgmt.sql.models.SyncGroupSchemaTable(*, columns=None, quoted_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of table in sync group schema.

Parameters:
  • columns (list[SyncGroupSchemaTableColumn]) – List of columns in sync group schema.
  • quoted_name (str) – Quoted name of sync group schema table.
class azure.mgmt.sql.models.SyncGroupSchema(*, tables=None, master_sync_member_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of sync group schema.

Parameters:
  • tables (list[SyncGroupSchemaTable]) – List of tables in sync group schema.
  • master_sync_member_name (str) – Name of master sync member where the schema is from.
class azure.mgmt.sql.models.SyncGroup(*, interval: int = None, conflict_resolution_policy=None, sync_database_id: str = None, hub_database_user_name: str = None, hub_database_password: str = None, schema=None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • last_sync_time (datetime) – Last sync time of the sync group.
  • sync_state (str or SyncGroupState) – Sync state of the sync group. Possible values include: ‘NotReady’, ‘Error’, ‘Warning’, ‘Progressing’, ‘Good’
Parameters:
  • interval (int) – Sync interval of the sync group.
  • conflict_resolution_policy (str or SyncConflictResolutionPolicy) – Conflict resolution policy of the sync group. Possible values include: ‘HubWin’, ‘MemberWin’
  • sync_database_id (str) – ARM resource id of the sync database in the sync group.
  • hub_database_user_name (str) – User name for the sync group hub database credential.
  • hub_database_password (str) – Password for the sync group hub database credential.
  • schema (SyncGroupSchema) – Sync schema of the sync group.
class azure.mgmt.sql.models.SyncMember(*, database_type=None, sync_agent_id: str = None, sql_server_database_id: str = None, server_name: str = None, database_name: str = None, user_name: str = None, password: str = None, sync_direction=None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • sync_state (str or SyncMemberState) – Sync state of the sync member. Possible values include: ‘SyncInProgress’, ‘SyncSucceeded’, ‘SyncFailed’, ‘DisabledTombstoneCleanup’, ‘DisabledBackupRestore’, ‘SyncSucceededWithWarnings’, ‘SyncCancelling’, ‘SyncCancelled’, ‘UnProvisioned’, ‘Provisioning’, ‘Provisioned’, ‘ProvisionFailed’, ‘DeProvisioning’, ‘DeProvisioned’, ‘DeProvisionFailed’, ‘Reprovisioning’, ‘ReprovisionFailed’, ‘UnReprovisioned’
Parameters:
  • database_type (str or SyncMemberDbType) – Database type of the sync member. Possible values include: ‘AzureSqlDatabase’, ‘SqlServerDatabase’
  • sync_agent_id (str) – ARM resource id of the sync agent in the sync member.
  • sql_server_database_id (str) – SQL Server database id of the sync member.
  • 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.SubscriptionUsage(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.VirtualNetworkRule(*, virtual_network_subnet_id: str, ignore_missing_vnet_service_endpoint: bool = None, **kwargs)[source]

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

A virtual network rule.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • state (str or VirtualNetworkRuleState) – Virtual Network Rule State. Possible values include: ‘Initializing’, ‘InProgress’, ‘Ready’, ‘Deleting’, ‘Unknown’
Parameters:
  • virtual_network_subnet_id (str) – Required. 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.DatabaseVulnerabilityAssessmentRuleBaselineItem(*, result, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:result (list[str]) – Required. The rule baseline result
class azure.mgmt.sql.models.DatabaseVulnerabilityAssessmentRuleBaseline(*, baseline_results, **kwargs)[source]

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

A database vulnerability assessment rule baseline.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
Parameters:

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

class azure.mgmt.sql.models.VulnerabilityAssessmentRecurringScansProperties(*, is_enabled: bool = None, email_subscription_admins: bool = True, emails=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of a Vulnerability Assessment recurring scans.

Parameters:
  • is_enabled (bool) – Recurring scans state.
  • email_subscription_admins (bool) – Specifies that the schedule scan notification will be is sent to the subscription administrators. Default value: True .
  • emails (list[str]) – Specifies an array of e-mail addresses to which the scan notification is sent.
class azure.mgmt.sql.models.DatabaseVulnerabilityAssessment(*, storage_container_path: str, storage_container_sas_key: str, recurring_scans=None, **kwargs)[source]

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

A database vulnerability assessment.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
Parameters:
class azure.mgmt.sql.models.JobAgent(*, location: str, database_id: str, tags=None, sku=None, **kwargs)[source]

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

An Azure SQL job agent.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • state (str or JobAgentState) – The state of the job agent. Possible values include: ‘Creating’, ‘Ready’, ‘Updating’, ‘Deleting’, ‘Disabled’
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
  • sku (Sku) – The name and tier of the SKU.
  • database_id (str) – Required. Resource ID of the database to store job metadata in.
class azure.mgmt.sql.models.JobAgentUpdate(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

An update to an Azure SQL job agent.

Parameters:tags (dict[str, str]) – Resource tags.
class azure.mgmt.sql.models.JobCredential(*, username: str, password: str, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
Parameters:
  • username (str) – Required. The credential user name.
  • password (str) – Required. The credential password.
class azure.mgmt.sql.models.JobExecutionTarget(**kwargs)[source]

Bases: msrest.serialization.Model

The target that a job execution is executed on.

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

Variables:
  • type (str or JobTargetType) – The type of the target. Possible values include: ‘TargetGroup’, ‘SqlDatabase’, ‘SqlElasticPool’, ‘SqlShardMap’, ‘SqlServer’
  • server_name (str) – The server name.
  • database_name (str) – The database name.
class azure.mgmt.sql.models.JobExecution(*, current_attempts: int = None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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_attempt_start_time (datetime) – Start time of the current attempt.
  • last_message (str) – The last status or error message.
  • target (JobExecutionTarget) – The target that this execution is executed on.
Parameters:

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

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

Bases: msrest.serialization.Model

Scheduling properties of a job.

Parameters:
  • start_time (datetime) – Schedule start time. Default value: “0001-01-01T00:00:00Z” .
  • end_time (datetime) – Schedule end time. Default value: “9999-12-31T11:59:59Z” .
  • 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.Job(*, description: str = '', schedule=None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • version (int) – The job version number.
Parameters:
  • description (str) – User-defined description of the job. Default value: “” .
  • schedule (JobSchedule) – Schedule properties of the job.
class azure.mgmt.sql.models.JobStepAction(*, value: str, type='TSql', source='Inline', **kwargs)[source]

Bases: msrest.serialization.Model

The action to be executed by a job step.

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

Parameters:
  • type (str or JobStepActionType) – Type of action being executed by the job step. Possible values include: ‘TSql’. Default value: “TSql” .
  • source (str or JobStepActionSource) – The source of the action to execute. Possible values include: ‘Inline’. Default value: “Inline” .
  • value (str) – Required. The action value, for example the text of the T-SQL script to execute.
class azure.mgmt.sql.models.JobStepOutput(*, server_name: str, database_name: str, table_name: str, credential: str, type='SqlDatabase', subscription_id: str = None, resource_group_name: str = None, schema_name: str = 'dbo', **kwargs)[source]

Bases: msrest.serialization.Model

The output configuration of a job step.

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

Parameters:
  • type (str or JobStepOutputType) – The output destination type. Possible values include: ‘SqlDatabase’. Default value: “SqlDatabase” .
  • subscription_id (str) – The output destination subscription id.
  • resource_group_name (str) – The output destination resource group.
  • server_name (str) – Required. The output destination server name.
  • database_name (str) – Required. The output destination database.
  • schema_name (str) – The output destination schema. Default value: “dbo” .
  • 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.JobStepExecutionOptions(*, timeout_seconds: int = 43200, retry_attempts: int = 10, initial_retry_interval_seconds: int = 1, maximum_retry_interval_seconds: int = 120, retry_interval_backoff_multiplier: float = 2, **kwargs)[source]

Bases: msrest.serialization.Model

The execution options of a job step.

Parameters:
  • timeout_seconds (int) – Execution timeout for the job step. Default value: 43200 .
  • retry_attempts (int) – Maximum number of times the job step will be reattempted if the first attempt fails. Default value: 10 .
  • initial_retry_interval_seconds (int) – Initial delay between retries for job step execution. Default value: 1 .
  • maximum_retry_interval_seconds (int) – The maximum amount of time to wait between retries for job step execution. Default value: 120 .
  • retry_interval_backoff_multiplier (float) – The backoff multiplier for the time between retries. Default value: 2 .
class azure.mgmt.sql.models.JobStep(*, target_group: str, credential: str, action, step_id: int = None, output=None, execution_options=None, **kwargs)[source]

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

A job step.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
Parameters:
  • 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) – Required. The resource ID of the target group that the job step will be executed on.
  • credential (str) – Required. The resource ID of the job credential that will be used to connect to the targets.
  • action (JobStepAction) – Required. 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.JobTarget(*, type, membership_type='Include', server_name: str = None, database_name: str = None, elastic_pool_name: str = None, shard_map_name: str = None, refresh_credential: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

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

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

A group of job targets.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
Parameters:

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

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

Bases: azure.mgmt.sql.models.proxy_resource_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.LongTermRetentionBackup(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
class azure.mgmt.sql.models.BackupLongTermRetentionPolicy(*, weekly_retention: str = None, monthly_retention: str = None, yearly_retention: str = None, week_of_year: int = None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
Parameters:
  • weekly_retention (str) – The weekly retention policy for an LTR backup in an ISO 8601 format.
  • monthly_retention (str) – The montly 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.CompleteDatabaseRestoreDefinition(*, last_backup_name: str, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:last_backup_name (str) – Required. The last backup name to apply
class azure.mgmt.sql.models.ManagedDatabase(*, location: str, tags=None, collation: str = None, restore_point_in_time=None, catalog_collation=None, create_mode=None, storage_container_uri: str = None, source_database_id: str = None, storage_container_sas_token: str = None, **kwargs)[source]

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

A managed database resource.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • status (str or ManagedDatabaseStatus) – Status for the database. Possible values include: ‘Online’, ‘Offline’, ‘Shutdown’, ‘Creating’, ‘Inaccessible’
  • creation_date (datetime) – Creation date of the database.
  • earliest_restore_point (datetime) – Earliest restore point in time for point in time restore.
  • default_secondary_location (str) – Geo paired region.
  • failover_group_id (str) – Instance Failover Group resource identifier that this managed database belongs to.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – 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. Possible values include: ‘Default’, ‘RestoreExternalBackup’, ‘PointInTimeRestore’
  • 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.
  • storage_container_sas_token (str) – Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.
class azure.mgmt.sql.models.ManagedDatabaseUpdate(*, collation: str = None, restore_point_in_time=None, catalog_collation=None, create_mode=None, storage_container_uri: str = None, source_database_id: str = None, storage_container_sas_token: str = None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

An managed database update.

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

Parameters:
  • 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. Possible values include: ‘Default’, ‘RestoreExternalBackup’, ‘PointInTimeRestore’
  • 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.
  • storage_container_sas_token (str) – Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.
  • tags (dict[str, str]) – Resource tags.
Variables:
  • status (str or ManagedDatabaseStatus) – Status for the database. Possible values include: ‘Online’, ‘Offline’, ‘Shutdown’, ‘Creating’, ‘Inaccessible’
  • creation_date (datetime) – Creation date of the database.
  • earliest_restore_point (datetime) – Earliest restore point in time for point in time restore.
  • default_secondary_location (str) – Geo paired region.
  • failover_group_id (str) – Instance Failover Group resource identifier that this managed database belongs to.
class azure.mgmt.sql.models.AutomaticTuningServerOptions(*, desired_state=None, **kwargs)[source]

Bases: msrest.serialization.Model

Automatic tuning properties for individual advisors.

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

Parameters:

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

Variables:
  • actual_state (str or AutomaticTuningOptionModeActual) – Automatic tuning option actual state. Possible values include: ‘Off’, ‘On’
  • reason_code (int) – Reason code if desired and actual state are different.
  • reason_desc (str or AutomaticTuningServerReason) – Reason description if desired and actual state are different. Possible values include: ‘Default’, ‘Disabled’, ‘AutoConfigured’
class azure.mgmt.sql.models.ServerAutomaticTuning(*, desired_state=None, options=None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
  • actual_state (str or AutomaticTuningServerMode) – Automatic tuning actual state. Possible values include: ‘Custom’, ‘Auto’, ‘Unspecified’
Parameters:
class azure.mgmt.sql.models.ServerDnsAlias(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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 = None, **kwargs)[source]

Bases: msrest.serialization.Model

A server DNS alias acquisition request.

Parameters:old_server_dns_alias_id (str) – The id of the server alias that will be acquired to point to this server instead.
class azure.mgmt.sql.models.RestorePoint(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.CreateDatabaseRestorePointDefinition(*, restore_point_label: str, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:restore_point_label (str) – Required. The restore point label to apply
class azure.mgmt.sql.models.DatabaseOperation(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.ElasticPoolOperation(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.MaxSizeCapability(**kwargs)[source]

Bases: msrest.serialization.Model

The maximum size capability.

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

Variables:
  • limit (int) – The maximum size limit (see ‘unit’ for the units).
  • unit (str or MaxSizeUnit) – The units that the limit is expressed in. Possible values include: ‘Megabytes’, ‘Gigabytes’, ‘Terabytes’, ‘Petabytes’
class azure.mgmt.sql.models.LogSizeCapability(**kwargs)[source]

Bases: msrest.serialization.Model

The log size capability.

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

Variables:
  • limit (int) – The log size limit (see ‘unit’ for the units).
  • unit (str or LogSizeUnit) – The units that the limit is expressed in. Possible values include: ‘Megabytes’, ‘Gigabytes’, ‘Terabytes’, ‘Petabytes’, ‘Percent’
class azure.mgmt.sql.models.MaxSizeRangeCapability(*, reason: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The maximum size range capability.

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

Variables:
Parameters:

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

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

Bases: msrest.serialization.Model

The performance level capability.

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

Variables:
  • value (float) – Performance level value.
  • unit (str or PerformanceLevelUnit) – Unit type used to measure performance level. Possible values include: ‘DTU’, ‘VCores’
class azure.mgmt.sql.models.LicenseTypeCapability(*, reason: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The license type capability.

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

Variables:
  • name (str) – License type identifier.
  • status (str or CapabilityStatus) – The status of the capability. Possible values include: ‘Visible’, ‘Available’, ‘Default’, ‘Disabled’
Parameters:

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

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

Bases: msrest.serialization.Model

The service objectives capability.

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

Variables:
  • id (str) – The unique ID of the service objective.
  • name (str) – The service objective name.
  • supported_max_sizes (list[MaxSizeRangeCapability]) – The list of supported maximum database sizes.
  • performance_level (PerformanceLevelCapability) – The performance level.
  • sku (Sku) – The sku.
  • supported_license_types (list[LicenseTypeCapability]) – List of supported license types.
  • included_max_size (MaxSizeCapability) – The included (free) max size.
  • status (str or CapabilityStatus) – The status of the capability. Possible values include: ‘Visible’, ‘Available’, ‘Default’, ‘Disabled’
Parameters:

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

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

Bases: msrest.serialization.Model

The edition capability.

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

Variables:
  • name (str) – The database edition name.
  • supported_service_level_objectives (list[ServiceObjectiveCapability]) – The list of supported service objectives for the edition.
  • zone_redundant (bool) – Whether or not zone redundancy is supported for the edition.
  • status (str or CapabilityStatus) – The status of the capability. Possible values include: ‘Visible’, ‘Available’, ‘Default’, ‘Disabled’
Parameters:

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

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

Bases: msrest.serialization.Model

The minimum per-database performance level capability.

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

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

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

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

Bases: msrest.serialization.Model

The max per-database performance level capability.

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

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

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

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

Bases: msrest.serialization.Model

The Elastic Pool performance level capability.

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

Variables:
Parameters:

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

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

Bases: msrest.serialization.Model

The elastic pool edition capability.

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

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

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

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

Bases: msrest.serialization.Model

The server capability.

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

Variables:
Parameters:

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

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

Bases: msrest.serialization.Model

The managed instance virtual cores capability.

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

Variables:
  • name (str) – The virtual cores identifier.
  • value (int) – The virtual cores value.
  • status (str or CapabilityStatus) – The status of the capability. Possible values include: ‘Visible’, ‘Available’, ‘Default’, ‘Disabled’
Parameters:

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

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

Bases: msrest.serialization.Model

The managed server family capability.

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

Variables:
Parameters:

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

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

Bases: msrest.serialization.Model

The managed server capability.

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

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

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

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

Bases: msrest.serialization.Model

The managed instance capability.

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

Variables:
Parameters:

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

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

Bases: msrest.serialization.Model

The location capability.

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

Variables:
Parameters:

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

class azure.mgmt.sql.models.Database(*, location: str, tags=None, sku=None, create_mode=None, collation: str = None, max_size_bytes: int = None, sample_name=None, elastic_pool_id: str = None, source_database_id: str = None, restore_point_in_time=None, source_database_deletion_date=None, recovery_services_recovery_point_id: str = None, long_term_retention_backup_resource_id: str = None, recoverable_database_id: str = None, restorable_dropped_database_id: str = None, catalog_collation=None, zone_redundant: bool = None, license_type=None, read_scale=None, **kwargs)[source]

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

A database resource.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • kind (str) – Kind of database. This is metadata used for the Azure portal experience.
  • managed_by (str) – Resource that manages the database.
  • status (str or DatabaseStatus) – The status of the database. Possible values include: ‘Online’, ‘Restoring’, ‘RecoveryPending’, ‘Recovering’, ‘Suspect’, ‘Offline’, ‘Standby’, ‘Shutdown’, ‘EmergencyMode’, ‘AutoClosed’, ‘Copying’, ‘Creating’, ‘Inaccessible’, ‘OfflineSecondary’, ‘Pausing’, ‘Paused’, ‘Resuming’, ‘Scaling’
  • database_id (str) – The ID of the database.
  • creation_date (datetime) – The creation date of the database (ISO8601 format).
  • current_service_objective_name (str) – The current service level objective name of the database.
  • requested_service_objective_name (str) – The requested service level objective name of the database.
  • default_secondary_location (str) – The default secondary region for this database.
  • failover_group_id (str) – Failover Group resource identifier that this database belongs to.
  • max_log_size_bytes (long) – The max log size for this database.
  • earliest_restore_date (datetime) – This records the earliest start date and time that restore is available for this database (ISO8601 format).
  • current_sku (Sku) – The name and tier of the SKU.
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
  • sku (Sku) – The name and tier of the SKU.
  • 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. 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’
class azure.mgmt.sql.models.DatabaseUpdate(*, sku=None, create_mode=None, collation: str = None, max_size_bytes: int = None, sample_name=None, elastic_pool_id: str = None, source_database_id: str = None, restore_point_in_time=None, source_database_deletion_date=None, recovery_services_recovery_point_id: str = None, long_term_retention_backup_resource_id: str = None, recoverable_database_id: str = None, restorable_dropped_database_id: str = None, catalog_collation=None, zone_redundant: bool = None, license_type=None, read_scale=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

A database resource.

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

Parameters:
  • sku (Sku) – The name and tier of the SKU.
  • 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. 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’
  • tags (dict[str, str]) – Resource tags.
Variables:
  • status (str or DatabaseStatus) – The status of the database. Possible values include: ‘Online’, ‘Restoring’, ‘RecoveryPending’, ‘Recovering’, ‘Suspect’, ‘Offline’, ‘Standby’, ‘Shutdown’, ‘EmergencyMode’, ‘AutoClosed’, ‘Copying’, ‘Creating’, ‘Inaccessible’, ‘OfflineSecondary’, ‘Pausing’, ‘Paused’, ‘Resuming’, ‘Scaling’
  • database_id (str) – The ID of the database.
  • creation_date (datetime) – The creation date of the database (ISO8601 format).
  • current_service_objective_name (str) – The current service level objective name of the database.
  • requested_service_objective_name (str) – The requested service level objective name of the database.
  • default_secondary_location (str) – The default secondary region for this database.
  • failover_group_id (str) – Failover Group resource identifier that this database belongs to.
  • max_log_size_bytes (long) – The max log size for this database.
  • earliest_restore_date (datetime) – This records the earliest start date and time that restore is available for this database (ISO8601 format).
  • current_sku (Sku) – The name and tier of the SKU.
class azure.mgmt.sql.models.ResourceMoveDefinition(*, id: str, **kwargs)[source]

Bases: msrest.serialization.Model

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

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

Parameters:id (str) – Required. The target ID for the resource
class azure.mgmt.sql.models.ElasticPoolPerDatabaseSettings(*, min_capacity: float = None, max_capacity: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

Per database settings of an elastic pool.

Parameters:
  • min_capacity (float) – The minimum capacity all databases are guaranteed.
  • max_capacity (float) – The maximum capacity any one database can consume.
class azure.mgmt.sql.models.ElasticPool(*, location: str, tags=None, sku=None, max_size_bytes: int = None, per_database_settings=None, zone_redundant: bool = None, license_type=None, **kwargs)[source]

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

An elastic pool.

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

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

Variables:
  • id (str) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • kind (str) – Kind of elastic pool. This is metadata used for the Azure portal experience.
  • state (str or ElasticPoolState) – The state of the elastic pool. Possible values include: ‘Creating’, ‘Ready’, ‘Disabled’
  • creation_date (datetime) – The creation date of the elastic pool (ISO8601 format).
Parameters:
  • location (str) – Required. Resource location.
  • tags (dict[str, str]) – Resource tags.
  • sku (Sku) –
  • max_size_bytes (long) – The storage limit for the database elastic pool in bytes.
  • per_database_settings (ElasticPoolPerDatabaseSettings) – The per database settings for the elastic pool.
  • zone_redundant (bool) – Whether or not this elastic pool is zone redundant, which means the replicas of this elastic pool will be spread across multiple availability zones.
  • license_type (str or ElasticPoolLicenseType) – The license type to apply for this elastic pool. Possible values include: ‘LicenseIncluded’, ‘BasePrice’
class azure.mgmt.sql.models.ElasticPoolUpdate(*, sku=None, max_size_bytes: int = None, per_database_settings=None, zone_redundant: bool = None, license_type=None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

An elastic pool update.

Parameters:
  • sku (Sku) –
  • 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’
  • tags (dict[str, str]) – Resource tags.
class azure.mgmt.sql.models.VulnerabilityAssessmentScanError(**kwargs)[source]

Bases: msrest.serialization.Model

Properties of a vulnerability assessment scan error.

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

Variables:
  • code (str) – The error code.
  • message (str) – The error message.
class azure.mgmt.sql.models.VulnerabilityAssessmentScanRecord(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.DatabaseVulnerabilityAssessmentScansExport(**kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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:
class azure.mgmt.sql.models.InstanceFailoverGroupReadWriteEndpoint(*, failover_policy, failover_with_data_loss_grace_period_minutes: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Read-write endpoint of the failover group instance.

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

Parameters:
  • failover_policy (str or ReadWriteEndpointFailoverPolicy) – Required. Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. Possible values include: ‘Manual’, ‘Automatic’
  • failover_with_data_loss_grace_period_minutes (int) – Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.
class azure.mgmt.sql.models.InstanceFailoverGroupReadOnlyEndpoint(*, failover_policy=None, **kwargs)[source]

Bases: msrest.serialization.Model

Read-only endpoint of the failover group instance.

Parameters:failover_policy (str or ReadOnlyEndpointFailoverPolicy) – Failover policy of the read-only endpoint for the failover group. Possible values include: ‘Disabled’, ‘Enabled’
class azure.mgmt.sql.models.PartnerRegionInfo(*, location: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Partner region information for the failover group.

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

Parameters:location (str) – Geo location of the partner managed instances.
Variables:replication_role (str or InstanceFailoverGroupReplicationRole) – Replication role of the partner managed instances. Possible values include: ‘Primary’, ‘Secondary’
class azure.mgmt.sql.models.ManagedInstancePairInfo(*, primary_managed_instance_id: str = None, partner_managed_instance_id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Pairs of Managed Instances in the failover group.

Parameters:
  • primary_managed_instance_id (str) – Id of Primary Managed Instance in pair.
  • partner_managed_instance_id (str) – Id of Partner Managed Instance in pair.
class azure.mgmt.sql.models.InstanceFailoverGroup(*, read_write_endpoint, partner_regions, managed_instance_pairs, read_only_endpoint=None, **kwargs)[source]

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

An instance 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) – Resource ID.
  • name (str) – Resource name.
  • type (str) – Resource type.
  • replication_role (str or InstanceFailoverGroupReplicationRole) – Local replication role of the failover group instance. Possible values include: ‘Primary’, ‘Secondary’
  • replication_state (str) – Replication state of the failover group instance.
Parameters:
class azure.mgmt.sql.models.BackupShortTermRetentionPolicy(*, retention_days: int = None, **kwargs)[source]

Bases: azure.mgmt.sql.models.proxy_resource_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.
Parameters:

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

class azure.mgmt.sql.models.RecoverableDatabasePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RecoverableDatabase object

class azure.mgmt.sql.models.RestorableDroppedDatabasePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RestorableDroppedDatabase object

class azure.mgmt.sql.models.ServerPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Server object

class azure.mgmt.sql.models.DataMaskingRulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DataMaskingRule object

class azure.mgmt.sql.models.FirewallRulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of FirewallRule object

class azure.mgmt.sql.models.GeoBackupPolicyPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of GeoBackupPolicy object

class azure.mgmt.sql.models.MetricPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Metric object

class azure.mgmt.sql.models.MetricDefinitionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of MetricDefinition object

class azure.mgmt.sql.models.DatabasePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Database object

class azure.mgmt.sql.models.ElasticPoolPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ElasticPool object

class azure.mgmt.sql.models.RecommendedElasticPoolPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RecommendedElasticPool object

class azure.mgmt.sql.models.RecommendedElasticPoolMetricPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RecommendedElasticPoolMetric object

class azure.mgmt.sql.models.ReplicationLinkPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ReplicationLink object

class azure.mgmt.sql.models.ServerAzureADAdministratorPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ServerAzureADAdministrator object

class azure.mgmt.sql.models.ServerCommunicationLinkPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ServerCommunicationLink object

class azure.mgmt.sql.models.ServiceObjectivePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ServiceObjective object

class azure.mgmt.sql.models.ElasticPoolActivityPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ElasticPoolActivity object

class azure.mgmt.sql.models.ElasticPoolDatabaseActivityPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ElasticPoolDatabaseActivity object

class azure.mgmt.sql.models.ServiceTierAdvisorPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ServiceTierAdvisor object

class azure.mgmt.sql.models.TransparentDataEncryptionActivityPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of TransparentDataEncryptionActivity object

class azure.mgmt.sql.models.ServerUsagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ServerUsage object

class azure.mgmt.sql.models.DatabaseUsagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DatabaseUsage object

class azure.mgmt.sql.models.EncryptionProtectorPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of EncryptionProtector object

class azure.mgmt.sql.models.FailoverGroupPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of FailoverGroup object

class azure.mgmt.sql.models.ManagedInstancePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ManagedInstance object

class azure.mgmt.sql.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

class azure.mgmt.sql.models.ServerKeyPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ServerKey object

class azure.mgmt.sql.models.SyncAgentPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SyncAgent object

class azure.mgmt.sql.models.SyncAgentLinkedDatabasePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SyncAgentLinkedDatabase object

class azure.mgmt.sql.models.SyncDatabaseIdPropertiesPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SyncDatabaseIdProperties object

class azure.mgmt.sql.models.SyncFullSchemaPropertiesPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SyncFullSchemaProperties object

class azure.mgmt.sql.models.SyncGroupLogPropertiesPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SyncGroupLogProperties object

class azure.mgmt.sql.models.SyncGroupPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SyncGroup object

class azure.mgmt.sql.models.SyncMemberPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SyncMember object

class azure.mgmt.sql.models.SubscriptionUsagePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of SubscriptionUsage object

class azure.mgmt.sql.models.VirtualNetworkRulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of VirtualNetworkRule object

class azure.mgmt.sql.models.JobAgentPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobAgent object

class azure.mgmt.sql.models.JobCredentialPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobCredential object

class azure.mgmt.sql.models.JobExecutionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobExecution object

class azure.mgmt.sql.models.JobPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Job object

class azure.mgmt.sql.models.JobStepPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobStep object

class azure.mgmt.sql.models.JobTargetGroupPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobTargetGroup object

class azure.mgmt.sql.models.JobVersionPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobVersion object

class azure.mgmt.sql.models.LongTermRetentionBackupPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of LongTermRetentionBackup object

class azure.mgmt.sql.models.ManagedDatabasePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ManagedDatabase object

class azure.mgmt.sql.models.ServerDnsAliasPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ServerDnsAlias object

class azure.mgmt.sql.models.RestorePointPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of RestorePoint object

class azure.mgmt.sql.models.DatabaseOperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DatabaseOperation object

class azure.mgmt.sql.models.ElasticPoolOperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ElasticPoolOperation object

class azure.mgmt.sql.models.VulnerabilityAssessmentScanRecordPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of VulnerabilityAssessmentScanRecord object

class azure.mgmt.sql.models.InstanceFailoverGroupPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of InstanceFailoverGroup object

class azure.mgmt.sql.models.CheckNameAvailabilityReason[source]

Bases: str, enum.Enum

An enumeration.

already_exists = 'AlreadyExists'
invalid = 'Invalid'
class azure.mgmt.sql.models.ServerConnectionType[source]

Bases: str, enum.Enum

An enumeration.

default = 'Default'
proxy = 'Proxy'
redirect = 'Redirect'
class azure.mgmt.sql.models.SecurityAlertPolicyState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
new = 'New'
class azure.mgmt.sql.models.SecurityAlertPolicyEmailAccountAdmins[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.SecurityAlertPolicyUseServerDefault[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.DataMaskingState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.DataMaskingRuleState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.DataMaskingFunction[source]

Bases: str, enum.Enum

An enumeration.

ccn = 'CCN'
default = 'Default'
email = 'Email'
number = 'Number'
ssn = 'SSN'
text = 'Text'
class azure.mgmt.sql.models.GeoBackupPolicyState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.DatabaseEdition[source]

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'
business = 'Business'
data_warehouse = 'DataWarehouse'
free = 'Free'
premium = 'Premium'
premium_rs = 'PremiumRS'
standard = 'Standard'
stretch = 'Stretch'
system = 'System'
system2 = 'System2'
web = 'Web'
class azure.mgmt.sql.models.ServiceObjectiveName[source]

Bases: str, enum.Enum

An enumeration.

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'
dw10000c = 'DW10000c'
dw1000c = 'DW1000c'
dw1200 = 'DW1200'
dw1500 = 'DW1500'
dw15000c = 'DW15000c'
dw1500c = 'DW1500c'
dw200 = 'DW200'
dw2000 = 'DW2000'
dw2000c = 'DW2000c'
dw2500c = 'DW2500c'
dw300 = 'DW300'
dw3000 = 'DW3000'
dw30000c = 'DW30000c'
dw3000c = 'DW3000c'
dw400 = 'DW400'
dw500 = 'DW500'
dw5000c = 'DW5000c'
dw600 = 'DW600'
dw6000 = 'DW6000'
dw6000c = 'DW6000c'
dw7500c = '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.StorageKeyType[source]

Bases: str, enum.Enum

An enumeration.

shared_access_key = 'SharedAccessKey'
storage_access_key = 'StorageAccessKey'
class azure.mgmt.sql.models.AuthenticationType[source]

Bases: str, enum.Enum

An enumeration.

ad_password = 'ADPassword'
sql = 'SQL'
class azure.mgmt.sql.models.UnitType[source]

Bases: str, enum.Enum

An enumeration.

bytes = 'bytes'
bytes_per_second = 'bytesPerSecond'
count = 'count'
count_per_second = 'countPerSecond'
percent = 'percent'
seconds = 'seconds'
class azure.mgmt.sql.models.PrimaryAggregationType[source]

Bases: str, enum.Enum

An enumeration.

average = 'Average'
count = 'Count'
maximum = 'Maximum'
minimum = 'Minimum'
none = 'None'
total = 'Total'
class azure.mgmt.sql.models.UnitDefinitionType[source]

Bases: str, enum.Enum

An enumeration.

bytes = 'Bytes'
bytes_per_second = 'BytesPerSecond'
count = 'Count'
count_per_second = 'CountPerSecond'
percent = 'Percent'
seconds = 'Seconds'
class azure.mgmt.sql.models.ElasticPoolEdition[source]

Bases: str, enum.Enum

An enumeration.

basic = 'Basic'
premium = 'Premium'
standard = 'Standard'
class azure.mgmt.sql.models.ReplicationRole[source]

Bases: str, enum.Enum

An enumeration.

copy = 'Copy'
non_readable_secondary = 'NonReadableSecondary'
primary = 'Primary'
secondary = 'Secondary'
source = 'Source'
class azure.mgmt.sql.models.ReplicationState[source]

Bases: str, enum.Enum

An enumeration.

catch_up = 'CATCH_UP'
pending = 'PENDING'
seeding = 'SEEDING'
suspended = 'SUSPENDED'
class azure.mgmt.sql.models.RecommendedIndexAction[source]

Bases: str, enum.Enum

An enumeration.

create = 'Create'
drop = 'Drop'
rebuild = 'Rebuild'
class azure.mgmt.sql.models.RecommendedIndexState[source]

Bases: str, enum.Enum

An enumeration.

active = 'Active'
blocked = 'Blocked'
executing = 'Executing'
expired = 'Expired'
ignored = 'Ignored'
pending = 'Pending'
pending_revert = 'Pending Revert'
reverted = 'Reverted'
reverting = 'Reverting'
success = 'Success'
verifying = 'Verifying'
class azure.mgmt.sql.models.RecommendedIndexType[source]

Bases: str, enum.Enum

An enumeration.

clustered = 'CLUSTERED'
clusteredcolumnstore = 'CLUSTERED COLUMNSTORE'
columnstore = 'COLUMNSTORE'
nonclustered = 'NONCLUSTERED'
class azure.mgmt.sql.models.TransparentDataEncryptionStatus[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.TransparentDataEncryptionActivityStatus[source]

Bases: str, enum.Enum

An enumeration.

decrypting = 'Decrypting'
encrypting = 'Encrypting'
class azure.mgmt.sql.models.BlobAuditingPolicyState[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.AutomaticTuningMode[source]

Bases: str, enum.Enum

An enumeration.

auto = 'Auto'
custom = 'Custom'
inherit = 'Inherit'
unspecified = 'Unspecified'
class azure.mgmt.sql.models.AutomaticTuningOptionModeDesired[source]

Bases: str, enum.Enum

An enumeration.

default = 'Default'
off = 'Off'
on = 'On'
class azure.mgmt.sql.models.AutomaticTuningOptionModeActual[source]

Bases: str, enum.Enum

An enumeration.

off = 'Off'
on = 'On'
class azure.mgmt.sql.models.AutomaticTuningDisabledReason[source]

Bases: str, enum.Enum

An enumeration.

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.ServerKeyType[source]

Bases: str, enum.Enum

An enumeration.

azure_key_vault = 'AzureKeyVault'
service_managed = 'ServiceManaged'
class azure.mgmt.sql.models.ReadWriteEndpointFailoverPolicy[source]

Bases: str, enum.Enum

An enumeration.

automatic = 'Automatic'
manual = 'Manual'
class azure.mgmt.sql.models.ReadOnlyEndpointFailoverPolicy[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.FailoverGroupReplicationRole[source]

Bases: str, enum.Enum

An enumeration.

primary = 'Primary'
secondary = 'Secondary'
class azure.mgmt.sql.models.IdentityType[source]

Bases: str, enum.Enum

An enumeration.

system_assigned = 'SystemAssigned'
class azure.mgmt.sql.models.OperationOrigin[source]

Bases: str, enum.Enum

An enumeration.

system = 'system'
user = 'user'
class azure.mgmt.sql.models.SyncAgentState[source]

Bases: str, enum.Enum

An enumeration.

never_connected = 'NeverConnected'
offline = 'Offline'
online = 'Online'
class azure.mgmt.sql.models.SyncMemberDbType[source]

Bases: str, enum.Enum

An enumeration.

azure_sql_database = 'AzureSqlDatabase'
sql_server_database = 'SqlServerDatabase'
class azure.mgmt.sql.models.SyncGroupLogType[source]

Bases: str, enum.Enum

An enumeration.

all = 'All'
error = 'Error'
success = 'Success'
warning = 'Warning'
class azure.mgmt.sql.models.SyncConflictResolutionPolicy[source]

Bases: str, enum.Enum

An enumeration.

hub_win = 'HubWin'
member_win = 'MemberWin'
class azure.mgmt.sql.models.SyncGroupState[source]

Bases: str, enum.Enum

An enumeration.

error = 'Error'
good = 'Good'
not_ready = 'NotReady'
progressing = 'Progressing'
warning = 'Warning'
class azure.mgmt.sql.models.SyncDirection[source]

Bases: str, enum.Enum

An enumeration.

bidirectional = 'Bidirectional'
one_way_hub_to_member = 'OneWayHubToMember'
one_way_member_to_hub = 'OneWayMemberToHub'
class azure.mgmt.sql.models.SyncMemberState[source]

Bases: str, enum.Enum

An enumeration.

de_provision_failed = 'DeProvisionFailed'
de_provisioned = 'DeProvisioned'
de_provisioning = 'DeProvisioning'
disabled_backup_restore = 'DisabledBackupRestore'
disabled_tombstone_cleanup = 'DisabledTombstoneCleanup'
provision_failed = 'ProvisionFailed'
provisioned = 'Provisioned'
provisioning = 'Provisioning'
reprovision_failed = 'ReprovisionFailed'
reprovisioning = 'Reprovisioning'
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.VirtualNetworkRuleState[source]

Bases: str, enum.Enum

An enumeration.

deleting = 'Deleting'
in_progress = 'InProgress'
initializing = 'Initializing'
ready = 'Ready'
unknown = 'Unknown'
class azure.mgmt.sql.models.JobAgentState[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
deleting = 'Deleting'
disabled = 'Disabled'
ready = 'Ready'
updating = 'Updating'
class azure.mgmt.sql.models.JobExecutionLifecycle[source]

Bases: str, enum.Enum

An enumeration.

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.ProvisioningState[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
created = 'Created'
failed = 'Failed'
in_progress = 'InProgress'
succeeded = 'Succeeded'
class azure.mgmt.sql.models.JobTargetType[source]

Bases: str, enum.Enum

An enumeration.

sql_database = 'SqlDatabase'
sql_elastic_pool = 'SqlElasticPool'
sql_server = 'SqlServer'
sql_shard_map = 'SqlShardMap'
target_group = 'TargetGroup'
class azure.mgmt.sql.models.JobScheduleType[source]

Bases: str, enum.Enum

An enumeration.

once = 'Once'
recurring = 'Recurring'
class azure.mgmt.sql.models.JobStepActionType[source]

Bases: str, enum.Enum

An enumeration.

tsql = 'TSql'
class azure.mgmt.sql.models.JobStepActionSource[source]

Bases: str, enum.Enum

An enumeration.

inline = 'Inline'
class azure.mgmt.sql.models.JobStepOutputType[source]

Bases: str, enum.Enum

An enumeration.

sql_database = 'SqlDatabase'
class azure.mgmt.sql.models.JobTargetGroupMembershipType[source]

Bases: str, enum.Enum

An enumeration.

exclude = 'Exclude'
include = 'Include'
class azure.mgmt.sql.models.ManagedDatabaseStatus[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
inaccessible = 'Inaccessible'
offline = 'Offline'
online = 'Online'
shutdown = 'Shutdown'
class azure.mgmt.sql.models.CatalogCollationType[source]

Bases: str, enum.Enum

An enumeration.

database_default = 'DATABASE_DEFAULT'
sql_latin1_general_cp1_ci_as = 'SQL_Latin1_General_CP1_CI_AS'
class azure.mgmt.sql.models.ManagedDatabaseCreateMode[source]

Bases: str, enum.Enum

An enumeration.

default = 'Default'
point_in_time_restore = 'PointInTimeRestore'
restore_external_backup = 'RestoreExternalBackup'
class azure.mgmt.sql.models.AutomaticTuningServerMode[source]

Bases: str, enum.Enum

An enumeration.

auto = 'Auto'
custom = 'Custom'
unspecified = 'Unspecified'
class azure.mgmt.sql.models.AutomaticTuningServerReason[source]

Bases: str, enum.Enum

An enumeration.

auto_configured = 'AutoConfigured'
default = 'Default'
disabled = 'Disabled'
class azure.mgmt.sql.models.RestorePointType[source]

Bases: str, enum.Enum

An enumeration.

continuous = 'CONTINUOUS'
discrete = 'DISCRETE'
class azure.mgmt.sql.models.ManagementOperationState[source]

Bases: str, enum.Enum

An enumeration.

cancel_in_progress = 'CancelInProgress'
cancelled = 'Cancelled'
failed = 'Failed'
in_progress = 'InProgress'
pending = 'Pending'
succeeded = 'Succeeded'
class azure.mgmt.sql.models.MaxSizeUnit[source]

Bases: str, enum.Enum

An enumeration.

gigabytes = 'Gigabytes'
megabytes = 'Megabytes'
petabytes = 'Petabytes'
terabytes = 'Terabytes'
class azure.mgmt.sql.models.LogSizeUnit[source]

Bases: str, enum.Enum

An enumeration.

gigabytes = 'Gigabytes'
megabytes = 'Megabytes'
percent = 'Percent'
petabytes = 'Petabytes'
terabytes = 'Terabytes'
class azure.mgmt.sql.models.CapabilityStatus[source]

Bases: str, enum.Enum

An enumeration.

available = 'Available'
default = 'Default'
disabled = 'Disabled'
visible = 'Visible'
class azure.mgmt.sql.models.PerformanceLevelUnit[source]

Bases: str, enum.Enum

An enumeration.

dtu = 'DTU'
vcores = 'VCores'
class azure.mgmt.sql.models.CreateMode[source]

Bases: str, enum.Enum

An enumeration.

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.SampleName[source]

Bases: str, enum.Enum

An enumeration.

adventure_works_lt = 'AdventureWorksLT'
wide_world_importers_full = 'WideWorldImportersFull'
wide_world_importers_std = 'WideWorldImportersStd'
class azure.mgmt.sql.models.DatabaseStatus[source]

Bases: str, enum.Enum

An enumeration.

auto_closed = 'AutoClosed'
copying = 'Copying'
creating = 'Creating'
emergency_mode = 'EmergencyMode'
inaccessible = 'Inaccessible'
offline = 'Offline'
offline_secondary = 'OfflineSecondary'
online = 'Online'
paused = 'Paused'
pausing = 'Pausing'
recovering = 'Recovering'
recovery_pending = 'RecoveryPending'
restoring = 'Restoring'
resuming = 'Resuming'
scaling = 'Scaling'
shutdown = 'Shutdown'
standby = 'Standby'
suspect = 'Suspect'
class azure.mgmt.sql.models.DatabaseLicenseType[source]

Bases: str, enum.Enum

An enumeration.

base_price = 'BasePrice'
license_included = 'LicenseIncluded'
class azure.mgmt.sql.models.DatabaseReadScale[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'
enabled = 'Enabled'
class azure.mgmt.sql.models.ElasticPoolState[source]

Bases: str, enum.Enum

An enumeration.

creating = 'Creating'
disabled = 'Disabled'
ready = 'Ready'
class azure.mgmt.sql.models.ElasticPoolLicenseType[source]

Bases: str, enum.Enum

An enumeration.

base_price = 'BasePrice'
license_included = 'LicenseIncluded'
class azure.mgmt.sql.models.VulnerabilityAssessmentScanTriggerType[source]

Bases: str, enum.Enum

An enumeration.

on_demand = 'OnDemand'
recurring = 'Recurring'
class azure.mgmt.sql.models.VulnerabilityAssessmentScanState[source]

Bases: str, enum.Enum

An enumeration.

failed = 'Failed'
failed_to_run = 'FailedToRun'
in_progress = 'InProgress'
passed = 'Passed'
class azure.mgmt.sql.models.InstanceFailoverGroupReplicationRole[source]

Bases: str, enum.Enum

An enumeration.

primary = 'Primary'
secondary = 'Secondary'
class azure.mgmt.sql.models.LongTermRetentionDatabaseState[source]

Bases: str, enum.Enum

An enumeration.

all = 'All'
deleted = 'Deleted'
live = 'Live'
class azure.mgmt.sql.models.CapabilityGroup[source]

Bases: str, enum.Enum

An enumeration.

supported_editions = 'supportedEditions'
supported_elastic_pool_editions = 'supportedElasticPoolEditions'
supported_managed_instance_versions = 'supportedManagedInstanceVersions'