azure.mgmt.sql.operations module¶

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, expand: Optional[str] = None, **kwargs: Any) → List[azure.mgmt.sql.models._models_py3.Advisor][source]¶

Gets a list of database advisors.

Parameters

resource_group_name (str) – 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.
expand (str) – The child resources to include in the response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

list of Advisor, or the result of cls(response)

Return type

list[Advisor]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, parameters: azure.mgmt.sql.models._models_py3.Advisor, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Advisor[source]¶

Updates a database 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 the database.
advisor_name (str) – The name of the Database Advisor.
parameters (Advisor) – The requested advisor resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Advisor, or the result of cls(response)

Return type

DatabaseBlobAuditingPolicy

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseAutomaticTuning[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseAutomaticTuning, or the result of cls(response)

Return type

DatabaseAutomaticTuning

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.DatabaseAutomaticTuning, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseAutomaticTuning[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.
parameters (DatabaseAutomaticTuning) – The requested automatic tuning resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseAutomaticTuning, or the result of cls(response)

Return type

DatabaseAutomaticTuning

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.DatabaseBlobAuditingPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseBlobAuditingPolicy[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseBlobAuditingPolicy, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseBlobAuditingPolicy[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseBlobAuditingPolicy, or the result of cls(response)

Return type

DatabaseBlobAuditingPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseBlobAuditingPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseBlobAuditingPolicyListResult or the result of cls(response)

Return type

ItemPaged[DatabaseBlobAuditingPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DatabaseColumnsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseColumn[source]¶

Get database 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseColumn, or the result of cls(response)

Return type

DatabaseColumn

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, schema: Optional[List[str]] = None, table: Optional[List[str]] = None, column: Optional[List[str]] = None, order_by: Optional[List[str]] = None, skiptoken: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseColumnListResult][source]¶

List database 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 (list[str]) –
table (list[str]) –
column (list[str]) –
order_by (list[str]) –
skiptoken (str) – An opaque token that identifies a starting point in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseColumnListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_table(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseColumnListResult][source]¶

List database 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.
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseColumnListResult or the result of cls(response)

Return type

LROPoller[ImportExportExtensionsOperationResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DatabaseExtensionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, extension_name: str, parameters: azure.mgmt.sql.models._models_py3.DatabaseExtensions, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ImportExportExtensionsOperationResult][source]¶

Perform a database extension operation, like polybase import.

Parameters

resource_group_name (str) – 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.
extension_name (str) –
parameters (DatabaseExtensions) – The database import request parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ImportExportExtensionsOperationResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, extension_name: str, **kwargs: Any) → None [source]¶

Gets a database extension. This will return resource not found as it is not supported.

Parameters

resource_group_name (str) – 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.
extension_name (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[ImportExportExtensionsOperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ImportExportExtensionsOperationListResult][source]¶

List database extension. This will return an empty list as it is not supported.

Parameters

resource_group_name (str) – 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ImportExportExtensionsOperationListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DatabaseOperationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

cancel(resource_group_name: str, server_name: str, database_name: str, operation_id: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[DatabaseOperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseOperationListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseOperationListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DatabaseRecommendedActionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, recommended_action_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RecommendedAction[source]¶

Gets a database recommended action.

Parameters

resource_group_name (str) – 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.
advisor_name (str) – The name of the Database Advisor.
recommended_action_name (str) – The name of Database Recommended Action.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecommendedAction, or the result of cls(response)

Return type

RecommendedAction

Raises

~azure.core.exceptions.HttpResponseError

list_by_database_advisor(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, **kwargs: Any) → List[azure.mgmt.sql.models._models_py3.RecommendedAction][source]¶

Gets list of Database Recommended Actions.

Parameters

resource_group_name (str) – 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.
advisor_name (str) – The name of the Database Advisor.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

list of RecommendedAction, or the result of cls(response)

Return type

list[RecommendedAction]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, recommended_action_name: str, parameters: azure.mgmt.sql.models._models_py3.RecommendedAction, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RecommendedAction[source]¶

Updates a database recommended action.

Parameters

resource_group_name (str) – 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.
advisor_name (str) – The name of the Database Advisor.
recommended_action_name (str) – The name of Database Recommended Action.
parameters (RecommendedAction) – The requested recommended action resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecommendedAction, or the result of cls(response)

Return type

RecommendedAction

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DatabaseSchemasOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, database_name: str, schema_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSchema[source]¶

Get 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.
schema_name (str) – The name of the schema.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseSchema, or the result of cls(response)

Return type

DatabaseSchema

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseSchemaListResult][source]¶

List 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.
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseSchemaListResult or the result of cls(response)

Return type

ItemPaged[DatabaseSchemaListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DatabaseSecurityAlertPoliciesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.sql.models._models_py3.DatabaseSecurityAlertPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSecurityAlertPolicy[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.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the security alert policy is defined.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
parameters (DatabaseSecurityAlertPolicy) – The database security alert policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseSecurityAlertPolicy, or the result of cls(response)

Return type

DatabaseSecurityAlertPolicy

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSecurityAlertPolicy[source]¶

Gets 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.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the security alert policy is defined.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseSecurityAlertPolicy, or the result of cls(response)

Return type

DatabaseSecurityAlertPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseSecurityAlertListResult][source]¶

Gets a list of 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.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the security alert policy is defined.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseSecurityAlertListResult or the result of cls(response)

Return type

ItemPaged[DatabaseSecurityAlertListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DatabaseTablesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseTable[source]¶

Get database table.

Parameters

resource_group_name (str) – 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseTable, or the result of cls(response)

Return type

DatabaseTable

Raises

~azure.core.exceptions.HttpResponseError

list_by_schema(resource_group_name: str, server_name: str, database_name: str, schema_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseTableListResult][source]¶

List database tables.

Parameters

resource_group_name (str) – 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.
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseTableListResult or the result of cls(response)

Return type

ItemPaged[DatabaseTableListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseUsageListResult][source]¶

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseUsageListResult or the result of cls(response)

Return type

ItemPaged[DatabaseUsageListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], parameters: azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
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).
parameters (DatabaseVulnerabilityAssessmentRuleBaseline) – The requested rule baseline resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessmentRuleBaseline, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], **kwargs: Any) → None [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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
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).

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
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).

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessmentRuleBaseline, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_initiate_scan(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

DatabaseVulnerabilityAssessmentScansExport

Raises

~azure.core.exceptions.HttpResponseError

export(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentScansExport[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessmentScansExport, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentScanRecord[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VulnerabilityAssessmentScanRecord, or the result of cls(response)

Return type

VulnerabilityAssessmentScanRecord

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentScanRecordListResult][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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VulnerabilityAssessmentScanRecordListResult or the result of cls(response)

Return type

ItemPaged[VulnerabilityAssessmentScanRecordListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], parameters: azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
parameters (DatabaseVulnerabilityAssessment) – The requested resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessment, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → None [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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessment, or the result of cls(response)

Return type

ItemPaged[DatabaseVulnerabilityAssessmentListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseVulnerabilityAssessmentListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.Database, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Database][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Database or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[ImportExportOperationResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_export(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ExportDatabaseDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ImportExportOperationResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ImportExportOperationResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_failover(resource_group_name: str, server_name: str, database_name: str, replica_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ReplicaType]] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[ImportExportOperationResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_import_method(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ImportExistingDatabaseDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ImportExportOperationResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ImportExportOperationResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_pause(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Database][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Database or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_resume(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Database][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Database or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.DatabaseUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Database][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Database or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_upgrade_data_warehouse(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[DatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Database[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Database, or the result of cls(response)

Return type

Database

Raises

~azure.core.exceptions.HttpResponseError

list_by_elastic_pool(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseListResult][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.
skip_token (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseListResult or the result of cls(response)

Return type

ItemPaged[DatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_inaccessible_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseListResult or the result of cls(response)

Return type

ItemPaged[DatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_metric_definitions(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.MetricDefinitionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MetricDefinitionListResult or the result of cls(response)

Return type

ItemPaged[MetricDefinitionListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_metrics(resource_group_name: str, server_name: str, database_name: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.MetricListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MetricListResult or the result of cls(response)

Return type

ItemPaged[MetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

rename(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ResourceMoveDefinition, **kwargs: Any) → None [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.
parameters (ResourceMoveDefinition) – The resource move definition for renaming this database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

LROPoller[DistributedAvailabilityGroup]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DeletedServersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_recover(location_name: str, deleted_server_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.DeletedServer][source]¶

Recovers a deleted server.

Parameters

location_name (str) – The name of the region where the resource is located.
deleted_server_name (str) – The name of the deleted server.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DeletedServer or the result of cls(response)

Return type

LROPoller[DeletedServer]

Raises

~azure.core.exceptions.HttpResponseError

get(location_name: str, deleted_server_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DeletedServer[source]¶

Gets a deleted server.

Parameters

location_name (str) – The name of the region where the resource is located.
deleted_server_name (str) – The name of the deleted server.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeletedServer, or the result of cls(response)

Return type

DeletedServer

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DeletedServerListResult][source]¶

Gets a list of all deleted servers in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DeletedServerListResult or the result of cls(response)
Return type: ItemPaged[DeletedServerListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_location(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DeletedServerListResult][source]¶

Gets a list of deleted servers for a location.

Parameters: location_name (str) – The name of the region where the resource is located.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DeletedServerListResult or the result of cls(response)
Return type: ItemPaged[DeletedServerListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

DistributedAvailabilityGroupsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, parameters: azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup][source]¶

Creates a distributed availability group between Sql On-Prem and Sql 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.
distributed_availability_group_name (str) – The distributed availability group name.
parameters (DistributedAvailabilityGroup) – The distributed availability group info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DistributedAvailabilityGroup or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Drops a distributed availability group between Sql On-Prem and Sql 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.
distributed_availability_group_name (str) – The distributed availability group name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[DistributedAvailabilityGroup]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, parameters: azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup][source]¶

Updates a distributed availability group replication mode.

Parameters

resource_group_name (str) – 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.
distributed_availability_group_name (str) – The distributed availability group name.
parameters (DistributedAvailabilityGroup) – The distributed availability group info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DistributedAvailabilityGroup or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup[source]¶

Gets a distributed availability group info.

Parameters

resource_group_name (str) – 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.
distributed_availability_group_name (str) – The distributed availability group name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DistributedAvailabilityGroup, or the result of cls(response)

Return type

DistributedAvailabilityGroup

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroupsListResult][source]¶

Gets a list of a distributed availability groups in 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DistributedAvailabilityGroupsListResult or the result of cls(response)

Return type

ItemPaged[DistributedAvailabilityGroupsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

list_by_elastic_pool(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ElasticPoolActivityListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ElasticPoolActivityListResult or the result of cls(response)

Return type

ItemPaged[ElasticPoolActivityListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

list_by_elastic_pool(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ElasticPoolDatabaseActivityListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ElasticPoolDatabaseActivityListResult or the result of cls(response)

Return type

ItemPaged[ElasticPoolDatabaseActivityListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ElasticPoolOperationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

cancel(resource_group_name: str, server_name: str, elastic_pool_name: str, operation_id: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[ElasticPoolOperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_elastic_pool(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ElasticPoolOperationListResult][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) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ElasticPoolOperationListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: azure.mgmt.sql.models._models_py3.ElasticPool, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ElasticPool][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ElasticPool or the result of cls(response)

Return type

LROPoller[ElasticPool]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_failover(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[ElasticPoolListResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: azure.mgmt.sql.models._models_py3.ElasticPoolUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ElasticPool][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ElasticPool or the result of cls(response)

Return type

LROPoller[ElasticPool]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ElasticPool[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ElasticPool, or the result of cls(response)

Return type

ElasticPool

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ElasticPoolListResult][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 (long) – The number of elements in the collection to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ElasticPoolListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_metric_definitions(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.MetricDefinitionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MetricDefinitionListResult or the result of cls(response)

Return type

ItemPaged[MetricDefinitionListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_metrics(resource_group_name: str, server_name: str, elastic_pool_name: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.MetricListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either MetricListResult or the result of cls(response)

Return type

ItemPaged[MetricListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], parameters: azure.mgmt.sql.models._models_py3.EncryptionProtector, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.EncryptionProtector][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.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated.
parameters (EncryptionProtector) – The requested encryption protector resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either EncryptionProtector or the result of cls(response)

Return type

LROPoller[EncryptionProtector]

Raises

~azure.core.exceptions.HttpResponseError

begin_revalidate(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[EncryptionProtectorListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.EncryptionProtector[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.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be retrieved.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EncryptionProtector, or the result of cls(response)

Return type

EncryptionProtector

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.EncryptionProtectorListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EncryptionProtectorListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ExtendedDatabaseBlobAuditingPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ExtendedDatabaseBlobAuditingPolicy[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedDatabaseBlobAuditingPolicy, or the result of cls(response)

Return type

ExtendedDatabaseBlobAuditingPolicy

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ExtendedDatabaseBlobAuditingPolicy[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedDatabaseBlobAuditingPolicy, or the result of cls(response)

Return type

ExtendedDatabaseBlobAuditingPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ExtendedDatabaseBlobAuditingPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ExtendedDatabaseBlobAuditingPolicyListResult or the result of cls(response)

Return type

ItemPaged[ExtendedDatabaseBlobAuditingPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ExtendedServerBlobAuditingPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ExtendedServerBlobAuditingPolicy][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ExtendedServerBlobAuditingPolicy or the result of cls(response)

Return type

LROPoller[ExtendedServerBlobAuditingPolicy]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ExtendedServerBlobAuditingPolicy[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ExtendedServerBlobAuditingPolicy, or the result of cls(response)

Return type

ExtendedServerBlobAuditingPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ExtendedServerBlobAuditingPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ExtendedServerBlobAuditingPolicyListResult or the result of cls(response)

Return type

ItemPaged[ExtendedServerBlobAuditingPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, failover_group_name: str, parameters: azure.mgmt.sql.models._models_py3.FailoverGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.FailoverGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either FailoverGroup or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_failover(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.FailoverGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either FailoverGroup or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_force_failover_allow_data_loss(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.FailoverGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either FailoverGroup or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, server_name: str, failover_group_name: str, parameters: azure.mgmt.sql.models._models_py3.FailoverGroupUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.FailoverGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either FailoverGroup or the result of cls(response)

Return type

ItemPaged[FailoverGroupListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.FailoverGroup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FailoverGroup, or the result of cls(response)

Return type

FailoverGroup

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.FailoverGroupListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either FailoverGroupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, firewall_rule_name: str, parameters: azure.mgmt.sql.models._models_py3.FirewallRule, **kwargs: Any) → azure.mgmt.sql.models._models_py3.FirewallRule[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.
parameters (FirewallRule) – The required parameters for creating or updating a firewall rule.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FirewallRule, or the result of cls(response)

Return type

FirewallRule

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[FirewallRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.FirewallRule[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FirewallRule, or the result of cls(response)

Return type

FirewallRule

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.FirewallRuleListResult][source]¶

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either FirewallRuleListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

replace(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.FirewallRuleList, **kwargs: Any) → Optional[azure.mgmt.sql.models._models_py3.FirewallRule][source]¶

Replaces all firewall rules on the 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 (FirewallRuleList) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

FirewallRule, or the result of cls(response)

Return type

FirewallRule or None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, geo_backup_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.GeoBackupPolicyName], parameters: azure.mgmt.sql.models._models_py3.GeoBackupPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.GeoBackupPolicy[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.
geo_backup_policy_name (str or GeoBackupPolicyName) – The name of the geo backup policy.
parameters (GeoBackupPolicy) – The required parameters for creating or updating the geo backup policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GeoBackupPolicy, or the result of cls(response)

Return type

GeoBackupPolicy

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, geo_backup_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.GeoBackupPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.GeoBackupPolicy[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.
geo_backup_policy_name (str or GeoBackupPolicyName) – The name of the geo backup policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GeoBackupPolicy, or the result of cls(response)

Return type

GeoBackupPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.GeoBackupPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GeoBackupPolicyListResult or the result of cls(response)

Return type

ItemPaged[GeoBackupPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

IPv6FirewallRulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, firewall_rule_name: str, parameters: azure.mgmt.sql.models._models_py3.IPv6FirewallRule, **kwargs: Any) → azure.mgmt.sql.models._models_py3.IPv6FirewallRule[source]¶

Creates or updates an IPv6 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.
parameters (IPv6FirewallRule) – The required parameters for creating or updating an IPv6 firewall rule.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IPv6FirewallRule, or the result of cls(response)

Return type

IPv6FirewallRule

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) → None [source]¶

Deletes an IPv6 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[IPv6FirewallRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.IPv6FirewallRule[source]¶

Gets an IPv6 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IPv6FirewallRule, or the result of cls(response)

Return type

IPv6FirewallRule

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.IPv6FirewallRuleListResult][source]¶

Gets a list of IPv6 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IPv6FirewallRuleListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, location_name: str, failover_group_name: str, parameters: azure.mgmt.sql.models._models_py3.InstanceFailoverGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstanceFailoverGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either InstanceFailoverGroup or the result of cls(response)

Return type

LROPoller[InstanceFailoverGroup]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[InstanceFailoverGroup]

Raises

~azure.core.exceptions.HttpResponseError

begin_failover(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstanceFailoverGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either InstanceFailoverGroup or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_force_failover_allow_data_loss(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstanceFailoverGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either InstanceFailoverGroup or the result of cls(response)

Return type

LROPoller[InstanceFailoverGroup]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.InstanceFailoverGroup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

InstanceFailoverGroup, or the result of cls(response)

Return type

InstanceFailoverGroup

Raises

~azure.core.exceptions.HttpResponseError

list_by_location(resource_group_name: str, location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.InstanceFailoverGroupListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either InstanceFailoverGroupListResult or the result of cls(response)

Return type

ItemPaged[InstanceFailoverGroupListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, instance_pool_name: str, parameters: azure.mgmt.sql.models._models_py3.InstancePool, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstancePool][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either InstancePool or the result of cls(response)

Return type

LROPoller[InstancePool]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, instance_pool_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, instance_pool_name: str, parameters: azure.mgmt.sql.models._models_py3.InstancePoolUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstancePool][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.
parameters (InstancePoolUpdate) – The requested instance pool resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either InstancePool or the result of cls(response)

Return type

LROPoller[InstancePool]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, instance_pool_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.InstancePool[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

InstancePool, or the result of cls(response)

Return type

InstancePool

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.InstancePoolListResult][source]¶

Gets a list of all instance pools in the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either InstancePoolListResult or the result of cls(response)
Return type: ItemPaged[InstancePoolListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.InstancePoolListResult][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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either InstancePoolListResult or the result of cls(response)
Return type: ItemPaged[InstancePoolListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: azure.mgmt.sql.models._models_py3.JobAgent, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.JobAgent][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either JobAgent or the result of cls(response)

Return type

LROPoller[JobAgent]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[JobAgentListResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: azure.mgmt.sql.models._models_py3.JobAgentUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.JobAgent][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.
parameters (JobAgentUpdate) – The update to the job agent.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either JobAgent or the result of cls(response)

Return type

LROPoller[JobAgent]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobAgent[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobAgent, or the result of cls(response)

Return type

JobAgent

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobAgentListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobAgentListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, job_agent_name: str, credential_name: str, parameters: azure.mgmt.sql.models._models_py3.JobCredential, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobCredential[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.
parameters (JobCredential) – The requested job credential state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobCredential, or the result of cls(response)

Return type

JobCredential

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[JobCredentialListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobCredential[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobCredential, or the result of cls(response)

Return type

JobCredential

Raises

~azure.core.exceptions.HttpResponseError

list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobCredentialListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobCredentialListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.JobExecution][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either JobExecution or the result of cls(response)

Return type

LROPoller[JobExecution]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.JobExecution][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either JobExecution or the result of cls(response)

Return type

LROPoller[JobExecution]

Raises

~azure.core.exceptions.HttpResponseError

cancel(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobExecution[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobExecution, or the result of cls(response)

Return type

JobExecution

Raises

~azure.core.exceptions.HttpResponseError

list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobExecutionListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_job(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobExecutionListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, step_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobExecution[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobExecution, or the result of cls(response)

Return type

JobExecution

Raises

~azure.core.exceptions.HttpResponseError

list_by_job_execution(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobExecutionListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, parameters: azure.mgmt.sql.models._models_py3.JobStep, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobStep[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobStep, or the result of cls(response)

Return type

JobStep

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[JobStepListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobStep[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobStep, or the result of cls(response)

Return type

JobStep

Raises

~azure.core.exceptions.HttpResponseError

get_by_version(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_version: int, step_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobStep[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobStep, or the result of cls(response)

Return type

JobStep

Raises

~azure.core.exceptions.HttpResponseError

list_by_job(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobStepListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobStepListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_version(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_version: int, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobStepListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobStepListResult or the result of cls(response)

Return type

ItemPaged[JobStepListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, step_name: str, target_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobExecution[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobExecution, or the result of cls(response)

Return type

JobExecution

Raises

~azure.core.exceptions.HttpResponseError

list_by_job_execution(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobExecutionListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_step(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, step_name: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobExecutionListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, job_agent_name: str, target_group_name: str, parameters: azure.mgmt.sql.models._models_py3.JobTargetGroup, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobTargetGroup[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.
parameters (JobTargetGroup) – The requested state of the target group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobTargetGroup, or the result of cls(response)

Return type

JobTargetGroup

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, job_agent_name: str, target_group_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[JobTargetGroupListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, job_agent_name: str, target_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobTargetGroup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobTargetGroup, or the result of cls(response)

Return type

JobTargetGroup

Raises

~azure.core.exceptions.HttpResponseError

list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobTargetGroupListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobTargetGroupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_version: int, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobVersion[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

JobVersion, or the result of cls(response)

Return type

JobVersion

Raises

~azure.core.exceptions.HttpResponseError

list_by_job(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobVersionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobVersionListResult or the result of cls(response)

Return type

ItemPaged[JobVersionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, job_agent_name: str, job_name: str, parameters: azure.mgmt.sql.models._models_py3.Job, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Job[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.
parameters (Job) – The requested job state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Job, or the result of cls(response)

Return type

Job

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

LROPoller[LedgerDigestUploads]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Job[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Job, or the result of cls(response)

Return type

Job

Raises

~azure.core.exceptions.HttpResponseError

list_by_agent(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobListResult or the result of cls(response)

Return type

ItemPaged[JobListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

LedgerDigestUploadsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, ledger_digest_uploads: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LedgerDigestUploadsName], parameters: azure.mgmt.sql.models._models_py3.LedgerDigestUploads, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LedgerDigestUploads][source]¶

Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger 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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
ledger_digest_uploads (str or LedgerDigestUploadsName) –
parameters (LedgerDigestUploads) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LedgerDigestUploads or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_disable(resource_group_name: str, server_name: str, database_name: str, ledger_digest_uploads: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LedgerDigestUploadsName], **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LedgerDigestUploads][source]¶

Disables uploading ledger digests to an Azure Storage account or an Azure Confidential Ledger 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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
ledger_digest_uploads (str or LedgerDigestUploadsName) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LedgerDigestUploads or the result of cls(response)

Return type

LROPoller[LedgerDigestUploads]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, ledger_digest_uploads: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LedgerDigestUploadsName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.LedgerDigestUploads[source]¶

Gets the current ledger digest upload configuration 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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
ledger_digest_uploads (str or LedgerDigestUploadsName) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LedgerDigestUploads, or the result of cls(response)

Return type

LedgerDigestUploads

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LedgerDigestUploadsListResult][source]¶

Gets all ledger digest upload settings on 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LedgerDigestUploadsListResult or the result of cls(response)

Return type

ItemPaged[LedgerDigestUploadsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_copy(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: azure.mgmt.sql.models._models_py3.CopyLongTermRetentionBackupParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupOperationResult][source]¶

Copy an existing 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.
parameters (CopyLongTermRetentionBackupParameters) – The parameters needed for long term retention copy request.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_copy_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: azure.mgmt.sql.models._models_py3.CopyLongTermRetentionBackupParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupOperationResult][source]¶

Copy an existing long term retention backup to a different 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.
long_term_retention_database_name (str) – The name of the database.
backup_name (str) – The backup name.
parameters (CopyLongTermRetentionBackupParameters) – The parameters needed for long term retention copy request.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: azure.mgmt.sql.models._models_py3.UpdateLongTermRetentionBackupParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupOperationResult][source]¶

Updates an existing 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.
parameters (UpdateLongTermRetentionBackupParameters) – The requested backup resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: azure.mgmt.sql.models._models_py3.UpdateLongTermRetentionBackupParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupOperationResult][source]¶

Updates an existing 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.
parameters (UpdateLongTermRetentionBackupParameters) – The requested backup resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LongTermRetentionBackupOperationResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.LongTermRetentionBackup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LongTermRetentionBackup, or the result of cls(response)

Return type

LongTermRetentionBackup

Raises

~azure.core.exceptions.HttpResponseError

get_by_resource_group(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.LongTermRetentionBackup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LongTermRetentionBackup, or the result of cls(response)

Return type

LongTermRetentionBackup

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_location(location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group_database(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group_location(resource_group_name: str, location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group_server(resource_group_name: str, location_name: str, long_term_retention_server_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(location_name: str, long_term_retention_server_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_delete(location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_delete_by_resource_group(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ManagedInstanceLongTermRetentionBackup

Raises

~azure.core.exceptions.HttpResponseError

get(location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceLongTermRetentionBackup, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_by_resource_group(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceLongTermRetentionBackup, or the result of cls(response)

Return type

ManagedInstanceLongTermRetentionBackup

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(location_name: str, managed_instance_name: str, database_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(location_name: str, managed_instance_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_location(location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group_database(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group_instance(resource_group_name: str, location_name: str, managed_instance_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group_location(resource_group_name: str, location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][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 DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackupListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

LongTermRetentionPoliciesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LongTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.LongTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionPolicy][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.
policy_name (str or LongTermRetentionPolicyName) – The policy name. Should always be Default.
parameters (LongTermRetentionPolicy) – The long term retention policy info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LongTermRetentionPolicy or the result of cls(response)

Return type

LROPoller[LongTermRetentionPolicy]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LongTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.LongTermRetentionPolicy[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.
policy_name (str or LongTermRetentionPolicyName) – The policy name. Should always be Default.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LongTermRetentionPolicy, or the result of cls(response)

Return type

LongTermRetentionPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LongTermRetentionPolicyListResult or the result of cls(response)

Return type

ItemPaged[LongTermRetentionPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

MaintenanceWindowOptionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, database_name: str, maintenance_window_options_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.MaintenanceWindowOptions[source]¶

Gets a list of available maintenance windows.

Parameters

resource_group_name (str) – 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 maintenance windows options for.
maintenance_window_options_name (str) – Maintenance window options name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

MaintenanceWindowOptions, or the result of cls(response)

Return type

MaintenanceWindowOptions

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

MaintenanceWindowsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, maintenance_window_name: str, parameters: azure.mgmt.sql.models._models_py3.MaintenanceWindows, **kwargs: Any) → None [source]¶

Sets maintenance windows settings 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.
server_name (str) – The name of the server.
database_name (str) – The name of the database to set maintenance windows for.
maintenance_window_name (str) – Maintenance window name.
parameters (MaintenanceWindows) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, maintenance_window_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.MaintenanceWindows[source]¶

Gets maintenance windows settings 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.
server_name (str) – The name of the server.
database_name (str) – The name of the database to get maintenance windows for.
maintenance_window_name (str) – Maintenance window name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

MaintenanceWindows, or the result of cls(response)

Return type

MaintenanceWindows

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy][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.
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (ManagedBackupShortTermRetentionPolicy) – The short term retention policy info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedBackupShortTermRetentionPolicy or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy][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.
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (ManagedBackupShortTermRetentionPolicy) – The short term retention policy info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedBackupShortTermRetentionPolicy or the result of cls(response)

Return type

ManagedBackupShortTermRetentionPolicy

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy[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.
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedBackupShortTermRetentionPolicy, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedBackupShortTermRetentionPolicyListResult or the result of cls(response)

Return type

ItemPaged[ManagedBackupShortTermRetentionPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedDatabaseColumnsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseColumn[source]¶

Get managed database 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseColumn, or the result of cls(response)

Return type

DatabaseColumn

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, schema: Optional[List[str]] = None, table: Optional[List[str]] = None, column: Optional[List[str]] = None, order_by: Optional[List[str]] = None, skiptoken: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseColumnListResult][source]¶

List managed database 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 (list[str]) –
table (list[str]) –
column (list[str]) –
order_by (list[str]) –
skiptoken (str) – An opaque token that identifies a starting point in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseColumnListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_table(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseColumnListResult][source]¶

List managed database 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.
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseColumnListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceQueryStatistics]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedDatabaseQueriesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, managed_instance_name: str, database_name: str, query_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceQuery[source]¶

Get query by query id.

Parameters

resource_group_name (str) – 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.
query_id (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceQuery, or the result of cls(response)

Return type

ManagedInstanceQuery

Raises

~azure.core.exceptions.HttpResponseError

list_by_query(resource_group_name: str, managed_instance_name: str, database_name: str, query_id: str, start_time: Optional[str] = None, end_time: Optional[str] = None, interval: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.QueryTimeGrainType]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceQueryStatistics][source]¶

Get query execution statistics by query id.

Parameters

resource_group_name (str) – 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.
query_id (str) –
start_time (str) – Start time for observed period.
end_time (str) – End time for observed period.
interval (str or QueryTimeGrainType) – The time step to be used to summarize the metric values.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceQueryStatistics or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedDatabaseRecommendedSensitivityLabelsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.RecommendedSensitivityLabelUpdateList, **kwargs: Any) → None [source]¶

Update recommended sensitivity labels states of a given database using an operations batch.

Parameters

resource_group_name (str) – 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 (RecommendedSensitivityLabelUpdateList) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ManagedDatabaseRestoreDetailsResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, managed_instance_name: str, database_name: str, restore_details_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.RestoreDetailsName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabaseRestoreDetailsResult[source]¶

Gets managed database restore details.

Parameters

resource_group_name (str) – 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.
restore_details_name (str or RestoreDetailsName) – The name of the restore details to retrieve.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedDatabaseRestoreDetailsResult, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedDatabaseSchemasOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSchema[source]¶

Get managed 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.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseSchema, or the result of cls(response)

Return type

DatabaseSchema

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseSchemaListResult][source]¶

List managed 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.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseSchemaListResult or the result of cls(response)

Return type

ItemPaged[DatabaseSchemaListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, managed_instance_name: str, database_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedDatabaseSecurityAlertPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabaseSecurityAlertPolicy[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.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
parameters (ManagedDatabaseSecurityAlertPolicy) – The database security alert policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedDatabaseSecurityAlertPolicy, or the result of cls(response)

Return type

ManagedDatabaseSecurityAlertPolicy

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabaseSecurityAlertPolicy[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.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedDatabaseSecurityAlertPolicy, or the result of cls(response)

Return type

ManagedDatabaseSecurityAlertPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedDatabaseSecurityAlertPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedDatabaseSecurityAlertPolicyListResult or the result of cls(response)

Return type

ItemPaged[ManagedDatabaseSecurityAlertPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedDatabaseSecurityEventsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, filter: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, skiptoken: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SecurityEventCollection][source]¶

Gets a list of security events.

Parameters

resource_group_name (str) – 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 events are retrieved.
filter (str) – An OData filter expression that filters elements in the collection.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
skiptoken (str) – An opaque token that identifies a starting point in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SecurityEventCollection or the result of cls(response)

Return type

ItemPaged[SecurityEventCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, parameters: azure.mgmt.sql.models._models_py3.SensitivityLabel, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SensitivityLabel[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SensitivityLabel, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

disable_recommendation(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

enable_recommendation(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, sensitivity_label_source: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SensitivityLabelSource], **kwargs: Any) → azure.mgmt.sql.models._models_py3.SensitivityLabel[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SensitivityLabel, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_current_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, skip_token: Optional[str] = None, count: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SensitivityLabelListResult][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.
skip_token (str) –
count (bool) –
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SensitivityLabelListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_recommended_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, skip_token: Optional[str] = None, include_disabled_recommendations: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SensitivityLabelListResult][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.
skip_token (str) –
include_disabled_recommendations (bool) – Specifies whether to include disabled recommendations or not.
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SensitivityLabelListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.SensitivityLabelUpdateList, **kwargs: Any) → None [source]¶

Update sensitivity labels of a given database using an operations batch.

Parameters

resource_group_name (str) – 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 (SensitivityLabelUpdateList) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[DatabaseTableListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedDatabaseTablesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseTable[source]¶

Get managed database table.

Parameters

resource_group_name (str) – 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseTable, or the result of cls(response)

Return type

DatabaseTable

Raises

~azure.core.exceptions.HttpResponseError

list_by_schema(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseTableListResult][source]¶

List managed database tables.

Parameters

resource_group_name (str) – 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.
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseTableListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedDatabaseTransparentDataEncryptionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, managed_instance_name: str, database_name: str, tde_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionName], parameters: azure.mgmt.sql.models._models_py3.ManagedTransparentDataEncryption, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedTransparentDataEncryption[source]¶

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.
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.
tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration.
parameters (ManagedTransparentDataEncryption) – The database transparent data encryption.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedTransparentDataEncryption, or the result of cls(response)

Return type

ManagedTransparentDataEncryption

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, tde_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedTransparentDataEncryption[source]¶

Gets a managed database’s transparent data encryption.

Parameters

resource_group_name (str) – 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 transparent data encryption is defined.
tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedTransparentDataEncryption, or the result of cls(response)

Return type

ManagedTransparentDataEncryption

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedTransparentDataEncryptionListResult][source]¶

Gets a list of managed database’s transparent data encryptions.

Parameters

resource_group_name (str) – 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 transparent data encryption is defined.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedTransparentDataEncryptionListResult or the result of cls(response)

Return type

ItemPaged[ManagedTransparentDataEncryptionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], parameters: azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
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).
parameters (DatabaseVulnerabilityAssessmentRuleBaseline) – The requested rule baseline resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessmentRuleBaseline, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], **kwargs: Any) → None [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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
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).

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
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).

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessmentRuleBaseline, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_initiate_scan(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

DatabaseVulnerabilityAssessmentScansExport

Raises

~azure.core.exceptions.HttpResponseError

export(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentScansExport[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessmentScansExport, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentScanRecord[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VulnerabilityAssessmentScanRecord, or the result of cls(response)

Return type

VulnerabilityAssessmentScanRecord

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentScanRecordListResult][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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VulnerabilityAssessmentScanRecordListResult or the result of cls(response)

Return type

ItemPaged[VulnerabilityAssessmentScanRecordListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], parameters: azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
parameters (DatabaseVulnerabilityAssessment) – The requested resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessment, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → None [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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DatabaseVulnerabilityAssessment, or the result of cls(response)

Return type

ItemPaged[DatabaseVulnerabilityAssessmentListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DatabaseVulnerabilityAssessmentListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_complete_restore(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.CompleteDatabaseRestoreDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Completes the restore operation on 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.
parameters (CompleteDatabaseRestoreDefinition) – The definition for completing the restore of this managed database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[ManagedDatabase]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedDatabase, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedDatabase][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.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedDatabase or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[ManagedDatabase]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedDatabaseUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedDatabase][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.
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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedDatabase or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabase[source]¶

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedDatabase, or the result of cls(response)

Return type

ManagedDatabase

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedDatabaseListResult][source]¶

Gets a list of 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedDatabaseListResult or the result of cls(response)

Return type

ItemPaged[ManagedDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_inaccessible_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedDatabaseListResult][source]¶

Gets a list of inaccessible managed databases in 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedDatabaseListResult or the result of cls(response)

Return type

ItemPaged[ManagedDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceAdministrator, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceAdministrator][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.
administrator_name (str or AdministratorName) –
parameters (ManagedInstanceAdministrator) – The requested administrator parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedInstanceAdministrator or the result of cls(response)

Return type

LROPoller[ManagedInstanceAdministrator]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, managed_instance_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
administrator_name (str or AdministratorName) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ManagedInstanceAdministrator

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceAdministrator[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.
administrator_name (str or AdministratorName) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceAdministrator, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceAdministratorListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceAdministratorListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceAdministratorListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceAzureADOnlyAuthentication, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceAzureADOnlyAuthentication][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.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.
parameters (ManagedInstanceAzureADOnlyAuthentication) – The required parameters for creating or updating an Active Directory only authentication property.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedInstanceAzureADOnlyAuthentication or the result of cls(response)

Return type

LROPoller[ManagedInstanceAzureADOnlyAuthentication]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, managed_instance_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ManagedInstanceAzureADOnlyAuthentication

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceAzureADOnlyAuthentication[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.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceAzureADOnlyAuthentication, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceAzureADOnlyAuthListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceAzureADOnlyAuthListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceAzureADOnlyAuthListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceEncryptionProtector, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceEncryptionProtector][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.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated.
parameters (ManagedInstanceEncryptionProtector) – The requested encryption protector resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedInstanceEncryptionProtector or the result of cls(response)

Return type

LROPoller[ManagedInstanceEncryptionProtector]

Raises

~azure.core.exceptions.HttpResponseError

begin_revalidate(resource_group_name: str, managed_instance_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ManagedInstanceEncryptionProtector

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceEncryptionProtector[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.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be retrieved.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceEncryptionProtector, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceEncryptionProtectorListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceEncryptionProtectorListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceEncryptionProtectorListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, key_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceKey, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceKey][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).
parameters (ManagedInstanceKey) – The requested managed instance key resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedInstanceKey or the result of cls(response)

Return type

LROPoller[ManagedInstanceKey]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, managed_instance_name: str, key_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[ManagedInstanceKeyListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, key_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceKey[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceKey, or the result of cls(response)

Return type

ManagedInstanceKey

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceKeyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceKeyListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedInstanceLongTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionPolicy][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.
policy_name (str or ManagedInstanceLongTermRetentionPolicyName) – The policy name. Should always be Default.
parameters (ManagedInstanceLongTermRetentionPolicy) – The long term retention policy info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedInstanceLongTermRetentionPolicy or the result of cls(response)

Return type

LROPoller[ManagedInstanceLongTermRetentionPolicy]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedInstanceLongTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionPolicy[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.
policy_name (str or ManagedInstanceLongTermRetentionPolicyName) – The policy name. Should always be Default.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceLongTermRetentionPolicy, or the result of cls(response)

Return type

ManagedInstanceLongTermRetentionPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceLongTermRetentionPolicyListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceLongTermRetentionPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedInstanceOperationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

cancel(resource_group_name: str, managed_instance_name: str, operation_id: str, **kwargs: Any) → None [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) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[ManagedInstanceOperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, operation_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceOperation[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) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceOperation, or the result of cls(response)

Return type

ManagedInstanceOperation

Raises

~azure.core.exceptions.HttpResponseError

list_by_managed_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceOperationListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceOperationListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedInstancePrivateEndpointConnectionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointConnection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointConnection][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.
managed_instance_name (str) – The name of the managed instance.
private_endpoint_connection_name (str) –
parameters (ManagedInstancePrivateEndpointConnection) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedInstancePrivateEndpointConnection or the result of cls(response)

Return type

LROPoller[ManagedInstancePrivateEndpointConnection]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, managed_instance_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
managed_instance_name (str) – The name of the managed instance.
private_endpoint_connection_name (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ManagedInstancePrivateEndpointConnection

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointConnection[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.
managed_instance_name (str) – The name of the managed instance.
private_endpoint_connection_name (str) – The name of the private endpoint connection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstancePrivateEndpointConnection, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_managed_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointConnectionListResult][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.
managed_instance_name (str) – The name of the managed instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstancePrivateEndpointConnectionListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstancePrivateEndpointConnectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ManagedInstancePrivateLinkResourcesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, managed_instance_name: str, group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstancePrivateLink[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.
managed_instance_name (str) – The name of the managed instance.
group_name (str) – The name of the private link resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstancePrivateLink, or the result of cls(response)

Return type

ManagedInstancePrivateLink

Raises

~azure.core.exceptions.HttpResponseError

list_by_managed_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateLinkListResult][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.
managed_instance_name (str) – The name of the managed instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstancePrivateLinkListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstancePrivateLinkListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create(resource_group_name: str, managed_instance_name: str, parameters: azure.mgmt.sql.models._models_py3.TdeCertificate, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
parameters (TdeCertificate) – The requested TDE certificate to be created or updated.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ManagedInstanceVulnerabilityAssessment

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, managed_instance_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceVulnerabilityAssessment, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceVulnerabilityAssessment[source]¶

Creates or updates the managed instance’s vulnerability assessment. Learn more about setting SQL vulnerability assessment with managed identity - https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage.

Parameters

resource_group_name (str) – 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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
parameters (ManagedInstanceVulnerabilityAssessment) – The requested resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceVulnerabilityAssessment, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, managed_instance_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → None [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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ManagedInstanceVulnerabilityAssessment

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceVulnerabilityAssessment[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstanceVulnerabilityAssessment, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceVulnerabilityAssessmentListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceVulnerabilityAssessmentListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceVulnerabilityAssessmentListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedInstance, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstance][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedInstance or the result of cls(response)

Return type

LROPoller[ManagedInstance]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_failover(resource_group_name: str, managed_instance_name: str, replica_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ReplicaType]] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Failovers 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 to failover.
replica_type (str or ReplicaType) – The type of replica to be failed over.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[ManagedInstance]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, managed_instance_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstance][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedInstance or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstance[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.
expand (str) – The child resources to include in the response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedInstance, or the result of cls(response)

Return type

ManagedInstance

Raises

~azure.core.exceptions.HttpResponseError

list(expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceListResult][source]¶

Gets a list of all managed instances in the subscription.

Parameters: expand (str) – The child resources to include in the response.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ManagedInstanceListResult or the result of cls(response)
Return type: ItemPaged[ManagedInstanceListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_instance_pool(resource_group_name: str, instance_pool_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceListResult][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.
expand (str) – The child resources to include in the response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_managed_instance(resource_group_name: str, managed_instance_name: str, number_of_queries: Optional[int] = None, databases: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, interval: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.QueryTimeGrainType]] = None, aggregation_function: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.AggregationFunctionType]] = None, observation_metric: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.MetricType]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.TopQueriesListResult][source]¶

Get top resource consuming queries of 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.
number_of_queries (int) – How many ‘top queries’ to return. Default is 5.
databases (str) – Comma separated list of databases to be included into search. All DB’s are included if this parameter is not specified.
start_time (str) – Start time for observed period.
end_time (str) – End time for observed period.
interval (str or QueryTimeGrainType) – The time step to be used to summarize the metric values. Default value is PT1H.
aggregation_function (str or AggregationFunctionType) – Aggregation function to be used, default value is ‘sum’.
observation_metric (str or MetricType) – Metric to be used for ranking top queries. Default is ‘cpu’.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TopQueriesListResult or the result of cls(response)

Return type

ItemPaged[TopQueriesListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceListResult][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.
expand (str) – The child resources to include in the response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedInstanceListResult or the result of cls(response)

Return type

ItemPaged[ManagedInstanceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy][source]¶

Sets 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.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (ManagedBackupShortTermRetentionPolicy) – The short term retention policy info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedBackupShortTermRetentionPolicy or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy][source]¶

Sets 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.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (ManagedBackupShortTermRetentionPolicy) – The short term retention policy info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedBackupShortTermRetentionPolicy or the result of cls(response)

Return type

ManagedBackupShortTermRetentionPolicy

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy[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) –
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedBackupShortTermRetentionPolicy, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_restorable_dropped_database(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicyListResult][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) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedBackupShortTermRetentionPolicyListResult or the result of cls(response)

Return type

ItemPaged[ManagedBackupShortTermRetentionPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedServerSecurityAlertPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedServerSecurityAlertPolicy][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.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
parameters (ManagedServerSecurityAlertPolicy) – The managed server security alert policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ManagedServerSecurityAlertPolicy or the result of cls(response)

Return type

LROPoller[ManagedServerSecurityAlertPolicy]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedServerSecurityAlertPolicy[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.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ManagedServerSecurityAlertPolicy, or the result of cls(response)

Return type

ManagedServerSecurityAlertPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedServerSecurityAlertPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagedServerSecurityAlertPolicyListResult or the result of cls(response)

Return type

ItemPaged[ManagedServerSecurityAlertPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

list(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.OperationListResult][source]¶

Lists all of the available SQL Rest API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either OperationListResult or the result of cls(response)
Return type: ItemPaged[OperationListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

OutboundFirewallRulesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, outbound_rule_fqdn: str, parameters: azure.mgmt.sql.models._models_py3.OutboundFirewallRule, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.OutboundFirewallRule][source]¶

Create a outbound firewall rule 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.
outbound_rule_fqdn (str) –
parameters (OutboundFirewallRule) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either OutboundFirewallRule or the result of cls(response)

Return type

LROPoller[OutboundFirewallRule]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, outbound_rule_fqdn: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a outbound firewall rule 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.
outbound_rule_fqdn (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[OutboundFirewallRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, outbound_rule_fqdn: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.OutboundFirewallRule[source]¶

Gets an outbound 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.
outbound_rule_fqdn (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OutboundFirewallRule, or the result of cls(response)

Return type

OutboundFirewallRule

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.OutboundFirewallRuleListResult][source]¶

Gets all outbound firewall rules 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either OutboundFirewallRuleListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.sql.models._models_py3.PrivateEndpointConnection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.PrivateEndpointConnection][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) –
parameters (PrivateEndpointConnection) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response)

Return type

LROPoller[PrivateEndpointConnection]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.PrivateEndpointConnection[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnection, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.PrivateEndpointConnectionListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)

Return type

ItemPaged[PrivateEndpointConnectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.PrivateLinkResource[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResource, or the result of cls(response)

Return type

PrivateLinkResource

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.PrivateLinkResourceListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateLinkResourceListResult or the result of cls(response)

Return type

ItemPaged[PrivateLinkResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

RecommendedSensitivityLabelsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

update(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.RecommendedSensitivityLabelUpdateList, **kwargs: Any) → None [source]¶

Update recommended sensitivity labels states of a given database using an operations batch.

Parameters

resource_group_name (str) – 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 (RecommendedSensitivityLabelUpdateList) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[RecoverableDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

RecoverableDatabasesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RecoverableDatabase[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecoverableDatabase, or the result of cls(response)

Return type

RecoverableDatabase

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RecoverableDatabaseListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RecoverableDatabaseListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, managed_instance_name: str, recoverable_database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RecoverableManagedDatabase[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) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecoverableManagedDatabase, or the result of cls(response)

Return type

RecoverableManagedDatabase

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RecoverableManagedDatabaseListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RecoverableManagedDatabaseListResult or the result of cls(response)

Return type

ItemPaged[RecoverableManagedDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_failover(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_failover_allow_data_loss(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_unlink(resource_group_name: str, server_name: str, database_name: str, link_id: str, parameters: azure.mgmt.sql.models._models_py3.UnlinkParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
parameters (UnlinkParameters) – The required parameters for unlinking replication link.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[ReplicationLinkListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ReplicationLink[source]¶

Gets a 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.
link_id (str) – The name of the replication link.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ReplicationLink, or the result of cls(response)

Return type

ReplicationLink

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ReplicationLinkListResult][source]¶

Gets a list of replication links on 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReplicationLinkListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ReplicationLinkListResult][source]¶

Gets a list of 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReplicationLinkListResult or the result of cls(response)

Return type

ItemPaged[ReplicationLinkListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, restorable_dropped_database_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RestorableDroppedDatabase[source]¶

Gets a restorable dropped 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.
restorable_dropped_database_id (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RestorableDroppedDatabase, or the result of cls(response)

Return type

RestorableDroppedDatabase

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RestorableDroppedDatabaseListResult][source]¶

Gets a list of restorable dropped 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableDroppedDatabaseListResult or the result of cls(response)

Return type

ItemPaged[RestorableDroppedDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RestorableDroppedManagedDatabase[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) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RestorableDroppedManagedDatabase, or the result of cls(response)

Return type

RestorableDroppedManagedDatabase

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RestorableDroppedManagedDatabaseListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorableDroppedManagedDatabaseListResult or the result of cls(response)

Return type

ItemPaged[RestorableDroppedManagedDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.CreateDatabaseRestorePointDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.RestorePoint][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.
parameters (CreateDatabaseRestorePointDefinition) – The definition for creating the restore point of this database.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either RestorePoint or the result of cls(response)

Return type

LROPoller[RestorePoint]

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, database_name: str, restore_point_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[RestorePointListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, restore_point_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RestorePoint[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RestorePoint, or the result of cls(response)

Return type

RestorePoint

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RestorePointListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RestorePointListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, parameters: azure.mgmt.sql.models._models_py3.SensitivityLabel, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SensitivityLabel[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SensitivityLabel, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

disable_recommendation(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

enable_recommendation(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, sensitivity_label_source: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SensitivityLabelSource], **kwargs: Any) → azure.mgmt.sql.models._models_py3.SensitivityLabel[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SensitivityLabel, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_current_by_database(resource_group_name: str, server_name: str, database_name: str, skip_token: Optional[str] = None, count: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SensitivityLabelListResult][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.
skip_token (str) –
count (bool) –
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SensitivityLabelListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_recommended_by_database(resource_group_name: str, server_name: str, database_name: str, skip_token: Optional[str] = None, include_disabled_recommendations: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SensitivityLabelListResult][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.
skip_token (str) –
include_disabled_recommendations (bool) – Specifies whether to include disabled recommendations or not.
filter (str) – An OData filter expression that filters elements in the collection.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SensitivityLabelListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.SensitivityLabelUpdateList, **kwargs: Any) → None [source]¶

Update sensitivity labels of a given database using an operations batch.

Parameters

resource_group_name (str) – 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 (SensitivityLabelUpdateList) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ServerAdvisorsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, advisor_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Advisor[source]¶

Gets a server 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.
advisor_name (str) – The name of the Server Advisor.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Advisor, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, expand: Optional[str] = None, **kwargs: Any) → List[azure.mgmt.sql.models._models_py3.Advisor][source]¶

Gets a list of server advisors.

Parameters

resource_group_name (str) – 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.
expand (str) – The child resources to include in the response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

list of Advisor, or the result of cls(response)

Return type

list[Advisor]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, server_name: str, advisor_name: str, parameters: azure.mgmt.sql.models._models_py3.Advisor, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Advisor[source]¶

Updates a server 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.
advisor_name (str) – The name of the Server Advisor.
parameters (Advisor) – The requested advisor resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Advisor, or the result of cls(response)

Return type

LROPoller[ServerAzureADAdministrator]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerAutomaticTuning[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerAutomaticTuning, or the result of cls(response)

Return type

ServerAutomaticTuning

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerAutomaticTuning, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerAutomaticTuning[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.
parameters (ServerAutomaticTuning) – The requested automatic tuning resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerAutomaticTuning, or the result of cls(response)

Return type

ServerAutomaticTuning

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], parameters: azure.mgmt.sql.models._models_py3.ServerAzureADAdministrator, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerAzureADAdministrator][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.
administrator_name (str or AdministratorName) – The name of server active directory administrator.
parameters (ServerAzureADAdministrator) – The requested Azure Active Directory administrator Resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerAzureADAdministrator or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
administrator_name (str or AdministratorName) – The name of server active directory administrator.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ServerAzureADAdministrator

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerAzureADAdministrator[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.
administrator_name (str or AdministratorName) – The name of server active directory administrator.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerAzureADAdministrator, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.AdministratorListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AdministratorListResult or the result of cls(response)

Return type

ItemPaged[AdministratorListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], parameters: azure.mgmt.sql.models._models_py3.ServerAzureADOnlyAuthentication, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerAzureADOnlyAuthentication][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.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.
parameters (ServerAzureADOnlyAuthentication) – The required parameters for creating or updating an Active Directory only authentication property.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerAzureADOnlyAuthentication or the result of cls(response)

Return type

LROPoller[ServerAzureADOnlyAuthentication]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ServerAzureADOnlyAuthentication

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerAzureADOnlyAuthentication[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.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerAzureADOnlyAuthentication, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.AzureADOnlyAuthListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AzureADOnlyAuthListResult or the result of cls(response)

Return type

ItemPaged[AzureADOnlyAuthListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerBlobAuditingPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerBlobAuditingPolicy][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerBlobAuditingPolicy or the result of cls(response)

Return type

LROPoller[ServerBlobAuditingPolicy]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerBlobAuditingPolicy[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerBlobAuditingPolicy, or the result of cls(response)

Return type

ServerBlobAuditingPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerBlobAuditingPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerBlobAuditingPolicyListResult or the result of cls(response)

Return type

ItemPaged[ServerBlobAuditingPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, communication_link_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerCommunicationLink, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerCommunicationLink][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.
parameters (ServerCommunicationLink) – The required parameters for creating a server communication link.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerCommunicationLink or the result of cls(response)

Return type

LROPoller[ServerCommunicationLink]

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, communication_link_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[ServerCommunicationLinkListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, communication_link_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerCommunicationLink[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerCommunicationLink, or the result of cls(response)

Return type

ServerCommunicationLink

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerCommunicationLinkListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerCommunicationLinkListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, connection_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ConnectionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ServerConnectionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerConnectionPolicy][source]¶

Updates a server 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_policy_name (str or ConnectionPolicyName) – The name of the connection policy.
parameters (ServerConnectionPolicy) – The required parameters for updating a server connection policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerConnectionPolicy or the result of cls(response)

Return type

LROPoller[ServerConnectionPolicy]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, connection_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ConnectionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerConnectionPolicy[source]¶

Gets a server 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_policy_name (str or ConnectionPolicyName) – The name of the connection policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerConnectionPolicy, or the result of cls(response)

Return type

ServerConnectionPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerConnectionPolicyListResult][source]¶

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerConnectionPolicyListResult or the result of cls(response)

Return type

ItemPaged[ServerConnectionPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ServerDevOpsAuditSettingsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, dev_ops_auditing_settings_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerDevOpsAuditingSettings, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerDevOpsAuditingSettings][source]¶

Creates or updates a server’s DevOps audit settings.

Parameters

resource_group_name (str) – 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.
dev_ops_auditing_settings_name (str) – The name of the devops audit settings. This should always be ‘default’.
parameters (ServerDevOpsAuditingSettings) – Properties of DevOps audit settings.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerDevOpsAuditingSettings or the result of cls(response)

Return type

LROPoller[ServerDevOpsAuditingSettings]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, dev_ops_auditing_settings_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerDevOpsAuditingSettings[source]¶

Gets a server’s DevOps audit settings.

Parameters

resource_group_name (str) – 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.
dev_ops_auditing_settings_name (str) – The name of the devops audit settings. This should always be ‘default’.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerDevOpsAuditingSettings, or the result of cls(response)

Return type

ServerDevOpsAuditingSettings

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerDevOpsAuditSettingsListResult][source]¶

Lists DevOps audit 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerDevOpsAuditSettingsListResult or the result of cls(response)

Return type

ItemPaged[ServerDevOpsAuditSettingsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_acquire(resource_group_name: str, server_name: str, dns_alias_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerDnsAliasAcquisition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerDnsAlias][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.
parameters (ServerDnsAliasAcquisition) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerDnsAlias or the result of cls(response)

Return type

LROPoller[ServerDnsAlias]

Raises

~azure.core.exceptions.HttpResponseError

begin_create_or_update(resource_group_name: str, server_name: str, dns_alias_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerDnsAlias][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerDnsAlias or the result of cls(response)

Return type

LROPoller[ServerDnsAlias]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, dns_alias_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[ServerDnsAliasListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, dns_alias_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerDnsAlias[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerDnsAlias, or the result of cls(response)

Return type

ServerDnsAlias

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerDnsAliasListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerDnsAliasListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, key_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerKey, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerKey][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/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.
parameters (ServerKey) – The requested server key resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerKey or the result of cls(response)

Return type

LROPoller[ServerKey]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, key_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[ServerKeyListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, key_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerKey[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerKey, or the result of cls(response)

Return type

ServerKey

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerKeyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerKeyListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ServerOperationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerOperationListResult][source]¶

Gets a list of operations performed on the 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerOperationListResult or the result of cls(response)

Return type

ItemPaged[ServerOperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.sql.models._models_py3.ServerSecurityAlertPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerSecurityAlertPolicy][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.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the threat detection policy.
parameters (ServerSecurityAlertPolicy) – The server security alert policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerSecurityAlertPolicy or the result of cls(response)

Return type

LROPoller[ServerSecurityAlertPolicy]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerSecurityAlertPolicy[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.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerSecurityAlertPolicy, or the result of cls(response)

Return type

ServerSecurityAlertPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LogicalServerSecurityAlertPolicyListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LogicalServerSecurityAlertPolicyListResult or the result of cls(response)

Return type

ItemPaged[LogicalServerSecurityAlertPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ServerTrustCertificatesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, managed_instance_name: str, certificate_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerTrustCertificate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerTrustCertificate][source]¶

Uploads a server trust certificate from box to Sql 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.
certificate_name (str) – Name of of the certificate to upload.
parameters (ServerTrustCertificate) – The server trust certificate info.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerTrustCertificate or the result of cls(response)

Return type

LROPoller[ServerTrustCertificate]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, managed_instance_name: str, certificate_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a server trust certificate that was uploaded from box to Sql 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.
certificate_name (str) – Name of of the certificate to delete.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[ServerTrustCertificatesListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, certificate_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerTrustCertificate[source]¶

Gets a server trust certificate that was uploaded from box to Sql 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.
certificate_name (str) – Name of of the certificate to get.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerTrustCertificate, or the result of cls(response)

Return type

ServerTrustCertificate

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerTrustCertificatesListResult][source]¶

Gets a list of the server trust certificates which are used for secure communication between SQL On-Prem instance and the given Sql 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerTrustCertificatesListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

ServerTrustGroupsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, location_name: str, server_trust_group_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerTrustGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerTrustGroup][source]¶

Creates or updates a server trust 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.
server_trust_group_name (str) – The name of the server trust group.
parameters (ServerTrustGroup) – The server trust group parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerTrustGroup or the result of cls(response)

Return type

LROPoller[ServerTrustGroup]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, location_name: str, server_trust_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a server trust 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.
server_trust_group_name (str) – The name of the server trust group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[ServerTrustGroupListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, location_name: str, server_trust_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerTrustGroup[source]¶

Gets a server trust 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.
server_trust_group_name (str) – The name of the server trust group.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerTrustGroup, or the result of cls(response)

Return type

ServerTrustGroup

Raises

~azure.core.exceptions.HttpResponseError

list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerTrustGroupListResult][source]¶

Gets a server trust groups by instance 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerTrustGroupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_location(resource_group_name: str, location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerTrustGroupListResult][source]¶

Lists a server trust 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerTrustGroupListResult or the result of cls(response)

Return type

ItemPaged[ServerTrustGroupListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerUsageListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerUsageListResult or the result of cls(response)

Return type

ItemPaged[ServerUsageListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], parameters: azure.mgmt.sql.models._models_py3.ServerVulnerabilityAssessment, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerVulnerabilityAssessment[source]¶

Creates or updates the server’s vulnerability assessment. Learn more about setting SQL vulnerability assessment with managed identity - https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage.

Parameters

resource_group_name (str) – 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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
parameters (ServerVulnerabilityAssessment) – The requested resource.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerVulnerabilityAssessment, or the result of cls(response)

Return type

ServerVulnerabilityAssessment

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → None [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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ServerVulnerabilityAssessment

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerVulnerabilityAssessment[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.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerVulnerabilityAssessment, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerVulnerabilityAssessmentListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerVulnerabilityAssessmentListResult or the result of cls(response)

Return type

ItemPaged[ServerVulnerabilityAssessmentListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.Server, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Server][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Server or the result of cls(response)

Return type

LROPoller[Server]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[ImportExportOperationResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_import_database(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ImportNewDatabaseDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ImportExportOperationResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ImportExportOperationResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Server][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Server or the result of cls(response)

Return type

LROPoller[Server]

Raises

~azure.core.exceptions.HttpResponseError

check_name_availability(parameters: azure.mgmt.sql.models._models_py3.CheckNameAvailabilityRequest, **kwargs: Any) → azure.mgmt.sql.models._models_py3.CheckNameAvailabilityResponse[source]¶

Determines whether a resource can be created with the specified name.

Parameters: parameters (CheckNameAvailabilityRequest) – The name availability request parameters.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: CheckNameAvailabilityResponse, or the result of cls(response)
Return type: CheckNameAvailabilityResponse
Raises: ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Server[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.
expand (str) – The child resources to include in the response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Server, or the result of cls(response)

Return type

Server

Raises

~azure.core.exceptions.HttpResponseError

list(expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerListResult][source]¶

Gets a list of all servers in the subscription.

Parameters: expand (str) – The child resources to include in the response.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ServerListResult or the result of cls(response)
Return type: ItemPaged[ServerListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerListResult][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.
expand (str) – The child resources to include in the response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServerListResult or the result of cls(response)

Return type

ItemPaged[ServerListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(resource_group_name: str, server_name: str, service_objective_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServiceObjective[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceObjective, or the result of cls(response)

Return type

ServiceObjective

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServiceObjectiveListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ServiceObjectiveListResult or the result of cls(response)

Return type

ItemPaged[ServiceObjectiveListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

SqlAgentOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, managed_instance_name: str, parameters: azure.mgmt.sql.models._models_py3.SqlAgentConfiguration, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SqlAgentConfiguration[source]¶

Puts new sql agent configuration to 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 (SqlAgentConfiguration) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlAgentConfiguration, or the result of cls(response)

Return type

SqlAgentConfiguration

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SqlAgentConfiguration[source]¶

Gets current instance sql agent 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.
managed_instance_name (str) – The name of the managed instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SqlAgentConfiguration, or the result of cls(response)

Return type

SqlAgentConfiguration

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(location_name: str, usage_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SubscriptionUsage[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SubscriptionUsage, or the result of cls(response)

Return type

SubscriptionUsage

Raises

~azure.core.exceptions.HttpResponseError

list_by_location(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SubscriptionUsageListResult][source]¶

Gets all subscription usage metrics in a given location.

Parameters: location_name (str) – The name of the region where the resource is located.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SubscriptionUsageListResult or the result of cls(response)
Return type: ItemPaged[SubscriptionUsageListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, sync_agent_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncAgent, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncAgent][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.
parameters (SyncAgent) – The requested sync agent resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SyncAgent or the result of cls(response)

Return type

LROPoller[SyncAgent]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[SyncAgentListResult]

Raises

~azure.core.exceptions.HttpResponseError

generate_key(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SyncAgentKeyProperties[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SyncAgentKeyProperties, or the result of cls(response)

Return type

SyncAgentKeyProperties

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SyncAgent[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SyncAgent, or the result of cls(response)

Return type

SyncAgent

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncAgentListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncAgentListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_linked_databases(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncAgentLinkedDatabaseListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncAgentLinkedDatabaseListResult or the result of cls(response)

Return type

ItemPaged[SyncAgentLinkedDatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SyncGroup or the result of cls(response)

Return type

LROPoller[SyncGroup]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_refresh_hub_schema(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SyncGroup or the result of cls(response)

Return type

LROPoller[SyncGroup]

Raises

~azure.core.exceptions.HttpResponseError

cancel_sync(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[SyncGroupListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SyncGroup[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SyncGroup, or the result of cls(response)

Return type

SyncGroup

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncGroupListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncGroupListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_hub_schemas(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncFullSchemaPropertiesListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncFullSchemaPropertiesListResult or the result of cls(response)

Return type

ItemPaged[SyncFullSchemaPropertiesListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_logs(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, start_time: str, end_time: str, type: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SyncGroupsType], continuation_token_parameter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncGroupLogListResult][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 or SyncGroupsType) – The types of logs to retrieve.
continuation_token_parameter (str) – The continuation token for this operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncGroupLogListResult or the result of cls(response)

Return type

ItemPaged[SyncGroupLogListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_sync_database_ids(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncDatabaseIdListResult][source]¶

Gets a collection of sync database ids.

Parameters: location_name (str) – The name of the region where the resource is located.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either SyncDatabaseIdListResult or the result of cls(response)
Return type: ItemPaged[SyncDatabaseIdListResult]
Raises: ~azure.core.exceptions.HttpResponseError

trigger_sync(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → None [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncMember, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncMember][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SyncMember or the result of cls(response)

Return type

LROPoller[SyncMember]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

begin_refresh_member_schema(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[SyncMemberListResult]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncMember, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncMember][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SyncMember or the result of cls(response)

Return type

LROPoller[SyncMember]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SyncMember[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SyncMember, or the result of cls(response)

Return type

SyncMember

Raises

~azure.core.exceptions.HttpResponseError

list_by_sync_group(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncMemberListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncMemberListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_member_schemas(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncFullSchemaPropertiesListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SyncFullSchemaPropertiesListResult or the result of cls(response)

Return type

ItemPaged[SyncFullSchemaPropertiesListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.TdeCertificate, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.
parameters (TdeCertificate) – The requested TDE certificate to be created or updated.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LogicalDatabaseTransparentDataEncryption or None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶

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

Bases: object

TimeZonesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

get(location_name: str, time_zone_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.TimeZone[source]¶

Gets a managed instance time zone.

Parameters

location_name (str) –
time_zone_id (str) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TimeZone, or the result of cls(response)

Return type

TimeZone

Raises

~azure.core.exceptions.HttpResponseError

list_by_location(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.TimeZoneListResult][source]¶

Gets a list of managed instance time zones by location.

Parameters: location_name (str) –
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either TimeZoneListResult or the result of cls(response)
Return type: ItemPaged[TimeZoneListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

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: str, server_name: str, database_name: str, tde_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionName], parameters: azure.mgmt.sql.models._models_py3.LogicalDatabaseTransparentDataEncryption, **kwargs: Any) → Optional[azure.mgmt.sql.models._models_py3.LogicalDatabaseTransparentDataEncryption][source]¶

Updates a logical 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 logical database for which the security alert policy is defined.
tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration.
parameters (LogicalDatabaseTransparentDataEncryption) – The database transparent data encryption.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LogicalDatabaseTransparentDataEncryption, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, tde_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.LogicalDatabaseTransparentDataEncryption[source]¶

Gets a logical database’s transparent data encryption.

Parameters

resource_group_name (str) – 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 logical database for which the transparent data encryption is defined.
tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LogicalDatabaseTransparentDataEncryption, or the result of cls(response)

Return type

LogicalDatabaseTransparentDataEncryption

Raises

~azure.core.exceptions.HttpResponseError

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LogicalDatabaseTransparentDataEncryptionListResult][source]¶

Gets a list of the logical database’s transparent data encryption.

Parameters

resource_group_name (str) – 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 logical database for which the transparent data encryption is defined.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LogicalDatabaseTransparentDataEncryptionListResult or the result of cls(response)

Return type

ItemPaged[LogicalDatabaseTransparentDataEncryptionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

list_by_instance_pool(resource_group_name: str, instance_pool_name: str, expand_children: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.UsageListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UsageListResult or the result of cls(response)

Return type

ItemPaged[UsageListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_delete(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[VirtualCluster]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, virtual_cluster_name: str, parameters: azure.mgmt.sql.models._models_py3.VirtualClusterUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.VirtualCluster][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.
parameters (VirtualClusterUpdate) – The requested virtual cluster resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either VirtualCluster or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.VirtualCluster[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualCluster, or the result of cls(response)

Return type

VirtualCluster

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VirtualClusterListResult][source]¶

Gets a list of all virtualClusters in the subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either VirtualClusterListResult or the result of cls(response)
Return type: ItemPaged[VirtualClusterListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VirtualClusterListResult][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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either VirtualClusterListResult or the result of cls(response)
Return type: ItemPaged[VirtualClusterListResult]
Raises: ~azure.core.exceptions.HttpResponseError

update_dns_servers(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.UpdateManagedInstanceDnsServersOperation[source]¶

Synchronizes the DNS server settings used by the managed instances inside the given 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

UpdateManagedInstanceDnsServersOperation, or the result of cls(response)

Return type

UpdateManagedInstanceDnsServersOperation

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, virtual_network_rule_name: str, parameters: azure.mgmt.sql.models._models_py3.VirtualNetworkRule, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.VirtualNetworkRule][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.
parameters (VirtualNetworkRule) – The requested virtual Network Rule Resource state.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either VirtualNetworkRule or the result of cls(response)

Return type

LROPoller[VirtualNetworkRule]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, virtual_network_rule_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[VirtualNetworkRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, virtual_network_rule_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.VirtualNetworkRule[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualNetworkRule, or the result of cls(response)

Return type

VirtualNetworkRule

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VirtualNetworkRuleListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VirtualNetworkRuleListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, workload_classifier_name: str, parameters: azure.mgmt.sql.models._models_py3.WorkloadClassifier, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.WorkloadClassifier][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either WorkloadClassifier or the result of cls(response)

Return type

LROPoller[WorkloadClassifier]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, workload_classifier_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

ItemPaged[WorkloadClassifierListResult]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, workload_classifier_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.WorkloadClassifier[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WorkloadClassifier, or the result of cls(response)

Return type

WorkloadClassifier

Raises

~azure.core.exceptions.HttpResponseError

list_by_workload_group(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.WorkloadClassifierListResult][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WorkloadClassifierListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/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 this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

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

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, parameters: azure.mgmt.sql.models._models_py3.WorkloadGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.WorkloadGroup][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either WorkloadGroup or the result of cls(response)

Return type

LROPoller[WorkloadGroup]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type