azure.mgmt.sql.operations module¶

class azure.mgmt.sql.operations.RecoverableDatabasesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RecoverableDatabasesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a recoverable database, which is a resource representing a database’s geo backup.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RecoverableDatabase or ClientRawResponse if raw=true

Return type

RecoverableDatabase or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of recoverable databases.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecoverableDatabase

Return type

RecoverableDatabasePaged[RecoverableDatabase]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.RestorableDroppedDatabasesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RestorableDroppedDatabasesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

get(resource_group_name, server_name, restorable_droppeded_database_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a deleted database that can be restored.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
restorable_droppeded_database_id (str) – The id of the deleted database in the form of databaseName,deletionTimeInFileTimeFormat
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RestorableDroppedDatabase or ClientRawResponse if raw=true

Return type

RestorableDroppedDatabase or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of deleted databases that can be restored.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RestorableDroppedDatabase

Return type

RestorableDroppedDatabasePaged[RestorableDroppedDatabase]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerConnectionPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerConnectionPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.
connection_policy_name – The name of the connection policy. Constant value: “default”.

create_or_update(resource_group_name, server_name, connection_type, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates the server’s connection policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
connection_type (str or ServerConnectionType) – The server connection type. Possible values include: ‘Default’, ‘Proxy’, ‘Redirect’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerConnectionPolicy or ClientRawResponse if raw=true

Return type

ServerConnectionPolicy or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the server’s secure connection policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerConnectionPolicy or ClientRawResponse if raw=true

Return type

ServerConnectionPolicy or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabaseThreatDetectionPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseThreatDetectionPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

security_alert_policy_name – The name of the security alert policy. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2014-04-01”.

create_or_update(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a database’s threat detection policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which database Threat Detection policy is defined.
parameters (DatabaseSecurityAlertPolicy) – The database Threat Detection policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseSecurityAlertPolicy or ClientRawResponse if raw=true

Return type

DatabaseSecurityAlertPolicy or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s threat detection policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which database Threat Detection policy is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseSecurityAlertPolicy or ClientRawResponse if raw=true

Return type

DatabaseSecurityAlertPolicy or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DataMaskingPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DataMaskingPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.
data_masking_policy_name – The name of the database for which the data masking rule applies. Constant value: “Default”.

create_or_update(resource_group_name, server_name, database_name, data_masking_state, exempt_principals=None, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a database data masking policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
data_masking_state (str or DataMaskingState) – The state of the data masking policy. Possible values include: ‘Disabled’, ‘Enabled’
exempt_principals (str) – The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DataMaskingPolicy or ClientRawResponse if raw=true

Return type

DataMaskingPolicy or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database data masking policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DataMaskingPolicy or ClientRawResponse if raw=true

Return type

DataMaskingPolicy or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DataMaskingRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DataMaskingRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.
data_masking_policy_name – The name of the database for which the data masking rule applies. Constant value: “Default”.

create_or_update(resource_group_name, server_name, database_name, data_masking_rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a database data masking rule.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
data_masking_rule_name (str) – The name of the data masking rule.
parameters (DataMaskingRule) – The required parameters for creating or updating a data masking rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DataMaskingRule or ClientRawResponse if raw=true

Return type

DataMaskingRule or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of database data masking rules.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DataMaskingRule

Return type

DataMaskingRulePaged[DataMaskingRule]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.FirewallRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

FirewallRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

create_or_update(resource_group_name, server_name, firewall_rule_name, start_ip_address, end_ip_address, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a firewall rule.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
firewall_rule_name (str) – The name of the firewall rule.
start_ip_address (str) – The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ to represent all Azure-internal IP addresses.
end_ip_address (str) – The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ to represent all Azure-internal IP addresses.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

FirewallRule or ClientRawResponse if raw=true

Return type

FirewallRule or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, firewall_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes a firewall rule.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
firewall_rule_name (str) – The name of the firewall rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, firewall_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a firewall rule.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
firewall_rule_name (str) – The name of the firewall rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

FirewallRule or ClientRawResponse if raw=true

Return type

FirewallRule or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns a list of firewall rules.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of FirewallRule

Return type

FirewallRulePaged[FirewallRule]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.GeoBackupPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GeoBackupPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.
geo_backup_policy_name – The name of the geo backup policy. Constant value: “Default”.

create_or_update(resource_group_name, server_name, database_name, state, custom_headers=None, raw=False, **operation_config)[source]¶

Updates a database geo backup policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
state (str or GeoBackupPolicyState) – The state of the geo backup policy. Possible values include: ‘Disabled’, ‘Enabled’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

GeoBackupPolicy or ClientRawResponse if raw=true

Return type

GeoBackupPolicy or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a geo backup policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

GeoBackupPolicy or ClientRawResponse if raw=true

Return type

GeoBackupPolicy or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns a list of geo backup policies.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of GeoBackupPolicy

Return type

GeoBackupPolicyPaged[GeoBackupPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabasesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabasesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a new database or updates an existing database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (Database) – The requested database resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True

Return type

AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]

Raises

CloudError

delete(resource_group_name, server_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

export(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Exports a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (ExportDatabaseDefinition) – The database export request parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ImportExportOperationResult or ClientRawResponse<ImportExportOperationResult> if raw==True

Return type

AzureOperationPoller[ImportExportOperationResult] or AzureOperationPoller[ClientRawResponse[ImportExportOperationResult]]

Raises

CloudError

failover(resource_group_name, server_name, database_name, replica_type=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Failovers a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to failover.
replica_type (str or ReplicaType) – The type of replica to be failed over. Possible values include: ‘Primary’, ‘ReadableSecondary’
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Database or ClientRawResponse if raw=true

Return type

Database or ClientRawResponse

Raises

CloudError

list_by_elastic_pool(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of databases in an elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Database

Return type

DatabasePaged[Database]

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of databases.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Database

Return type

DatabasePaged[Database]

Raises

CloudError

list_inaccessible_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of inaccessible databases in a logical server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Database

Return type

DatabasePaged[Database]

Raises

CloudError

list_metric_definitions(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns database metric definitions.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of MetricDefinition

Return type

MetricDefinitionPaged[MetricDefinition]

Raises

CloudError

list_metrics(resource_group_name, server_name, database_name, filter, custom_headers=None, raw=False, **operation_config)[source]¶

Returns database metrics.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
filter (str) – An OData filter expression that describes a subset of metrics to return.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Metric

Return type

MetricPaged[Metric]

Raises

CloudError

pause(resource_group_name, server_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Pauses a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to be paused.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True

Return type

AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]

Raises

CloudError

rename(resource_group_name, server_name, database_name, id, custom_headers=None, raw=False, **operation_config)[source]¶

Renames a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to rename.
id (str) – The target ID for the resource
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

resume(resource_group_name, server_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Resumes a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to be resumed.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True

Return type

AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]

Raises

CloudError

update(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an existing database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (DatabaseUpdate) – The requested database resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True

Return type

AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]

Raises

CloudError

upgrade_data_warehouse(resource_group_name, server_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Upgrades a data warehouse.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to be upgraded.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ElasticPoolsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ElasticPoolsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name, server_name, elastic_pool_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
parameters (ElasticPool) – The elastic pool parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ElasticPool or ClientRawResponse<ElasticPool> if raw==True

Return type

AzureOperationPoller[ElasticPool] or AzureOperationPoller[ClientRawResponse[ElasticPool]]

Raises

CloudError

delete(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

failover(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Failovers an elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool to failover.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets an elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ElasticPool or ClientRawResponse if raw=true

Return type

ElasticPool or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, skip=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all elastic pools in a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
skip (int) – The number of elements in the collection to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ElasticPool

Return type

ElasticPoolPaged[ElasticPool]

Raises

CloudError

list_metric_definitions(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns elastic pool metric definitions.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of MetricDefinition

Return type

MetricDefinitionPaged[MetricDefinition]

Raises

CloudError

list_metrics(resource_group_name, server_name, elastic_pool_name, filter, custom_headers=None, raw=False, **operation_config)[source]¶

Returns elastic pool metrics.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
filter (str) – An OData filter expression that describes a subset of metrics to return.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Metric

Return type

MetricPaged[Metric]

Raises

CloudError

update(resource_group_name, server_name, elastic_pool_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
parameters (ElasticPoolUpdate) – The elastic pool update parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ElasticPool or ClientRawResponse<ElasticPool> if raw==True

Return type

AzureOperationPoller[ElasticPool] or AzureOperationPoller[ClientRawResponse[ElasticPool]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.RecommendedElasticPoolsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RecommendedElasticPoolsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

get(resource_group_name, server_name, recommended_elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a recommended elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
recommended_elastic_pool_name (str) – The name of the recommended elastic pool to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RecommendedElasticPool or ClientRawResponse if raw=true

Return type

RecommendedElasticPool or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns recommended elastic pools.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecommendedElasticPool

Return type

Raises

CloudError

list_metrics(resource_group_name, server_name, recommended_elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns recommended elastic pool metrics.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
recommended_elastic_pool_name (str) – The name of the recommended elastic pool to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecommendedElasticPoolMetric

Return type

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ReplicationLinksOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ReplicationLinksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

delete(resource_group_name, server_name, database_name, link_id, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes a database replication link. Cannot be done during failover.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database that has the replication link to be dropped.
link_id (str) – The ID of the replication link to be deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

failover(resource_group_name, server_name, database_name, link_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Sets which replica database is primary by failing over from the current primary replica database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database that has the replication link to be failed over.
link_id (str) – The ID of the replication link to be failed over.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

failover_allow_data_loss(resource_group_name, server_name, database_name, link_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database that has the replication link to be failed over.
link_id (str) – The ID of the replication link to be failed over.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, database_name, link_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database replication link.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to get the link for.
link_id (str) – The replication link ID to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ReplicationLink or ClientRawResponse if raw=true

Return type

ReplicationLink or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists a database’s replication links.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to retrieve links for.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ReplicationLink

Return type

ReplicationLinkPaged[ReplicationLink]

Raises

CloudError

unlink(resource_group_name, server_name, database_name, link_id, forced_termination=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a database replication link in forced or friendly way.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database that has the replication link to be failed over.
link_id (str) – The ID of the replication link to be failed over.
forced_termination (bool) – Determines whether link will be terminated in a forced or a friendly way.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerCommunicationLinksOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerCommunicationLinksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

create_or_update(resource_group_name, server_name, communication_link_name, partner_server, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a server communication link.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
communication_link_name (str) – The name of the server communication link.
partner_server (str) – The name of the partner server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServerCommunicationLink or ClientRawResponse<ServerCommunicationLink> if raw==True

Return type

AzureOperationPoller[ServerCommunicationLink] or AzureOperationPoller[ClientRawResponse[ServerCommunicationLink]]

Raises

CloudError

delete(resource_group_name, server_name, communication_link_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes a server communication link.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
communication_link_name (str) – The name of the server communication link.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, communication_link_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns a server communication link.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
communication_link_name (str) – The name of the server communication link.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerCommunicationLink or ClientRawResponse if raw=true

Return type

ServerCommunicationLink or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of server communication links.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerCommunicationLink

Return type

ServerCommunicationLinkPaged[ServerCommunicationLink]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServiceObjectivesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServiceObjectivesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

get(resource_group_name, server_name, service_objective_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database service objective.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
service_objective_name (str) – The name of the service objective to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServiceObjective or ClientRawResponse if raw=true

Return type

ServiceObjective or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns database service objectives.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServiceObjective

Return type

ServiceObjectivePaged[ServiceObjective]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ElasticPoolActivitiesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ElasticPoolActivitiesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

list_by_elastic_pool(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns elastic pool activities.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool for which to get the current activity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ElasticPoolActivity

Return type

ElasticPoolActivityPaged[ElasticPoolActivity]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ElasticPoolDatabaseActivitiesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ElasticPoolDatabaseActivitiesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

list_by_elastic_pool(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns activity on databases inside of an elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ElasticPoolDatabaseActivity

Return type

ElasticPoolDatabaseActivityPaged[ElasticPoolDatabaseActivity]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServiceTierAdvisorsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServiceTierAdvisorsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

get(resource_group_name, server_name, database_name, service_tier_advisor_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a service tier advisor.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of database.
service_tier_advisor_name (str) – The name of service tier advisor.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServiceTierAdvisor or ClientRawResponse if raw=true

Return type

ServiceTierAdvisor or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns service tier advisors for specified database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServiceTierAdvisor

Return type

ServiceTierAdvisorPaged[ServiceTierAdvisor]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.TransparentDataEncryptionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TransparentDataEncryptionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.
transparent_data_encryption_name – The name of the transparent data encryption configuration. Constant value: “current”.

create_or_update(resource_group_name, server_name, database_name, status=None, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a database’s transparent data encryption configuration.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which setting the transparent data encryption applies.
status (str or TransparentDataEncryptionStatus) – The status of the database transparent data encryption. Possible values include: ‘Enabled’, ‘Disabled’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

TransparentDataEncryption or ClientRawResponse if raw=true

Return type

TransparentDataEncryption or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s transparent data encryption configuration.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the transparent data encryption applies.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

TransparentDataEncryption or ClientRawResponse if raw=true

Return type

TransparentDataEncryption or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.TransparentDataEncryptionActivitiesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TransparentDataEncryptionActivitiesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.
transparent_data_encryption_name – The name of the transparent data encryption configuration. Constant value: “current”.

list_by_configuration(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns a database’s transparent data encryption operation result.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the transparent data encryption applies.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of TransparentDataEncryptionActivity

Return type

TransparentDataEncryptionActivityPaged[TransparentDataEncryptionActivity]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerUsagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerUsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns server usages.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerUsage

Return type

ServerUsagePaged[ServerUsage]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabaseUsagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseUsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2014-04-01”.

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Returns database usages.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DatabaseUsage

Return type

DatabaseUsagePaged[DatabaseUsage]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabaseAutomaticTuningOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseAutomaticTuningOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s automatic tuning.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseAutomaticTuning or ClientRawResponse if raw=true

Return type

DatabaseAutomaticTuning or ClientRawResponse

Raises

CloudError

update(resource_group_name, server_name, database_name, desired_state=None, options=None, custom_headers=None, raw=False, **operation_config)[source]¶

Update automatic tuning properties for target database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
desired_state (str or AutomaticTuningMode) – Automatic tuning desired state. Possible values include: ‘Inherit’, ‘Custom’, ‘Auto’, ‘Unspecified’
options (dict[str, AutomaticTuningOptions]) – Automatic tuning options definition.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseAutomaticTuning or ClientRawResponse if raw=true

Return type

DatabaseAutomaticTuning or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.EncryptionProtectorsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

EncryptionProtectorsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

encryption_protector_name – The name of the encryption protector to be updated. Constant value: “current”.
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

create_or_update(resource_group_name, server_name, server_key_type, server_key_name=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an existing encryption protector.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
server_key_type (str or ServerKeyType) – The encryption protector type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: ‘ServiceManaged’, ‘AzureKeyVault’
server_key_name (str) – The name of the server key.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns EncryptionProtector or ClientRawResponse<EncryptionProtector> if raw==True

Return type

AzureOperationPoller[EncryptionProtector] or AzureOperationPoller[ClientRawResponse[EncryptionProtector]]

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a server encryption protector.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

EncryptionProtector or ClientRawResponse if raw=true

Return type

EncryptionProtector or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of server encryption protectors.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of EncryptionProtector

Return type

EncryptionProtectorPaged[EncryptionProtector]

Raises

CloudError

revalidate(resource_group_name, server_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Revalidates an existing encryption protector.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.FailoverGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

FailoverGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

create_or_update(resource_group_name, server_name, failover_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a failover group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
parameters (FailoverGroup) – The failover group parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FailoverGroup or ClientRawResponse<FailoverGroup> if raw==True

Return type

AzureOperationPoller[FailoverGroup] or AzureOperationPoller[ClientRawResponse[FailoverGroup]]

Raises

CloudError

delete(resource_group_name, server_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a failover group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

failover(resource_group_name, server_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Fails over from the current primary server to this server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FailoverGroup or ClientRawResponse<FailoverGroup> if raw==True

Return type

AzureOperationPoller[FailoverGroup] or AzureOperationPoller[ClientRawResponse[FailoverGroup]]

Raises

CloudError

force_failover_allow_data_loss(resource_group_name, server_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Fails over from the current primary server to this server. This operation might result in data loss.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FailoverGroup or ClientRawResponse<FailoverGroup> if raw==True

Return type

AzureOperationPoller[FailoverGroup] or AzureOperationPoller[ClientRawResponse[FailoverGroup]]

Raises

CloudError

get(resource_group_name, server_name, failover_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a failover group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

FailoverGroup or ClientRawResponse if raw=true

Return type

FailoverGroup or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the failover groups in a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of FailoverGroup

Return type

FailoverGroupPaged[FailoverGroup]

Raises

CloudError

update(resource_group_name, server_name, failover_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a failover group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
parameters (FailoverGroupUpdate) – The failover group parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns FailoverGroup or ClientRawResponse<FailoverGroup> if raw==True

Return type

AzureOperationPoller[FailoverGroup] or AzureOperationPoller[ClientRawResponse[FailoverGroup]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.Operations(client, config, serializer, deserializer)[source]¶

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

list(custom_headers=None, raw=False, **operation_config)[source]¶

Lists all of the available SQL Rest API operations.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerKeysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerKeysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

create_or_update(resource_group_name, server_name, key_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a server key.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
key_name (str) – The name of the server key to be operated on (updated or created). The key name is required to be in the format of ‘vault_key_version’. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/01234567890123456789012345678901, then the server key name should be formatted as: YourVaultName_YourKeyName_01234567890123456789012345678901
parameters (ServerKey) – The requested server key resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServerKey or ClientRawResponse<ServerKey> if raw==True

Return type

AzureOperationPoller[ServerKey] or AzureOperationPoller[ClientRawResponse[ServerKey]]

Raises

CloudError

delete(resource_group_name, server_name, key_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the server key with the given name.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
key_name (str) – The name of the server key to be deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, key_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a server key.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
key_name (str) – The name of the server key to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerKey or ClientRawResponse if raw=true

Return type

ServerKey or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of server keys.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerKey

Return type

ServerKeyPaged[ServerKey]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.SyncAgentsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SyncAgentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

create_or_update(resource_group_name, server_name, sync_agent_name, sync_database_id=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a sync agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
sync_database_id (str) – ARM resource id of the sync database in the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SyncAgent or ClientRawResponse<SyncAgent> if raw==True

Return type

AzureOperationPoller[SyncAgent] or AzureOperationPoller[ClientRawResponse[SyncAgent]]

Raises

CloudError

delete(resource_group_name, server_name, sync_agent_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a sync agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

generate_key(resource_group_name, server_name, sync_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶

Generates a sync agent key.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SyncAgentKeyProperties or ClientRawResponse if raw=true

Return type

SyncAgentKeyProperties or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, sync_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a sync agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SyncAgent or ClientRawResponse if raw=true

Return type

SyncAgent or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists sync agents in a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SyncAgent

Return type

SyncAgentPaged[SyncAgent]

Raises

CloudError

list_linked_databases(resource_group_name, server_name, sync_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists databases linked to a sync agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SyncAgentLinkedDatabase

Return type

SyncAgentLinkedDatabasePaged[SyncAgentLinkedDatabase]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.SubscriptionUsagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SubscriptionUsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

get(location_name, usage_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a subscription usage metric.

Parameters

location_name (str) – The name of the region where the resource is located.
usage_name (str) – Name of usage metric to return.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SubscriptionUsage or ClientRawResponse if raw=true

Return type

SubscriptionUsage or ClientRawResponse

Raises

CloudError

list_by_location(location_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all subscription usage metrics in a given location.

Parameters

location_name (str) – The name of the region where the resource is located.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SubscriptionUsage

Return type

SubscriptionUsagePaged[SubscriptionUsage]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.VirtualClustersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualClustersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

delete(resource_group_name, virtual_cluster_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a virtual cluster.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
virtual_cluster_name (str) – The name of the virtual cluster.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, virtual_cluster_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a virtual cluster.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
virtual_cluster_name (str) – The name of the virtual cluster.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualCluster or ClientRawResponse if raw=true

Return type

VirtualCluster or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of all virtualClusters in the subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualCluster

Return type

VirtualClusterPaged[VirtualCluster]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of virtual clusters in a resource group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualCluster

Return type

VirtualClusterPaged[VirtualCluster]

Raises

CloudError

update(resource_group_name, virtual_cluster_name, family=None, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a virtual cluster.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
virtual_cluster_name (str) – The name of the virtual cluster.
family (str) – If the service has different generations of hardware, for the same SKU, then that can be captured here.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualCluster or ClientRawResponse<VirtualCluster> if raw==True

Return type

AzureOperationPoller[VirtualCluster] or AzureOperationPoller[ClientRawResponse[VirtualCluster]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.VirtualNetworkRulesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

VirtualNetworkRulesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.

create_or_update(resource_group_name, server_name, virtual_network_rule_name, virtual_network_subnet_id, ignore_missing_vnet_service_endpoint=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an existing virtual network rule.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
virtual_network_rule_name (str) – The name of the virtual network rule.
virtual_network_subnet_id (str) – The ARM resource id of the virtual network subnet.
ignore_missing_vnet_service_endpoint (bool) – Create firewall rule before the virtual network has vnet service endpoint enabled.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkRule or ClientRawResponse<VirtualNetworkRule> if raw==True

Return type

AzureOperationPoller[VirtualNetworkRule] or AzureOperationPoller[ClientRawResponse[VirtualNetworkRule]]

Raises

CloudError

delete(resource_group_name, server_name, virtual_network_rule_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the virtual network rule with the given name.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
virtual_network_rule_name (str) – The name of the virtual network rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, virtual_network_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a virtual network rule.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
virtual_network_rule_name (str) – The name of the virtual network rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VirtualNetworkRule or ClientRawResponse if raw=true

Return type

VirtualNetworkRule or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of virtual network rules in a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkRule

Return type

VirtualNetworkRulePaged[VirtualNetworkRule]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ExtendedDatabaseBlobAuditingPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExtendedDatabaseBlobAuditingPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

blob_auditing_policy_name – The name of the blob auditing policy. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates an extended database’s blob auditing policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (ExtendedDatabaseBlobAuditingPolicy) – The extended database blob auditing policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExtendedDatabaseBlobAuditingPolicy or ClientRawResponse if raw=true

Return type

ExtendedDatabaseBlobAuditingPolicy or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets an extended database’s blob auditing policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExtendedDatabaseBlobAuditingPolicy or ClientRawResponse if raw=true

Return type

ExtendedDatabaseBlobAuditingPolicy or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists extended auditing settings of a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExtendedDatabaseBlobAuditingPolicy

Return type

ExtendedDatabaseBlobAuditingPolicyPaged[ExtendedDatabaseBlobAuditingPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ExtendedServerBlobAuditingPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ExtendedServerBlobAuditingPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

blob_auditing_policy_name – The name of the blob auditing policy. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an extended server’s blob auditing policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ExtendedServerBlobAuditingPolicy) – Properties of extended blob auditing policy
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ExtendedServerBlobAuditingPolicy or ClientRawResponse<ExtendedServerBlobAuditingPolicy> if raw==True

Return type

AzureOperationPoller[ExtendedServerBlobAuditingPolicy] or AzureOperationPoller[ClientRawResponse[ExtendedServerBlobAuditingPolicy]]

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets an extended server’s blob auditing policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ExtendedServerBlobAuditingPolicy or ClientRawResponse if raw=true

Return type

ExtendedServerBlobAuditingPolicy or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists extended auditing settings of a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ExtendedServerBlobAuditingPolicy

Return type

ExtendedServerBlobAuditingPolicyPaged[ExtendedServerBlobAuditingPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerBlobAuditingPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerBlobAuditingPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

blob_auditing_policy_name – The name of the blob auditing policy. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a server’s blob auditing policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ServerBlobAuditingPolicy) – Properties of blob auditing policy
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServerBlobAuditingPolicy or ClientRawResponse<ServerBlobAuditingPolicy> if raw==True

Return type

AzureOperationPoller[ServerBlobAuditingPolicy] or AzureOperationPoller[ClientRawResponse[ServerBlobAuditingPolicy]]

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a server’s blob auditing policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerBlobAuditingPolicy or ClientRawResponse if raw=true

Return type

ServerBlobAuditingPolicy or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists auditing settings of a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerBlobAuditingPolicy

Return type

ServerBlobAuditingPolicyPaged[ServerBlobAuditingPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabaseBlobAuditingPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseBlobAuditingPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

blob_auditing_policy_name – The name of the blob auditing policy. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a database’s blob auditing policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (DatabaseBlobAuditingPolicy) – The database blob auditing policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseBlobAuditingPolicy or ClientRawResponse if raw=true

Return type

DatabaseBlobAuditingPolicy or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s blob auditing policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseBlobAuditingPolicy or ClientRawResponse if raw=true

Return type

DatabaseBlobAuditingPolicy or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists auditing settings of a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DatabaseBlobAuditingPolicy

Return type

DatabaseBlobAuditingPolicyPaged[DatabaseBlobAuditingPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabaseVulnerabilityAssessmentRuleBaselinesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseVulnerabilityAssessmentRuleBaselinesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, database_name, rule_id, baseline_name, baseline_results, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a database’s vulnerability assessment rule baseline.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). Possible values include: ‘master’, ‘default’
baseline_results (list[DatabaseVulnerabilityAssessmentRuleBaselineItem]) – The rule baseline result
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, database_name, rule_id, baseline_name, custom_headers=None, raw=False, **operation_config)[source]¶

Removes the database’s vulnerability assessment rule baseline.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). Possible values include: ‘master’, ‘default’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, rule_id, baseline_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s vulnerability assessment rule baseline.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). Possible values include: ‘master’, ‘default’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabaseVulnerabilityAssessmentsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseVulnerabilityAssessmentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates the database’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
parameters (DatabaseVulnerabilityAssessment) – The requested resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessment or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessment or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Removes the database’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the database’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessment or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessment or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the vulnerability assessment policies associated with a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment policies are defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DatabaseVulnerabilityAssessment

Return type

DatabaseVulnerabilityAssessmentPaged[DatabaseVulnerabilityAssessment]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobAgentsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobAgentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, job_agent_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a job agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be created or updated.
parameters (JobAgent) – The requested job agent resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns JobAgent or ClientRawResponse<JobAgent> if raw==True

Return type

AzureOperationPoller[JobAgent] or AzureOperationPoller[ClientRawResponse[JobAgent]]

Raises

CloudError

delete(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a job agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a job agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobAgent or ClientRawResponse if raw=true

Return type

JobAgent or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of job agents in a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobAgent

Return type

JobAgentPaged[JobAgent]

Raises

CloudError

update(resource_group_name, server_name, job_agent_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a job agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be updated.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns JobAgent or ClientRawResponse<JobAgent> if raw==True

Return type

AzureOperationPoller[JobAgent] or AzureOperationPoller[ClientRawResponse[JobAgent]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobCredentialsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobCredentialsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, job_agent_name, credential_name, username, password, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a job credential.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
username (str) – The credential user name.
password (str) – The credential password.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobCredential or ClientRawResponse if raw=true

Return type

JobCredential or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, job_agent_name, credential_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes a job credential.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, job_agent_name, credential_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a jobs credential.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobCredential or ClientRawResponse if raw=true

Return type

JobCredential or ClientRawResponse

Raises

CloudError

list_by_agent(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of jobs credentials.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobCredential

Return type

JobCredentialPaged[JobCredential]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobExecutionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobExecutionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

cancel(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers=None, raw=False, **operation_config)[source]¶

Requests cancellation of a job execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_execution_id (str) – The id of the job execution to cancel.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

create(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Starts an elastic job execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns JobExecution or ClientRawResponse<JobExecution> if raw==True

Return type

AzureOperationPoller[JobExecution] or AzureOperationPoller[ClientRawResponse[JobExecution]]

Raises

CloudError

create_or_update(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a job execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The job execution id to create the job execution under.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns JobExecution or ClientRawResponse<JobExecution> if raw==True

Return type

AzureOperationPoller[JobExecution] or AzureOperationPoller[ClientRawResponse[JobExecution]]

Raises

CloudError

get(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a job execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_execution_id (str) – The id of the job execution
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobExecution or ClientRawResponse if raw=true

Return type

JobExecution or ClientRawResponse

Raises

CloudError

list_by_agent(resource_group_name, server_name, job_agent_name, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all executions in a job agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobExecution

Return type

JobExecutionPaged[JobExecution]

Raises

CloudError

list_by_job(resource_group_name, server_name, job_agent_name, job_name, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists a job’s executions.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobExecution

Return type

JobExecutionPaged[JobExecution]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, job_agent_name, job_name, description='', schedule=None, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a job.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
description (str) – User-defined description of the job.
schedule (JobSchedule) – Schedule properties of the job.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Job or ClientRawResponse if raw=true

Return type

Job or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes a job.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to delete.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a job.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Job or ClientRawResponse if raw=true

Return type

Job or ClientRawResponse

Raises

CloudError

list_by_agent(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of jobs.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Job

Return type

JobPaged[Job]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobStepExecutionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobStepExecutionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

get(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a step execution of a job execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The unique id of the job execution
step_name (str) – The name of the step.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobExecution or ClientRawResponse if raw=true

Return type

JobExecution or ClientRawResponse

Raises

CloudError

list_by_job_execution(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the step executions of a job execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobExecution

Return type

JobExecutionPaged[JobExecution]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobStepsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobStepsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a job step. This will implicitly create a new job version.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step.
parameters (JobStep) – The requested state of the job step.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobStep or ClientRawResponse if raw=true

Return type

JobStep or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes a job step. This will implicitly create a new job version.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step to delete.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a job step in a job’s current version.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobStep or ClientRawResponse if raw=true

Return type

JobStep or ClientRawResponse

Raises

CloudError

get_by_version(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the specified version of a job step.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_version (int) – The version of the job to get.
step_name (str) – The name of the job step.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobStep or ClientRawResponse if raw=true

Return type

JobStep or ClientRawResponse

Raises

CloudError

list_by_job(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all job steps for a job’s current version.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobStep

Return type

JobStepPaged[JobStep]

Raises

CloudError

list_by_version(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all job steps in the specified job version.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_version (int) – The version of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobStep

Return type

JobStepPaged[JobStep]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobTargetExecutionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobTargetExecutionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

get(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a target execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The unique id of the job execution
step_name (str) – The name of the step.
target_id (str) – The target id.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobExecution or ClientRawResponse if raw=true

Return type

JobExecution or ClientRawResponse

Raises

CloudError

list_by_job_execution(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists target executions for all steps of a job execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobExecution

Return type

JobExecutionPaged[JobExecution]

Raises

CloudError

list_by_step(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the target executions of a job step execution.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution
step_name (str) – The name of the step.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobExecution

Return type

JobExecutionPaged[JobExecution]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobTargetGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobTargetGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, job_agent_name, target_group_name, members, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a target group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
members (list[JobTarget]) – Members of the target group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobTargetGroup or ClientRawResponse if raw=true

Return type

JobTargetGroup or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, job_agent_name, target_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes a target group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, job_agent_name, target_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a target group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobTargetGroup or ClientRawResponse if raw=true

Return type

JobTargetGroup or ClientRawResponse

Raises

CloudError

list_by_agent(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all target groups in an agent.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobTargetGroup

Return type

JobTargetGroupPaged[JobTargetGroup]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.JobVersionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

JobVersionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

get(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a job version.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_version (int) – The version of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

JobVersion or ClientRawResponse if raw=true

Return type

JobVersion or ClientRawResponse

Raises

CloudError

list_by_job(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all versions of a job.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of JobVersion

Return type

JobVersionPaged[JobVersion]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.LongTermRetentionBackupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LongTermRetentionBackupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

delete(location_name, long_term_retention_server_name, long_term_retention_database_name, backup_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a long term retention backup.

Parameters

location_name (str) – The location of the database
long_term_retention_server_name (str) – The name of the server
long_term_retention_database_name (str) – The name of the database
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_by_resource_group(resource_group_name, location_name, long_term_retention_server_name, long_term_retention_database_name, backup_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a long term retention backup.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database
long_term_retention_server_name (str) – The name of the server
long_term_retention_database_name (str) – The name of the database
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(location_name, long_term_retention_server_name, long_term_retention_database_name, backup_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a long term retention backup.

Parameters

location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server
long_term_retention_database_name (str) – The name of the database
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

LongTermRetentionBackup or ClientRawResponse if raw=true

Return type

LongTermRetentionBackup or ClientRawResponse

Raises

CloudError

get_by_resource_group(resource_group_name, location_name, long_term_retention_server_name, long_term_retention_database_name, backup_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a long term retention backup.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server
long_term_retention_database_name (str) – The name of the database
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

LongTermRetentionBackup or ClientRawResponse if raw=true

Return type

LongTermRetentionBackup or ClientRawResponse

Raises

CloudError

list_by_database(location_name, long_term_retention_server_name, long_term_retention_database_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all long term retention backups for a database.

Parameters

location_name (str) – The location of the database
long_term_retention_server_name (str) – The name of the server
long_term_retention_database_name (str) – The name of the database
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LongTermRetentionBackup

Return type

LongTermRetentionBackupPaged[LongTermRetentionBackup]

Raises

CloudError

list_by_location(location_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the long term retention backups for a given location.

Parameters

location_name (str) – The location of the database
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LongTermRetentionBackup

Return type

LongTermRetentionBackupPaged[LongTermRetentionBackup]

Raises

CloudError

list_by_resource_group_database(resource_group_name, location_name, long_term_retention_server_name, long_term_retention_database_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all long term retention backups for a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database
long_term_retention_server_name (str) – The name of the server
long_term_retention_database_name (str) – The name of the database
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LongTermRetentionBackup

Return type

LongTermRetentionBackupPaged[LongTermRetentionBackup]

Raises

CloudError

list_by_resource_group_location(resource_group_name, location_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the long term retention backups for a given location.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LongTermRetentionBackup

Return type

LongTermRetentionBackupPaged[LongTermRetentionBackup]

Raises

CloudError

list_by_resource_group_server(resource_group_name, location_name, long_term_retention_server_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the long term retention backups for a given server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database
long_term_retention_server_name (str) – The name of the server
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LongTermRetentionBackup

Return type

LongTermRetentionBackupPaged[LongTermRetentionBackup]

Raises

CloudError

list_by_server(location_name, long_term_retention_server_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the long term retention backups for a given server.

Parameters

location_name (str) – The location of the database
long_term_retention_server_name (str) – The name of the server
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of LongTermRetentionBackup

Return type

LongTermRetentionBackupPaged[LongTermRetentionBackup]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.BackupLongTermRetentionPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

BackupLongTermRetentionPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

policy_name – The policy name. Should always be Default. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Sets a database’s long term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (BackupLongTermRetentionPolicy) – The long term retention policy info.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns BackupLongTermRetentionPolicy or ClientRawResponse<BackupLongTermRetentionPolicy> if raw==True

Return type

AzureOperationPoller[BackupLongTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[BackupLongTermRetentionPolicy]]

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s long term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

BackupLongTermRetentionPolicy or ClientRawResponse if raw=true

Return type

BackupLongTermRetentionPolicy or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s long term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

BackupLongTermRetentionPolicy or ClientRawResponse if raw=true

Return type

BackupLongTermRetentionPolicy or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedBackupShortTermRetentionPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedBackupShortTermRetentionPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

policy_name – The policy name. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, managed_instance_name, database_name, retention_days=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a managed database’s short term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedBackupShortTermRetentionPolicy or ClientRawResponse<ManagedBackupShortTermRetentionPolicy> if raw==True

Return type

AzureOperationPoller[ManagedBackupShortTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[ManagedBackupShortTermRetentionPolicy]]

Raises

CloudError

get(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed database’s short term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedBackupShortTermRetentionPolicy or ClientRawResponse if raw=true

Return type

ManagedBackupShortTermRetentionPolicy or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed database’s short term retention policy list.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedBackupShortTermRetentionPolicy

Return type

ManagedBackupShortTermRetentionPolicyPaged[ManagedBackupShortTermRetentionPolicy]

Raises

CloudError

update(resource_group_name, managed_instance_name, database_name, retention_days=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a managed database’s short term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedBackupShortTermRetentionPolicy or ClientRawResponse<ManagedBackupShortTermRetentionPolicy> if raw==True

Return type

AzureOperationPoller[ManagedBackupShortTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[ManagedBackupShortTermRetentionPolicy]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

policy_name – The policy name. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, managed_instance_name, restorable_dropped_database_id, retention_days=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Sets a database’s long term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedBackupShortTermRetentionPolicy or ClientRawResponse<ManagedBackupShortTermRetentionPolicy> if raw==True

Return type

AzureOperationPoller[ManagedBackupShortTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[ManagedBackupShortTermRetentionPolicy]]

Raises

CloudError

get(resource_group_name, managed_instance_name, restorable_dropped_database_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a dropped database’s short term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedBackupShortTermRetentionPolicy or ClientRawResponse if raw=true

Return type

ManagedBackupShortTermRetentionPolicy or ClientRawResponse

Raises

CloudError

list_by_restorable_dropped_database(resource_group_name, managed_instance_name, restorable_dropped_database_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a dropped database’s short term retention policy list.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedBackupShortTermRetentionPolicy

Return type

ManagedBackupShortTermRetentionPolicyPaged[ManagedBackupShortTermRetentionPolicy]

Raises

CloudError

update(resource_group_name, managed_instance_name, restorable_dropped_database_id, retention_days=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Sets a database’s long term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedBackupShortTermRetentionPolicy or ClientRawResponse<ManagedBackupShortTermRetentionPolicy> if raw==True

Return type

AzureOperationPoller[ManagedBackupShortTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[ManagedBackupShortTermRetentionPolicy]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerAutomaticTuningOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerAutomaticTuningOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Retrieves server automatic tuning options.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerAutomaticTuning or ClientRawResponse if raw=true

Return type

ServerAutomaticTuning or ClientRawResponse

Raises

CloudError

update(resource_group_name, server_name, desired_state=None, options=None, custom_headers=None, raw=False, **operation_config)[source]¶

Update automatic tuning options on server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
desired_state (str or AutomaticTuningServerMode) – Automatic tuning desired state. Possible values include: ‘Custom’, ‘Auto’, ‘Unspecified’
options (dict[str, AutomaticTuningServerOptions]) – Automatic tuning options definition.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerAutomaticTuning or ClientRawResponse if raw=true

Return type

ServerAutomaticTuning or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerDnsAliasesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerDnsAliasesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

acquire(resource_group_name, server_name, dns_alias_name, old_server_dns_alias_id=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Acquires server DNS alias from another server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server dns alias.
old_server_dns_alias_id (str) – The id of the server alias that will be acquired to point to this server instead.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

create_or_update(resource_group_name, server_name, dns_alias_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a server dns alias.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server DNS alias.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServerDnsAlias or ClientRawResponse<ServerDnsAlias> if raw==True

Return type

AzureOperationPoller[ServerDnsAlias] or AzureOperationPoller[ClientRawResponse[ServerDnsAlias]]

Raises

CloudError

delete(resource_group_name, server_name, dns_alias_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the server DNS alias with the given name.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server DNS alias.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, dns_alias_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a server DNS alias.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server DNS alias.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerDnsAlias or ClientRawResponse if raw=true

Return type

ServerDnsAlias or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of server DNS aliases for a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerDnsAlias

Return type

ServerDnsAliasPaged[ServerDnsAlias]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerSecurityAlertPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerSecurityAlertPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

security_alert_policy_name – The name of the security alert policy. Constant value: “Default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a threat detection policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ServerSecurityAlertPolicy) – The server security alert policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServerSecurityAlertPolicy or ClientRawResponse<ServerSecurityAlertPolicy> if raw==True

Return type

AzureOperationPoller[ServerSecurityAlertPolicy] or AzureOperationPoller[ClientRawResponse[ServerSecurityAlertPolicy]]

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get a server’s security alert policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerSecurityAlertPolicy or ClientRawResponse if raw=true

Return type

ServerSecurityAlertPolicy or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the server’s threat detection policies.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerSecurityAlertPolicy

Return type

ServerSecurityAlertPolicyPaged[ServerSecurityAlertPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.RestorableDroppedManagedDatabasesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RestorableDroppedManagedDatabasesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

get(resource_group_name, managed_instance_name, restorable_dropped_database_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a restorable dropped managed database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RestorableDroppedManagedDatabase or ClientRawResponse if raw=true

Return type

RestorableDroppedManagedDatabase or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of restorable dropped managed databases.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RestorableDroppedManagedDatabase

Return type

RestorableDroppedManagedDatabasePaged[RestorableDroppedManagedDatabase]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.RestorePointsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RestorePointsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create(resource_group_name, server_name, database_name, restore_point_label, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a restore point for a data warehouse.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
restore_point_label (str) – The restore point label to apply
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RestorePoint or ClientRawResponse<RestorePoint> if raw==True

Return type

AzureOperationPoller[RestorePoint] or AzureOperationPoller[ClientRawResponse[RestorePoint]]

Raises

CloudError

delete(resource_group_name, server_name, database_name, restore_point_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes a restore point.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
restore_point_name (str) – The name of the restore point.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, restore_point_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a restore point.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
restore_point_name (str) – The name of the restore point.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RestorePoint or ClientRawResponse if raw=true

Return type

RestorePoint or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of database restore points.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RestorePoint

Return type

RestorePointPaged[RestorePoint]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedDatabaseSecurityAlertPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedDatabaseSecurityAlertPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

security_alert_policy_name – The name of the security alert policy. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, managed_instance_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a database’s security alert policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the security alert policy is defined.
parameters (ManagedDatabaseSecurityAlertPolicy) – The database security alert policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedDatabaseSecurityAlertPolicy or ClientRawResponse if raw=true

Return type

ManagedDatabaseSecurityAlertPolicy or ClientRawResponse

Raises

CloudError

get(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed database’s security alert policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the security alert policy is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedDatabaseSecurityAlertPolicy or ClientRawResponse if raw=true

Return type

ManagedDatabaseSecurityAlertPolicy or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of managed database’s security alert policies.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the security alert policies are defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedDatabaseSecurityAlertPolicy

Return type

ManagedDatabaseSecurityAlertPolicyPaged[ManagedDatabaseSecurityAlertPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedServerSecurityAlertPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedServerSecurityAlertPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

security_alert_policy_name – The name of the security alert policy. Constant value: “Default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, managed_instance_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a threat detection policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (ManagedServerSecurityAlertPolicy) – The managed server security alert policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedServerSecurityAlertPolicy or ClientRawResponse<ManagedServerSecurityAlertPolicy> if raw==True

Return type

AzureOperationPoller[ManagedServerSecurityAlertPolicy] or AzureOperationPoller[ClientRawResponse[ManagedServerSecurityAlertPolicy]]

Raises

CloudError

get(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get a managed server’s threat detection policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedServerSecurityAlertPolicy or ClientRawResponse if raw=true

Return type

ManagedServerSecurityAlertPolicy or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Get the managed server’s threat detection policies.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedServerSecurityAlertPolicy

Return type

ManagedServerSecurityAlertPolicyPaged[ManagedServerSecurityAlertPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.SensitivityLabelsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SensitivityLabelsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.

create_or_update(resource_group_name, server_name, database_name, schema_name, table_name, column_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates the sensitivity label of a given column.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
parameters (SensitivityLabel) – The column sensitivity label resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SensitivityLabel or ClientRawResponse if raw=true

Return type

SensitivityLabel or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, database_name, schema_name, table_name, column_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes the sensitivity label of a given column.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

disable_recommendation(resource_group_name, server_name, database_name, schema_name, table_name, column_name, custom_headers=None, raw=False, **operation_config)[source]¶

Disables sensitivity recommendations on a given column.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

enable_recommendation(resource_group_name, server_name, database_name, schema_name, table_name, column_name, custom_headers=None, raw=False, **operation_config)[source]¶

Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns).

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, schema_name, table_name, column_name, sensitivity_label_source, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the sensitivity label of a given column.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
sensitivity_label_source (str or SensitivityLabelSource) – The source of the sensitivity label. Possible values include: ‘current’, ‘recommended’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SensitivityLabel or ClientRawResponse if raw=true

Return type

SensitivityLabel or ClientRawResponse

Raises

CloudError

list_current_by_database(resource_group_name, server_name, database_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the sensitivity labels of a given database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
filter (str) – An OData filter expression that filters elements in the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SensitivityLabel

Return type

SensitivityLabelPaged[SensitivityLabel]

Raises

CloudError

list_recommended_by_database(resource_group_name, server_name, database_name, include_disabled_recommendations=None, skip_token=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the sensitivity labels of a given database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
include_disabled_recommendations (bool) – Specifies whether to include disabled recommendations or not.
skip_token (str) –
filter (str) – An OData filter expression that filters elements in the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SensitivityLabel

Return type

SensitivityLabelPaged[SensitivityLabel]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstanceAdministratorsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstanceAdministratorsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
administrator_name – The administrator name. Constant value: “ActiveDirectory”.

create_or_update(resource_group_name, managed_instance_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a managed instance administrator.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (ManagedInstanceAdministrator) – The requested administrator parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedInstanceAdministrator or ClientRawResponse<ManagedInstanceAdministrator> if raw==True

Return type

AzureOperationPoller[ManagedInstanceAdministrator] or AzureOperationPoller[ClientRawResponse[ManagedInstanceAdministrator]]

Raises

CloudError

delete(resource_group_name, managed_instance_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a managed instance administrator.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed instance administrator.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceAdministrator or ClientRawResponse if raw=true

Return type

ManagedInstanceAdministrator or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of managed instance administrators.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceAdministrator

Return type

ManagedInstanceAdministratorPaged[ManagedInstanceAdministrator]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabaseOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

cancel(resource_group_name, server_name, database_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶

Cancels the asynchronous operation on the database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
operation_id (str) – The operation identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of operations performed on the database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DatabaseOperation

Return type

DatabaseOperationPaged[DatabaseOperation]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ElasticPoolOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ElasticPoolOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

cancel(resource_group_name, server_name, elastic_pool_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶

Cancels the asynchronous operation on the elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) –
operation_id (str) – The operation identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

list_by_elastic_pool(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of operations performed on the elastic pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ElasticPoolOperation

Return type

ElasticPoolOperationPaged[ElasticPoolOperation]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.DatabaseVulnerabilityAssessmentScansOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DatabaseVulnerabilityAssessmentScansOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

export(resource_group_name, server_name, database_name, scan_id, custom_headers=None, raw=False, **operation_config)[source]¶

Convert an existing scan result to a human readable format. If already exists nothing happens.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the scanned database.
scan_id (str) – The vulnerability assessment scan Id.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessmentScansExport or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessmentScansExport or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, database_name, scan_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a vulnerability assessment scan record of a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VulnerabilityAssessmentScanRecord or ClientRawResponse if raw=true

Return type

VulnerabilityAssessmentScanRecord or ClientRawResponse

Raises

CloudError

initiate_scan(resource_group_name, server_name, database_name, scan_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Executes a Vulnerability Assessment database scan.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the vulnerability assessment scans of a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VulnerabilityAssessmentScanRecord

Return type

VulnerabilityAssessmentScanRecordPaged[VulnerabilityAssessmentScanRecord]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedDatabaseVulnerabilityAssessmentRuleBaselinesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedDatabaseVulnerabilityAssessmentRuleBaselinesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

create_or_update(resource_group_name, managed_instance_name, database_name, rule_id, baseline_name, baseline_results, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates a database’s vulnerability assessment rule baseline.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). Possible values include: ‘master’, ‘default’
baseline_results (list[DatabaseVulnerabilityAssessmentRuleBaselineItem]) – The rule baseline result
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse

Raises

CloudError

delete(resource_group_name, managed_instance_name, database_name, rule_id, baseline_name, custom_headers=None, raw=False, **operation_config)[source]¶

Removes the database’s vulnerability assessment rule baseline.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). Possible values include: ‘master’, ‘default’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, managed_instance_name, database_name, rule_id, baseline_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s vulnerability assessment rule baseline.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule). Possible values include: ‘master’, ‘default’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedDatabaseVulnerabilityAssessmentScansOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedDatabaseVulnerabilityAssessmentScansOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

export(resource_group_name, managed_instance_name, database_name, scan_id, custom_headers=None, raw=False, **operation_config)[source]¶

Convert an existing scan result to a human readable format. If already exists nothing happens.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the scanned database.
scan_id (str) – The vulnerability assessment scan Id.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessmentScansExport or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessmentScansExport or ClientRawResponse

Raises

CloudError

get(resource_group_name, managed_instance_name, database_name, scan_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a vulnerability assessment scan record of a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

VulnerabilityAssessmentScanRecord or ClientRawResponse if raw=true

Return type

VulnerabilityAssessmentScanRecord or ClientRawResponse

Raises

CloudError

initiate_scan(resource_group_name, managed_instance_name, database_name, scan_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Executes a Vulnerability Assessment database scan.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

list_by_database(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the vulnerability assessment scans of a database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of VulnerabilityAssessmentScanRecord

Return type

VulnerabilityAssessmentScanRecordPaged[VulnerabilityAssessmentScanRecord]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedDatabaseVulnerabilityAssessmentsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedDatabaseVulnerabilityAssessmentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

create_or_update(resource_group_name, managed_instance_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates the database’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
parameters (DatabaseVulnerabilityAssessment) – The requested resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessment or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessment or ClientRawResponse

Raises

CloudError

delete(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Removes the database’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the database’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

DatabaseVulnerabilityAssessment or ClientRawResponse if raw=true

Return type

DatabaseVulnerabilityAssessment or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the vulnerability assessments of a managed database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of DatabaseVulnerabilityAssessment

Return type

DatabaseVulnerabilityAssessmentPaged[DatabaseVulnerabilityAssessment]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.InstanceFailoverGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

InstanceFailoverGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

create_or_update(resource_group_name, location_name, failover_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a failover group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
parameters (InstanceFailoverGroup) – The failover group parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns InstanceFailoverGroup or ClientRawResponse<InstanceFailoverGroup> if raw==True

Return type

AzureOperationPoller[InstanceFailoverGroup] or AzureOperationPoller[ClientRawResponse[InstanceFailoverGroup]]

Raises

CloudError

delete(resource_group_name, location_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a failover group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

failover(resource_group_name, location_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Fails over from the current primary managed instance to this managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns InstanceFailoverGroup or ClientRawResponse<InstanceFailoverGroup> if raw==True

Return type

AzureOperationPoller[InstanceFailoverGroup] or AzureOperationPoller[ClientRawResponse[InstanceFailoverGroup]]

Raises

CloudError

force_failover_allow_data_loss(resource_group_name, location_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns InstanceFailoverGroup or ClientRawResponse<InstanceFailoverGroup> if raw==True

Return type

AzureOperationPoller[InstanceFailoverGroup] or AzureOperationPoller[ClientRawResponse[InstanceFailoverGroup]]

Raises

CloudError

get(resource_group_name, location_name, failover_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a failover group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

InstanceFailoverGroup or ClientRawResponse if raw=true

Return type

InstanceFailoverGroup or ClientRawResponse

Raises

CloudError

list_by_location(resource_group_name, location_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the failover groups in a location.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of InstanceFailoverGroup

Return type

InstanceFailoverGroupPaged[InstanceFailoverGroup]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.TdeCertificatesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TdeCertificatesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

create(resource_group_name, server_name, private_blob, cert_password=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a TDE certificate for a given server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
private_blob (str) – The base64 encoded certificate private blob.
cert_password (str) – The certificate password.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstanceTdeCertificatesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstanceTdeCertificatesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

create(resource_group_name, managed_instance_name, private_blob, cert_password=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a TDE certificate for a given server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
private_blob (str) – The base64 encoded certificate private blob.
cert_password (str) – The certificate password.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstanceKeysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstanceKeysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

create_or_update(resource_group_name, managed_instance_name, key_name, server_key_type, uri=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a managed instance key.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
key_name (str) – The name of the managed instance key to be operated on (updated or created).
server_key_type (str or ServerKeyType) – The key type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: ‘ServiceManaged’, ‘AzureKeyVault’
uri (str) – The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedInstanceKey or ClientRawResponse<ManagedInstanceKey> if raw==True

Return type

AzureOperationPoller[ManagedInstanceKey] or AzureOperationPoller[ClientRawResponse[ManagedInstanceKey]]

Raises

CloudError

delete(resource_group_name, managed_instance_name, key_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the managed instance key with the given name.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
key_name (str) – The name of the managed instance key to be deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, managed_instance_name, key_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed instance key.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
key_name (str) – The name of the managed instance key to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceKey or ClientRawResponse if raw=true

Return type

ManagedInstanceKey or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of managed instance keys.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
filter (str) – An OData filter expression that filters elements in the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceKey

Return type

ManagedInstanceKeyPaged[ManagedInstanceKey]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstanceEncryptionProtectorsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstanceEncryptionProtectorsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

encryption_protector_name – The name of the encryption protector to be updated. Constant value: “current”.
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

create_or_update(resource_group_name, managed_instance_name, server_key_type, server_key_name=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an existing encryption protector.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
server_key_type (str or ServerKeyType) – The encryption protector type like ‘ServiceManaged’, ‘AzureKeyVault’. Possible values include: ‘ServiceManaged’, ‘AzureKeyVault’
server_key_name (str) – The name of the managed instance key.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedInstanceEncryptionProtector or ClientRawResponse<ManagedInstanceEncryptionProtector> if raw==True

Return type

AzureOperationPoller[ManagedInstanceEncryptionProtector] or AzureOperationPoller[ClientRawResponse[ManagedInstanceEncryptionProtector]]

Raises

CloudError

get(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed instance encryption protector.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceEncryptionProtector or ClientRawResponse if raw=true

Return type

ManagedInstanceEncryptionProtector or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of managed instance encryption protectors.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceEncryptionProtector

Return type

ManagedInstanceEncryptionProtectorPaged[ManagedInstanceEncryptionProtector]

Raises

CloudError

revalidate(resource_group_name, managed_instance_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Revalidates an existing encryption protector.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.RecoverableManagedDatabasesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RecoverableManagedDatabasesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.

get(resource_group_name, managed_instance_name, recoverable_database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a recoverable managed database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
recoverable_database_name (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

RecoverableManagedDatabase or ClientRawResponse if raw=true

Return type

RecoverableManagedDatabase or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of recoverable managed databases.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecoverableManagedDatabase

Return type

RecoverableManagedDatabasePaged[RecoverableManagedDatabase]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstanceVulnerabilityAssessmentsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstanceVulnerabilityAssessmentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

create_or_update(resource_group_name, managed_instance_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates the managed instance’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined.
parameters (ManagedInstanceVulnerabilityAssessment) – The requested resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceVulnerabilityAssessment or ClientRawResponse if raw=true

Return type

ManagedInstanceVulnerabilityAssessment or ClientRawResponse

Raises

CloudError

delete(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Removes the managed instance’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the managed instance’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceVulnerabilityAssessment or ClientRawResponse if raw=true

Return type

ManagedInstanceVulnerabilityAssessment or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the managed instance’s vulnerability assessment policies.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance for which the vulnerability assessments is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceVulnerabilityAssessment

Return type

ManagedInstanceVulnerabilityAssessmentPaged[ManagedInstanceVulnerabilityAssessment]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerVulnerabilityAssessmentsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerVulnerabilityAssessmentsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

create_or_update(resource_group_name, server_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates the server’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server for which the vulnerability assessment is defined.
parameters (ServerVulnerabilityAssessment) – The requested resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerVulnerabilityAssessment or ClientRawResponse if raw=true

Return type

ServerVulnerabilityAssessment or ClientRawResponse

Raises

CloudError

delete(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Removes the server’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the server’s vulnerability assessment.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerVulnerabilityAssessment or ClientRawResponse if raw=true

Return type

ServerVulnerabilityAssessment or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the vulnerability assessment policies associated with a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerVulnerabilityAssessment

Return type

ServerVulnerabilityAssessmentPaged[ServerVulnerabilityAssessment]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedDatabaseSensitivityLabelsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedDatabaseSensitivityLabelsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

create_or_update(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶

Creates or updates the sensitivity label of a given column.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
parameters (SensitivityLabel) – The column sensitivity label resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SensitivityLabel or ClientRawResponse if raw=true

Return type

SensitivityLabel or ClientRawResponse

Raises

CloudError

delete(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers=None, raw=False, **operation_config)[source]¶

Deletes the sensitivity label of a given column.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

disable_recommendation(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers=None, raw=False, **operation_config)[source]¶

Disables sensitivity recommendations on a given column.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

enable_recommendation(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, custom_headers=None, raw=False, **operation_config)[source]¶

Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns).

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, managed_instance_name, database_name, schema_name, table_name, column_name, sensitivity_label_source, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the sensitivity label of a given column.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
sensitivity_label_source (str or SensitivityLabelSource) – The source of the sensitivity label. Possible values include: ‘current’, ‘recommended’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SensitivityLabel or ClientRawResponse if raw=true

Return type

SensitivityLabel or ClientRawResponse

Raises

CloudError

list_current_by_database(resource_group_name, managed_instance_name, database_name, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the sensitivity labels of a given database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
filter (str) – An OData filter expression that filters elements in the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SensitivityLabel

Return type

SensitivityLabelPaged[SensitivityLabel]

Raises

CloudError

list_recommended_by_database(resource_group_name, managed_instance_name, database_name, include_disabled_recommendations=None, skip_token=None, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the sensitivity labels of a given database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
include_disabled_recommendations (bool) – Specifies whether to include disabled recommendations or not.
skip_token (str) –
filter (str) – An OData filter expression that filters elements in the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SensitivityLabel

Return type

SensitivityLabelPaged[SensitivityLabel]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.InstancePoolsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

InstancePoolsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

create_or_update(resource_group_name, instance_pool_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an instance pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The name of the instance pool to be created or updated.
parameters (InstancePool) – The requested instance pool resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns InstancePool or ClientRawResponse<InstancePool> if raw==True

Return type

AzureOperationPoller[InstancePool] or AzureOperationPoller[ClientRawResponse[InstancePool]]

Raises

CloudError

delete(resource_group_name, instance_pool_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an instance pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The name of the instance pool to be deleted
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, instance_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets an instance pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The name of the instance pool to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

InstancePool or ClientRawResponse if raw=true

Return type

InstancePool or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of all instance pools in the subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of InstancePool

Return type

InstancePoolPaged[InstancePool]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of instance pools in the resource group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of InstancePool

Return type

InstancePoolPaged[InstancePool]

Raises

CloudError

update(resource_group_name, instance_pool_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an instance pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The name of the instance pool to be updated.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns InstancePool or ClientRawResponse<InstancePool> if raw==True

Return type

AzureOperationPoller[InstancePool] or AzureOperationPoller[ClientRawResponse[InstancePool]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.UsagesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

UsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

list_by_instance_pool(resource_group_name, instance_pool_name, expand_children=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all instance pool usage metrics.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The name of the instance pool to be retrieved.
expand_children (bool) – Optional request parameter to include managed instance usages within the instance pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Usage

Return type

UsagePaged[Usage]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.PrivateEndpointConnectionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PrivateEndpointConnectionsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

create_or_update(resource_group_name, server_name, private_endpoint_connection_name, private_endpoint=None, private_link_service_connection_state=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Approve or reject a private endpoint connection with a given name.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
private_endpoint_connection_name (str) –
private_endpoint (PrivateEndpointProperty) – Private endpoint which the connection belongs to.
private_link_service_connection_state (PrivateLinkServiceConnectionStateProperty) – Connection state of the private endpoint connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PrivateEndpointConnection or ClientRawResponse<PrivateEndpointConnection> if raw==True

Return type

AzureOperationPoller[PrivateEndpointConnection] or AzureOperationPoller[ClientRawResponse[PrivateEndpointConnection]]

Raises

CloudError

delete(resource_group_name, server_name, private_endpoint_connection_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a private endpoint connection with a given name.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
private_endpoint_connection_name (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, private_endpoint_connection_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a private endpoint connection.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
private_endpoint_connection_name (str) – The name of the private endpoint connection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

PrivateEndpointConnection or ClientRawResponse if raw=true

Return type

PrivateEndpointConnection or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets all private endpoint connections on a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PrivateEndpointConnection

Return type

PrivateEndpointConnectionPaged[PrivateEndpointConnection]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.PrivateLinkResourcesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PrivateLinkResourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

get(resource_group_name, server_name, group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a private link resource for SQL server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
group_name (str) – The name of the private link resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

PrivateLinkResource or ClientRawResponse if raw=true

Return type

PrivateLinkResource or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the private link resources for SQL server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of PrivateLinkResource

Return type

PrivateLinkResourcePaged[PrivateLinkResource]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

check_name_availability(name, custom_headers=None, raw=False, **operation_config)[source]¶

Determines whether a resource can be created with the specified name.

Parameters

name (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

CheckNameAvailabilityResponse or ClientRawResponse if raw=true

Return type

CheckNameAvailabilityResponse or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (Server) – The requested server resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Server or ClientRawResponse<Server> if raw==True

Return type

AzureOperationPoller[Server] or AzureOperationPoller[ClientRawResponse[Server]]

Raises

CloudError

delete(resource_group_name, server_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

Server or ClientRawResponse if raw=true

Return type

Server or ClientRawResponse

Raises

CloudError

import_database(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Imports a bacpac into a new database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ImportNewDatabaseDefinition) – The database import request parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ImportExportOperationResult or ClientRawResponse<ImportExportOperationResult> if raw==True

Return type

AzureOperationPoller[ImportExportOperationResult] or AzureOperationPoller[ClientRawResponse[ImportExportOperationResult]]

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of all servers in the subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Server

Return type

ServerPaged[Server]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of servers in a resource groups.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of Server

Return type

ServerPaged[Server]

Raises

CloudError

update(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ServerUpdate) – The requested server resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Server or ClientRawResponse<Server> if raw==True

Return type

AzureOperationPoller[Server] or AzureOperationPoller[ClientRawResponse[Server]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.CapabilitiesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CapabilitiesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

list_by_location(location_name, include=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the subscription capabilities available for the specified location.

Parameters

location_name (str) – The location name whose capabilities are retrieved.
include (str or CapabilityGroup) – If specified, restricts the response to only include the selected item. Possible values include: ‘supportedEditions’, ‘supportedElasticPoolEditions’, ‘supportedManagedInstanceVersions’, ‘supportedInstancePoolEditions’, ‘supportedManagedInstanceEditions’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

LocationCapabilities or ClientRawResponse if raw=true

Return type

LocationCapabilities or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.LongTermRetentionManagedInstanceBackupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LongTermRetentionManagedInstanceBackupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

delete(location_name, managed_instance_name, database_name, backup_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a long term retention backup.

Parameters

location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

delete_by_resource_group(resource_group_name, location_name, managed_instance_name, database_name, backup_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a long term retention backup.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(location_name, managed_instance_name, database_name, backup_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a long term retention backup for a managed database.

Parameters

location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceLongTermRetentionBackup or ClientRawResponse if raw=true

Return type

ManagedInstanceLongTermRetentionBackup or ClientRawResponse

Raises

CloudError

get_by_resource_group(resource_group_name, location_name, managed_instance_name, database_name, backup_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a long term retention backup for a managed database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceLongTermRetentionBackup or ClientRawResponse if raw=true

Return type

ManagedInstanceLongTermRetentionBackup or ClientRawResponse

Raises

CloudError

list_by_database(location_name, managed_instance_name, database_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all long term retention backups for a managed database.

Parameters

location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or DatabaseState1) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceLongTermRetentionBackup

Return type

ManagedInstanceLongTermRetentionBackupPaged[ManagedInstanceLongTermRetentionBackup]

Raises

CloudError

list_by_instance(location_name, managed_instance_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the long term retention backups for a given managed instance.

Parameters

location_name (str) – The location of the database
managed_instance_name (str) – The name of the managed instance.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or DatabaseState2) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceLongTermRetentionBackup

Return type

ManagedInstanceLongTermRetentionBackupPaged[ManagedInstanceLongTermRetentionBackup]

Raises

CloudError

list_by_location(location_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the long term retention backups for managed databases in a given location.

Parameters

location_name (str) – The location of the database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or DatabaseState3) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceLongTermRetentionBackup

Return type

ManagedInstanceLongTermRetentionBackupPaged[ManagedInstanceLongTermRetentionBackup]

Raises

CloudError

list_by_resource_group_database(resource_group_name, location_name, managed_instance_name, database_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists all long term retention backups for a managed database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or DatabaseState4) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceLongTermRetentionBackup

Return type

ManagedInstanceLongTermRetentionBackupPaged[ManagedInstanceLongTermRetentionBackup]

Raises

CloudError

list_by_resource_group_instance(resource_group_name, location_name, managed_instance_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the long term retention backups for a given managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or DatabaseState5) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceLongTermRetentionBackup

Return type

ManagedInstanceLongTermRetentionBackupPaged[ManagedInstanceLongTermRetentionBackup]

Raises

CloudError

list_by_resource_group_location(resource_group_name, location_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶

Lists the long term retention backups for managed databases in a given location.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or DatabaseState6) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceLongTermRetentionBackup

Return type

ManagedInstanceLongTermRetentionBackupPaged[ManagedInstanceLongTermRetentionBackup]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstanceLongTermRetentionPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstanceLongTermRetentionPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

policy_name – The policy name. Should always be Default. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2018-06-01-preview”.

create_or_update(resource_group_name, managed_instance_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Sets a managed database’s long term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
parameters (ManagedInstanceLongTermRetentionPolicy) – The long term retention policy info.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedInstanceLongTermRetentionPolicy or ClientRawResponse<ManagedInstanceLongTermRetentionPolicy> if raw==True

Return type

AzureOperationPoller[ManagedInstanceLongTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[ManagedInstanceLongTermRetentionPolicy]]

Raises

CloudError

get(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed database’s long term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceLongTermRetentionPolicy or ClientRawResponse if raw=true

Return type

ManagedInstanceLongTermRetentionPolicy or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s long term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceLongTermRetentionPolicy

Return type

ManagedInstanceLongTermRetentionPolicyPaged[ManagedInstanceLongTermRetentionPolicy]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.WorkloadGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

WorkloadGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2019-06-01-preview”.

create_or_update(resource_group_name, server_name, database_name, workload_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a workload group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group.
parameters (WorkloadGroup) – The requested workload group state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns WorkloadGroup or ClientRawResponse<WorkloadGroup> if raw==True

Return type

AzureOperationPoller[WorkloadGroup] or AzureOperationPoller[ClientRawResponse[WorkloadGroup]]

Raises

CloudError

delete(resource_group_name, server_name, database_name, workload_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a workload group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group to delete.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, database_name, workload_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a workload group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

WorkloadGroup or ClientRawResponse if raw=true

Return type

WorkloadGroup or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the list of workload groups.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of WorkloadGroup

Return type

WorkloadGroupPaged[WorkloadGroup]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.WorkloadClassifiersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

WorkloadClassifiersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2019-06-01-preview”.

create_or_update(resource_group_name, server_name, database_name, workload_group_name, workload_classifier_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a workload classifier.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group from which to receive the classifier from.
workload_classifier_name (str) – The name of the workload classifier to create/update.
parameters (WorkloadClassifier) – The properties of the workload classifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns WorkloadClassifier or ClientRawResponse<WorkloadClassifier> if raw==True

Return type

AzureOperationPoller[WorkloadClassifier] or AzureOperationPoller[ClientRawResponse[WorkloadClassifier]]

Raises

CloudError

delete(resource_group_name, server_name, database_name, workload_group_name, workload_classifier_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a workload classifier.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group from which to receive the classifier from.
workload_classifier_name (str) – The name of the workload classifier to delete.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, database_name, workload_group_name, workload_classifier_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a workload classifier.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group from which to receive the classifier from.
workload_classifier_name (str) – The name of the workload classifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

WorkloadClassifier or ClientRawResponse if raw=true

Return type

WorkloadClassifier or ClientRawResponse

Raises

CloudError

list_by_workload_group(resource_group_name, server_name, database_name, workload_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets the list of workload classifiers for a workload group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group from which to receive the classifiers from.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of WorkloadClassifier

Return type

WorkloadClassifierPaged[WorkloadClassifier]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstanceOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstanceOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2019-06-01-preview”.

cancel(resource_group_name, managed_instance_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶

Cancels the asynchronous operation on the managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
operation_id (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, managed_instance_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a management operation on a managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
operation_id (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceOperation or ClientRawResponse if raw=true

Return type

ManagedInstanceOperation or ClientRawResponse

Raises

CloudError

list_by_managed_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of operations performed on the managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceOperation

Return type

ManagedInstanceOperationPaged[ManagedInstanceOperation]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerAzureADAdministratorsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerAzureADAdministratorsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2019-06-01-preview”.
administrator_name – The name of server active directory administrator. Constant value: “ActiveDirectory”.

create_or_update(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates an existing Azure Active Directory administrator.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ServerAzureADAdministrator) – The requested Azure Active Directory administrator Resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServerAzureADAdministrator or ClientRawResponse<ServerAzureADAdministrator> if raw==True

Return type

AzureOperationPoller[ServerAzureADAdministrator] or AzureOperationPoller[ClientRawResponse[ServerAzureADAdministrator]]

Raises

CloudError

delete(resource_group_name, server_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes the Azure Active Directory administrator with the given name.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a Azure Active Directory administrator.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerAzureADAdministrator or ClientRawResponse if raw=true

Return type

ServerAzureADAdministrator or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of Azure Active Directory administrators in a server.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerAzureADAdministrator

Return type

ServerAzureADAdministratorPaged[ServerAzureADAdministrator]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.SyncGroupsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SyncGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2019-06-01-preview”.

cancel_sync(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Cancels a sync group synchronization.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, server_name, database_name, sync_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a sync group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
parameters (SyncGroup) – The requested sync group resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SyncGroup or ClientRawResponse<SyncGroup> if raw==True

Return type

AzureOperationPoller[SyncGroup] or AzureOperationPoller[ClientRawResponse[SyncGroup]]

Raises

CloudError

delete(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a sync group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a sync group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SyncGroup or ClientRawResponse if raw=true

Return type

SyncGroup or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists sync groups under a hub database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SyncGroup

Return type

SyncGroupPaged[SyncGroup]

Raises

CloudError

list_hub_schemas(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a collection of hub database schemas.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SyncFullSchemaProperties

Return type

SyncFullSchemaPropertiesPaged[SyncFullSchemaProperties]

Raises

CloudError

list_logs(resource_group_name, server_name, database_name, sync_group_name, start_time, end_time, type, continuation_token=None, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a collection of sync group logs.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
start_time (str) – Get logs generated after this time.
end_time (str) – Get logs generated before this time.
type (str) – The types of logs to retrieve. Possible values include: ‘All’, ‘Error’, ‘Warning’, ‘Success’
continuation_token (str) – The continuation token for this operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SyncGroupLogProperties

Return type

SyncGroupLogPropertiesPaged[SyncGroupLogProperties]

Raises

CloudError

list_sync_database_ids(location_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a collection of sync database ids.

Parameters

location_name (str) – The name of the region where the resource is located.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SyncDatabaseIdProperties

Return type

SyncDatabaseIdPropertiesPaged[SyncDatabaseIdProperties]

Raises

CloudError

refresh_hub_schema(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Refreshes a hub database schema.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

trigger_sync(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Triggers a sync group synchronization.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

update(resource_group_name, server_name, database_name, sync_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a sync group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
parameters (SyncGroup) – The requested sync group resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SyncGroup or ClientRawResponse<SyncGroup> if raw==True

Return type

AzureOperationPoller[SyncGroup] or AzureOperationPoller[ClientRawResponse[SyncGroup]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.SyncMembersOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SyncMembersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2019-06-01-preview”.

create_or_update(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a sync member.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
parameters (SyncMember) – The requested sync member resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SyncMember or ClientRawResponse<SyncMember> if raw==True

Return type

AzureOperationPoller[SyncMember] or AzureOperationPoller[ClientRawResponse[SyncMember]]

Raises

CloudError

delete(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a sync member.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a sync member.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

SyncMember or ClientRawResponse if raw=true

Return type

SyncMember or ClientRawResponse

Raises

CloudError

list_by_sync_group(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Lists sync members in the given sync group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SyncMember

Return type

SyncMemberPaged[SyncMember]

Raises

CloudError

list_member_schemas(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a sync member database schema.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of SyncFullSchemaProperties

Return type

SyncFullSchemaPropertiesPaged[SyncFullSchemaProperties]

Raises

CloudError

refresh_member_schema(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Refreshes a sync member database schema.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

update(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an existing sync member.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
parameters (SyncMember) – The requested sync member resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns SyncMember or ClientRawResponse<SyncMember> if raw==True

Return type

AzureOperationPoller[SyncMember] or AzureOperationPoller[ClientRawResponse[SyncMember]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstancesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstancesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name, managed_instance_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates or updates a managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (ManagedInstance) – The requested managed instance resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedInstance or ClientRawResponse<ManagedInstance> if raw==True

Return type

AzureOperationPoller[ManagedInstance] or AzureOperationPoller[ClientRawResponse[ManagedInstance]]

Raises

CloudError

delete(resource_group_name, managed_instance_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

failover(resource_group_name, managed_instance_name, replica_type=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Failovers a managed instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
replica_type (str or ReplicaType) – The type of replica to be failed over. Possible values include: ‘Primary’, ‘ReadableSecondary’
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstance or ClientRawResponse if raw=true

Return type

ManagedInstance or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of all managed instances in the subscription.

Parameters

custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstance

Return type

ManagedInstancePaged[ManagedInstance]

Raises

CloudError

list_by_instance_pool(resource_group_name, instance_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of all managed instances in an instance pool.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The instance pool name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstance

Return type

ManagedInstancePaged[ManagedInstance]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of managed instances in a resource group.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstance

Return type

ManagedInstancePaged[ManagedInstance]

Raises

CloudError

update(resource_group_name, managed_instance_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a managed instance.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (ManagedInstanceUpdate) – The requested managed instance resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedInstance or ClientRawResponse<ManagedInstance> if raw==True

Return type

AzureOperationPoller[ManagedInstance] or AzureOperationPoller[ClientRawResponse[ManagedInstance]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.BackupShortTermRetentionPoliciesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

BackupShortTermRetentionPoliciesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

policy_name – The policy name. Should always be “default”. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2020-02-02-preview”.

create_or_update(resource_group_name, server_name, database_name, retention_days=None, diff_backup_interval_in_hours=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a database’s short term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
diff_backup_interval_in_hours (int) – The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns BackupShortTermRetentionPolicy or ClientRawResponse<BackupShortTermRetentionPolicy> if raw==True

Return type

AzureOperationPoller[BackupShortTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[BackupShortTermRetentionPolicy]]

Raises

CloudError

get(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s short term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

BackupShortTermRetentionPolicy or ClientRawResponse if raw=true

Return type

BackupShortTermRetentionPolicy or ClientRawResponse

Raises

CloudError

list_by_database(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a database’s short term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of BackupShortTermRetentionPolicy

Return type

BackupShortTermRetentionPolicyPaged[BackupShortTermRetentionPolicy]

Raises

CloudError

update(resource_group_name, server_name, database_name, retention_days=None, diff_backup_interval_in_hours=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates a database’s short term retention policy.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
diff_backup_interval_in_hours (int) – The differential backup interval in hours. This is how many interval hours between each differential backup will be supported. This is only applicable to live databases but not dropped databases.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns BackupShortTermRetentionPolicy or ClientRawResponse<BackupShortTermRetentionPolicy> if raw==True

Return type

AzureOperationPoller[BackupShortTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[BackupShortTermRetentionPolicy]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedDatabaseRestoreDetailsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedDatabaseRestoreDetailsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

restore_details_name – The name of the restore details to retrieve. Constant value: “Default”.
api_version – The API version to use for this operation. Constant value: “2020-02-02-preview”.

get(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets managed database restore details.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedDatabaseRestoreDetailsResult or ClientRawResponse if raw=true

Return type

ManagedDatabaseRestoreDetailsResult or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedDatabasesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedDatabasesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-02-02-preview”.

complete_restore(resource_group_name, managed_instance_name, database_name, last_backup_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Completes the restore operation on a managed database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
last_backup_name (str) – The last backup name to apply
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

create_or_update(resource_group_name, managed_instance_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Creates a new database or updates an existing database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
parameters (ManagedDatabase) – The requested database resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedDatabase or ClientRawResponse<ManagedDatabase> if raw==True

Return type

AzureOperationPoller[ManagedDatabase] or AzureOperationPoller[ClientRawResponse[ManagedDatabase]]

Raises

CloudError

delete(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes a managed database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a managed database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedDatabase or ClientRawResponse if raw=true

Return type

ManagedDatabase or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of managed databases.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedDatabase

Return type

ManagedDatabasePaged[ManagedDatabase]

Raises

CloudError

list_inaccessible_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of inaccessible managed databases in a managed instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedDatabase

Return type

ManagedDatabasePaged[ManagedDatabase]

Raises

CloudError

update(resource_group_name, managed_instance_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Updates an existing database.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
parameters (ManagedDatabaseUpdate) – The requested database resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedDatabase or ClientRawResponse<ManagedDatabase> if raw==True

Return type

AzureOperationPoller[ManagedDatabase] or AzureOperationPoller[ClientRawResponse[ManagedDatabase]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ServerAzureADOnlyAuthenticationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ServerAzureADOnlyAuthenticationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-02-02-preview”.
authentication_name – The name of server azure active directory only authentication. Constant value: “Default”.

create_or_update(resource_group_name, server_name, azure_ad_only_authentication, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
azure_ad_only_authentication (bool) – Azure Active Directory only Authentication enabled.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServerAzureADOnlyAuthentication or ClientRawResponse<ServerAzureADOnlyAuthentication> if raw==True

Return type

AzureOperationPoller[ServerAzureADOnlyAuthentication] or AzureOperationPoller[ClientRawResponse[ServerAzureADOnlyAuthentication]]

Raises

CloudError

delete(resource_group_name, server_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing server Active Directory only authentication property.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a specific Azure Active Directory only authentication property.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ServerAzureADOnlyAuthentication or ClientRawResponse if raw=true

Return type

ServerAzureADOnlyAuthentication or ClientRawResponse

Raises

CloudError

list_by_server(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of server Azure Active Directory only authentications.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ServerAzureADOnlyAuthentication

Return type

ServerAzureADOnlyAuthenticationPaged[ServerAzureADOnlyAuthentication]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ImportExportOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ImportExportOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

api_version – The API version to use for the request. Constant value: “2020-02-02-preview”.

import_method(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Imports a bacpac into a new database.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (ImportExistingDatabaseDefinition) – The database import request parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ImportExportOperationResult or ClientRawResponse<ImportExportOperationResult> if raw==True

Return type

AzureOperationPoller[ImportExportOperationResult] or AzureOperationPoller[ClientRawResponse[ImportExportOperationResult]]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶

class azure.mgmt.sql.operations.ManagedInstanceAzureADOnlyAuthenticationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ManagedInstanceAzureADOnlyAuthenticationsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

Variables

authentication_name – The name of server azure active directory only authentication. Constant value: “Default”.
api_version – The API version to use for the request. Constant value: “2020-02-02-preview”.

create_or_update(resource_group_name, managed_instance_name, azure_ad_only_authentication, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
azure_ad_only_authentication (bool) – Azure Active Directory only Authentication enabled.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ManagedInstanceAzureADOnlyAuthentication or ClientRawResponse<ManagedInstanceAzureADOnlyAuthentication> if raw==True

Return type

AzureOperationPoller[ManagedInstanceAzureADOnlyAuthentication] or AzureOperationPoller[ClientRawResponse[ManagedInstanceAzureADOnlyAuthentication]]

Raises

CloudError

delete(resource_group_name, managed_instance_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶

Deletes an existing server Active Directory only authentication property.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a specific Azure Active Directory only authentication property.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

ManagedInstanceAzureADOnlyAuthentication or ClientRawResponse if raw=true

Return type

ManagedInstanceAzureADOnlyAuthentication or ClientRawResponse

Raises

CloudError

list_by_instance(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶

Gets a list of server Azure Active Directory only authentications.

Parameters

resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.

Returns

An iterator like instance of ManagedInstanceAzureADOnlyAuthentication

Return type

ManagedInstanceAzureADOnlyAuthenticationPaged[ManagedInstanceAzureADOnlyAuthentication]

Raises

CloudError

models = <module 'azure.mgmt.sql.models' from '/home/vsts/work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/sql/models/__init__.py'>¶