azure.mgmt.sql.operations module

class azure.mgmt.sql.operations.BackupShortTermRetentionPoliciesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s backup_short_term_retention_policies attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, _models.ShortTermRetentionPolicyName], parameters: _models.BackupShortTermRetentionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupShortTermRetentionPolicy][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, _models.ShortTermRetentionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupShortTermRetentionPolicy]

Updates a database’s short term retention policy.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or ShortTermRetentionPolicyName) – The policy name. Should always be “default”. “default” Required.

  • parameters (BackupShortTermRetentionPolicy or IO) – The short term retention policy info. Is either a BackupShortTermRetentionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 BackupShortTermRetentionPolicy or the result of cls(response)

Return type

LROPoller[BackupShortTermRetentionPolicy]

Raises

HttpResponseError –

begin_update(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, _models.ShortTermRetentionPolicyName], parameters: _models.BackupShortTermRetentionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupShortTermRetentionPolicy][source]
begin_update(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, _models.ShortTermRetentionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.BackupShortTermRetentionPolicy]

Updates a database’s short term retention policy.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or ShortTermRetentionPolicyName) – The policy name. Should always be “default”. “default” Required.

  • parameters (BackupShortTermRetentionPolicy or IO) – The short term retention policy info. Is either a BackupShortTermRetentionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 BackupShortTermRetentionPolicy or the result of cls(response)

Return type

LROPoller[BackupShortTermRetentionPolicy]

Raises

HttpResponseError –

get(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ShortTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.BackupShortTermRetentionPolicy[source]

Gets a database’s short term retention policy.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or ShortTermRetentionPolicyName) – The policy name. Should always be “default”. “default” Required.

Keyword Arguments

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

Returns

BackupShortTermRetentionPolicy or the result of cls(response)

Return type

BackupShortTermRetentionPolicy

Raises

HttpResponseError –

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

Gets a database’s short term retention policy.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[BackupShortTermRetentionPolicy]

Raises

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.CapabilitiesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s capabilities attribute.

list_by_location(location_name: str, include: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CapabilityGroup]] = None, **kwargs: Any) → azure.mgmt.sql.models._models_py3.LocationCapabilities[source]

Gets the subscription capabilities available for the specified location.

Parameters

  • location_name (str) – The location name whose capabilities are retrieved. Required.

  • include (str or CapabilityGroup) – If specified, restricts the response to only include the selected item. Known values are: “supportedEditions”, “supportedElasticPoolEditions”, “supportedManagedInstanceVersions”, “supportedInstancePoolEditions”, and “supportedManagedInstanceEditions”. Default value is None.

Keyword Arguments

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

Returns

LocationCapabilities or the result of cls(response)

Return type

LocationCapabilities

Raises

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.DataMaskingPoliciesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s data_masking_policies attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.DataMaskingPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataMaskingPolicy[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataMaskingPolicy

Creates or updates a database data masking policy.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (DataMaskingPolicy or IO) – Parameters for creating or updating a data masking policy. Is either a DataMaskingPolicy type or a IO type. Required.

Keyword Arguments

  • data_masking_policy_name (str) – The name of the database for which the data masking rule applies. Default value is “Default”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DataMaskingPolicy or the result of cls(response)

Return type

DataMaskingPolicy

Raises

HttpResponseError –

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

Gets a database data masking policy.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

  • data_masking_policy_name (str) – The name of the database for which the data masking rule applies. Default value is “Default”. Note that overriding this default value may result in unsupported behavior.

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

Returns

DataMaskingPolicy or the result of cls(response)

Return type

DataMaskingPolicy

Raises

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.DataMaskingRulesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s data_masking_rules attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, data_masking_rule_name: str, parameters: _models.DataMaskingRule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataMaskingRule[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, data_masking_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataMaskingRule

Creates or updates a database data masking rule.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • data_masking_rule_name (str) – The name of the data masking rule. Required.

  • parameters (DataMaskingRule or IO) – The required parameters for creating or updating a data masking rule. Is either a DataMaskingRule type or a IO type. Required.

Keyword Arguments

  • data_masking_policy_name (str) – The name of the database for which the data masking rule applies. Default value is “Default”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DataMaskingRule or the result of cls(response)

Return type

DataMaskingRule

Raises

HttpResponseError –

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

Gets a list of database data masking rules.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

  • data_masking_policy_name (str) – The name of the database for which the data masking rule applies. Default value is “Default”. Note that overriding this default value may result in unsupported behavior.

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

Returns

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

Return type

ItemPaged[DataMaskingRule]

Raises

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.DataWarehouseUserActivitiesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s data_warehouse_user_activities attribute.

get(resource_group_name: str, server_name: str, database_name: str, data_warehouse_user_activity_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.DataWarehouseUserActivityName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DataWarehouseUserActivities[source]

Gets the user activities of a data warehouse which includes running and suspended queries.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • data_warehouse_user_activity_name (str or DataWarehouseUserActivityName) – The activity name of the data warehouse. “current” Required.

Keyword Arguments

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

Returns

DataWarehouseUserActivities or the result of cls(response)

Return type

DataWarehouseUserActivities

Raises

HttpResponseError –

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

List the user activities of a data warehouse which includes running and suspended queries.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DataWarehouseUserActivities]

Raises

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.DatabaseAdvancedThreatProtectionSettingsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_advanced_threat_protection_settings attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, advanced_threat_protection_name: Union[str, _models.AdvancedThreatProtectionName], parameters: _models.DatabaseAdvancedThreatProtection, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseAdvancedThreatProtection[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, advanced_threat_protection_name: Union[str, _models.AdvancedThreatProtectionName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseAdvancedThreatProtection

Creates or updates a database’s Advanced Threat Protection state.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state. “Default” Required.

  • parameters (DatabaseAdvancedThreatProtection or IO) – The database Advanced Threat Protection state. Is either a DatabaseAdvancedThreatProtection type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseAdvancedThreatProtection or the result of cls(response)

Return type

DatabaseAdvancedThreatProtection

Raises

HttpResponseError –

get(resource_group_name: str, server_name: str, database_name: str, advanced_threat_protection_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdvancedThreatProtectionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseAdvancedThreatProtection[source]

Gets a database’s Advanced Threat Protection state.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state. “Default” Required.

Keyword Arguments

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

Returns

DatabaseAdvancedThreatProtection or the result of cls(response)

Return type

DatabaseAdvancedThreatProtection

Raises

HttpResponseError –

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

Gets a list of database’s Advanced Threat Protection states.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseAdvancedThreatProtection]

Raises

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.DatabaseAdvisorsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_advisors attribute.

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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • advisor_name (str) – The name of the Database Advisor. Required.

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

Advisor

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

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

HttpResponseError –

update(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, parameters: _models.Advisor, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Advisor[source]
update(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Advisor

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • advisor_name (str) – The name of the Database Advisor. Required.

  • parameters (Advisor or IO) – The requested advisor resource state. Is either a Advisor type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

Advisor or the result of cls(response)

Return type

Advisor

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_automatic_tuning attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

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

HttpResponseError –

update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.DatabaseAutomaticTuning, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseAutomaticTuning[source]
update(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseAutomaticTuning

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (DatabaseAutomaticTuning or IO) – The requested automatic tuning resource state. Is either a DatabaseAutomaticTuning type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_blob_auditing_policies attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.DatabaseBlobAuditingPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseBlobAuditingPolicy[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseBlobAuditingPolicy

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (DatabaseBlobAuditingPolicy or IO) – The database blob auditing policy. Is either a DatabaseBlobAuditingPolicy type or a IO type. Required.

Keyword Arguments

  • blob_auditing_policy_name (str) – The name of the blob auditing policy. Default value is “default”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

  • blob_auditing_policy_name (str) – The name of the blob auditing policy. Default value is “default”. Note that overriding this default value may result in unsupported behavior.

  • 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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseBlobAuditingPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_columns attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

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

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.DatabaseColumn][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema (list[str]) – Default value is None.

  • table (list[str]) – Default value is None.

  • column (list[str]) – Default value is None.

  • order_by (list[str]) – Default value is None.

  • skiptoken (str) – An opaque token that identifies a starting point in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseColumn]

Raises

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.DatabaseColumn][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseColumn]

Raises

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.DatabaseEncryptionProtectorsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_encryption_protectors attribute.

begin_revalidate(resource_group_name: str, server_name: str, database_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 for a particular 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated. “current” Required.

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[None]

Raises

HttpResponseError –

begin_revert(resource_group_name: str, server_name: str, database_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]

Reverts an existing encryption protector for a particular 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated. “current” Required.

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[None]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_extensions attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, extension_name: str, parameters: _models.DatabaseExtensions, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImportExportExtensionsOperationResult][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, extension_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImportExportExtensionsOperationResult]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • extension_name (str) – Required.

  • parameters (DatabaseExtensions or IO) – The database import request parameters. Is either a DatabaseExtensions type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ImportExportExtensionsOperationResult]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • extension_name (str) – Required.

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

None

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ImportExportExtensionsOperationResult]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_operations attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • operation_id (str) – The operation identifier. Required.

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

None

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseOperation]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_recommended_actions attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • advisor_name (str) – The name of the Database Advisor. Required.

  • recommended_action_name (str) – The name of Database Recommended Action. Required.

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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • advisor_name (str) – The name of the Database Advisor. Required.

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

HttpResponseError –

update(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, recommended_action_name: str, parameters: _models.RecommendedAction, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecommendedAction[source]
update(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, recommended_action_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecommendedAction

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • advisor_name (str) – The name of the Database Advisor. Required.

  • recommended_action_name (str) – The name of Database Recommended Action. Required.

  • parameters (RecommendedAction or IO) – The requested recommended action resource state. Is either a RecommendedAction type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_schemas attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

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

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.DatabaseSchema][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseSchema]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_security_alert_policies attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: _models.DatabaseSecurityAlertPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSecurityAlertPolicy[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSecurityAlertPolicy

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the security alert policy is defined. Required.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy. “Default” Required.

  • parameters (DatabaseSecurityAlertPolicy or IO) – The database security alert policy. Is either a DatabaseSecurityAlertPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the security alert policy is defined. Required.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy. “Default” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the security alert policy is defined. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseSecurityAlertPolicy]

Raises

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.DatabaseSqlVulnerabilityAssessmentBaselinesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_sql_vulnerability_assessment_baselines attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], baseline_name: Union[str, _models.BaselineName], parameters: _models.DatabaseSqlVulnerabilityAssessmentRuleBaselineListInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSqlVulnerabilityAssessmentBaselineSet[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], baseline_name: Union[str, _models.BaselineName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSqlVulnerabilityAssessmentBaselineSet

Add a database’s vulnerability assessment rule baseline 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

  • parameters (DatabaseSqlVulnerabilityAssessmentRuleBaselineListInput or IO) – The requested rule baseline resource. Is either a DatabaseSqlVulnerabilityAssessmentRuleBaselineListInput type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseSqlVulnerabilityAssessmentBaselineSet or the result of cls(response)

Return type

DatabaseSqlVulnerabilityAssessmentBaselineSet

Raises

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], baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.BaselineName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSqlVulnerabilityAssessmentBaselineSet[source]

Gets a list of database’s sql vulnerability assessment rule baselines.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

Keyword Arguments

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

Returns

DatabaseSqlVulnerabilityAssessmentBaselineSet or the result of cls(response)

Return type

DatabaseSqlVulnerabilityAssessmentBaselineSet

Raises

HttpResponseError –

list_by_sql_vulnerability_assessment(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.DatabaseSqlVulnerabilityAssessmentBaselineSet][source]

Gets a list of database’s sql vulnerability assessment rule baselines.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseSqlVulnerabilityAssessmentBaselineSet]

Raises

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.DatabaseSqlVulnerabilityAssessmentExecuteScanOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_sql_vulnerability_assessment_execute_scan attribute.

begin_execute(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.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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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[None]

Raises

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.DatabaseSqlVulnerabilityAssessmentRuleBaselinesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_sql_vulnerability_assessment_rule_baselines attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], baseline_name: Union[str, _models.BaselineName], rule_id: str, parameters: _models.DatabaseSqlVulnerabilityAssessmentRuleBaselineInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSqlVulnerabilityAssessmentRuleBaseline[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], baseline_name: Union[str, _models.BaselineName], rule_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSqlVulnerabilityAssessmentRuleBaseline

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

  • parameters (DatabaseSqlVulnerabilityAssessmentRuleBaselineInput or IO) – The requested rule baseline resource. Is either a DatabaseSqlVulnerabilityAssessmentRuleBaselineInput type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseSqlVulnerabilityAssessmentRuleBaseline or the result of cls(response)

Return type

DatabaseSqlVulnerabilityAssessmentRuleBaseline

Raises

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], baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.BaselineName], rule_id: str, **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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

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

None

Raises

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], baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.BaselineName], rule_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSqlVulnerabilityAssessmentRuleBaseline[source]

Gets a database’s sql 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

Keyword Arguments

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

Returns

DatabaseSqlVulnerabilityAssessmentRuleBaseline or the result of cls(response)

Return type

DatabaseSqlVulnerabilityAssessmentRuleBaseline

Raises

HttpResponseError –

list_by_baseline(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.BaselineName], **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseSqlVulnerabilityAssessmentRuleBaseline][source]

Gets a list of database’s sql vulnerability assessment rule baselines.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseSqlVulnerabilityAssessmentRuleBaseline]

Raises

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.DatabaseSqlVulnerabilityAssessmentScanResultOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_sql_vulnerability_assessment_scan_result attribute.

get(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SQLVulnerabilityAssessmentName], scan_id: str, scan_result_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SqlVulnerabilityAssessmentScanResults[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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or SQLVulnerabilityAssessmentName) – The name of the SQL Vulnerability Assessment. “default” Required.

  • scan_id (str) – The scan id of the SQL Vulnerability Assessment scan to retrieve result from. Required.

  • scan_result_id (str) – The scan result id of the specific result to retrieve. Required.

Keyword Arguments

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

Returns

SqlVulnerabilityAssessmentScanResults or the result of cls(response)

Return type

SqlVulnerabilityAssessmentScanResults

Raises

HttpResponseError –

list_by_scan(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SQLVulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SqlVulnerabilityAssessmentScanResults][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or SQLVulnerabilityAssessmentName) – The name of the SQL Vulnerability Assessment. “default” Required.

  • scan_id (str) – The scan id of the SQL Vulnerability Assessment scan to retrieve result from. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlVulnerabilityAssessmentScanResults]

Raises

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.DatabaseSqlVulnerabilityAssessmentScansOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_sql_vulnerability_assessment_scans attribute.

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

Get a database vulnerability assessment scan result.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve. Required.

Keyword Arguments

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

Returns

SqlVulnerabilityAssessmentScanRecord or the result of cls(response)

Return type

SqlVulnerabilityAssessmentScanRecord

Raises

HttpResponseError –

list_by_sql_vulnerability_assessments(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.SqlVulnerabilityAssessmentScanRecord][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlVulnerabilityAssessmentScanRecord]

Raises

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.DatabaseSqlVulnerabilityAssessmentsSettingsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_sql_vulnerability_assessments_settings attribute.

get(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SqlVulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.SqlVulnerabilityAssessment[source]

Gets SQL Vulnerability Assessment policy for 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or SqlVulnerabilityAssessmentName) – The name of the SQL Vulnerability Assessment. “default” Required.

Keyword Arguments

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

Returns

SqlVulnerabilityAssessment or the result of cls(response)

Return type

SqlVulnerabilityAssessment

Raises

HttpResponseError –

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

Lists SQL 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlVulnerabilityAssessment]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_tables attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

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

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.DatabaseTable][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseTable]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_usages attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseUsage]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_vulnerability_assessment_rule_baselines attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, _models.VulnerabilityAssessmentPolicyBaselineName], parameters: _models.DatabaseVulnerabilityAssessmentRuleBaseline, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseVulnerabilityAssessmentRuleBaseline[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, _models.VulnerabilityAssessmentPolicyBaselineName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseVulnerabilityAssessmentRuleBaseline

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

  • 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). Known values are: “master” and “default”. Required.

  • parameters (DatabaseVulnerabilityAssessmentRuleBaseline or IO) – The requested rule baseline resource. Is either a DatabaseVulnerabilityAssessmentRuleBaseline type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseVulnerabilityAssessmentRuleBaseline or the result of cls(response)

Return type

DatabaseVulnerabilityAssessmentRuleBaseline

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

  • 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). Known values are: “master” and “default”. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

  • 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). Known values are: “master” and “default”. Required.

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

DatabaseVulnerabilityAssessmentRuleBaseline

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_vulnerability_assessment_scans attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the scanned database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • scan_id (str) – The vulnerability assessment scan Id. Required.

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

DatabaseVulnerabilityAssessmentScansExport

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve. Required.

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

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.VulnerabilityAssessmentScanRecord][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VulnerabilityAssessmentScanRecord]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s database_vulnerability_assessments attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: _models.DatabaseVulnerabilityAssessment, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseVulnerabilityAssessment[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseVulnerabilityAssessment

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • parameters (DatabaseVulnerabilityAssessment or IO) – The requested resource. Is either a DatabaseVulnerabilityAssessment type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseVulnerabilityAssessment or the result of cls(response)

Return type

DatabaseVulnerabilityAssessment

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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

DatabaseVulnerabilityAssessment

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment policies are defined. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseVulnerabilityAssessment]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s databases attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.Database, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Database][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Database]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (Database or IO) – The requested database resource state. Is either a Database type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[Database]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

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[None]

Raises

HttpResponseError –

begin_export(resource_group_name: str, server_name: str, database_name: str, parameters: _models.ExportDatabaseDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImportExportOperationResult][source]
begin_export(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImportExportOperationResult]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (ExportDatabaseDefinition or IO) – The database export request parameters. Is either a ExportDatabaseDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ImportExportOperationResult]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database to failover. Required.

  • replica_type (str or ReplicaType) – The type of replica to be failed over. Known values are: “Primary” and “ReadableSecondary”. Default value is None.

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[None]

Raises

HttpResponseError –

begin_import_method(resource_group_name: str, server_name: str, database_name: str, parameters: _models.ImportExistingDatabaseDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImportExportOperationResult][source]
begin_import_method(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImportExportOperationResult]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (ImportExistingDatabaseDefinition or IO) – The database import request parameters. Is either a ImportExistingDatabaseDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ImportExportOperationResult]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database to be paused. Required.

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

LROPoller[Database]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database to be resumed. Required.

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

LROPoller[Database]

Raises

HttpResponseError –

begin_update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.DatabaseUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Database][source]
begin_update(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Database]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (DatabaseUpdate or IO) – The requested database resource state. Is either a DatabaseUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[Database]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database to be upgraded. Required.

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[None]

Raises

HttpResponseError –

get(resource_group_name: str, server_name: str, database_name: str, expand: Optional[str] = None, filter: Optional[str] = None, **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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

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

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.Database][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. Required.

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Database]

Raises

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.Database][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. Required.

  • server_name (str) – The name of the server. Required.

  • skip_token (str) – Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Database]

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Database]

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricDefinition]

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Metric]

Raises

HttpResponseError –

rename(resource_group_name: str, server_name: str, database_name: str, parameters: _models.ResourceMoveDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → None[source]
rename(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database to rename. Required.

  • parameters (ResourceMoveDefinition or IO) – The resource move definition for renaming this database. Is either a ResourceMoveDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s deleted_servers attribute.

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

  • deleted_server_name (str) – The name of the deleted server. Required.

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

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

  • deleted_server_name (str) – The name of the deleted server. Required.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DeletedServer][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 DeletedServer or the result of cls(response)

Return type

ItemPaged[DeletedServer]

Raises

HttpResponseError –

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

Gets a list of deleted servers for a location.

Parameters

location_name (str) – The name of the region where the resource is located. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DeletedServer]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s distributed_availability_groups attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, parameters: _models.DistributedAvailabilityGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DistributedAvailabilityGroup][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DistributedAvailabilityGroup]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • distributed_availability_group_name (str) – The distributed availability group name. Required.

  • parameters (DistributedAvailabilityGroup or IO) – The distributed availability group info. Is either a DistributedAvailabilityGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[DistributedAvailabilityGroup]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • distributed_availability_group_name (str) – The distributed availability group name. Required.

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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, parameters: _models.DistributedAvailabilityGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DistributedAvailabilityGroup][source]
begin_update(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.DistributedAvailabilityGroup]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • distributed_availability_group_name (str) – The distributed availability group name. Required.

  • parameters (DistributedAvailabilityGroup or IO) – The distributed availability group info. Is either a DistributedAvailabilityGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[DistributedAvailabilityGroup]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • distributed_availability_group_name (str) – The distributed availability group name. Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DistributedAvailabilityGroup]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s elastic_pool_activities attribute.

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool for which to get the current activity. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ElasticPoolActivity]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s elastic_pool_database_activities attribute.

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ElasticPoolDatabaseActivity]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s elastic_pool_operations attribute.

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – Required.

  • operation_id (str) – The operation identifier. Required.

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

None

Raises

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.ElasticPoolOperation][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. Required.

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ElasticPoolOperation]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s elastic_pools attribute.

begin_create_or_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: _models.ElasticPool, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ElasticPool][source]
begin_create_or_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ElasticPool]

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool. Required.

  • parameters (ElasticPool or IO) – The elastic pool parameters. Is either a ElasticPool type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool to failover. Required.

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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: _models.ElasticPoolUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ElasticPool][source]
begin_update(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ElasticPool]

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool. Required.

  • parameters (ElasticPoolUpdate or IO) – The elastic pool update parameters. Is either a ElasticPoolUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • skip (int) – The number of elements in the collection to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ElasticPool]

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[MetricDefinition]

Raises

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.Metric][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. Required.

  • server_name (str) – The name of the server. Required.

  • elastic_pool_name (str) – The name of the elastic pool. Required.

  • filter (str) – An OData filter expression that describes a subset of metrics to return. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Metric]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s encryption_protectors attribute.

begin_create_or_update(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, _models.EncryptionProtectorName], parameters: _models.EncryptionProtector, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EncryptionProtector][source]
begin_create_or_update(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, _models.EncryptionProtectorName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.EncryptionProtector]

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

  • server_name (str) – The name of the server. Required.

  • encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated. “current” Required.

  • parameters (EncryptionProtector or IO) – The requested encryption protector resource state. Is either a EncryptionProtector type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated. “current” Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be retrieved. “current” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[EncryptionProtector]

Raises

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.EndpointCertificatesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s endpoint_certificates attribute.

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

Gets a certificate used on the endpoint with the given 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • endpoint_type (str) – Type of the endpoint whose certificate the customer is looking for. Required.

Keyword Arguments

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

Returns

EndpointCertificate or the result of cls(response)

Return type

EndpointCertificate

Raises

HttpResponseError –

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

List certificates used on endpoints on the target 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[EndpointCertificate]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s extended_database_blob_auditing_policies attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.ExtendedDatabaseBlobAuditingPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ExtendedDatabaseBlobAuditingPolicy[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ExtendedDatabaseBlobAuditingPolicy

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (ExtendedDatabaseBlobAuditingPolicy or IO) – The extended database blob auditing policy. Is either a ExtendedDatabaseBlobAuditingPolicy type or a IO type. Required.

Keyword Arguments

  • blob_auditing_policy_name (str) – The name of the blob auditing policy. Default value is “default”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

  • blob_auditing_policy_name (str) – The name of the blob auditing policy. Default value is “default”. Note that overriding this default value may result in unsupported behavior.

  • 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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ExtendedDatabaseBlobAuditingPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s extended_server_blob_auditing_policies attribute.

begin_create_or_update(resource_group_name: str, server_name: str, parameters: _models.ExtendedServerBlobAuditingPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExtendedServerBlobAuditingPolicy][source]
begin_create_or_update(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ExtendedServerBlobAuditingPolicy]

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

  • server_name (str) – The name of the server. Required.

  • parameters (ExtendedServerBlobAuditingPolicy or IO) – Properties of extended blob auditing policy. Is either a ExtendedServerBlobAuditingPolicy type or a IO type. Required.

Keyword Arguments

  • blob_auditing_policy_name (str) – The name of the blob auditing policy. Default value is “default”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

  • blob_auditing_policy_name (str) – The name of the blob auditing policy. Default value is “default”. Note that overriding this default value may result in unsupported behavior.

  • 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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ExtendedServerBlobAuditingPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s failover_groups attribute.

begin_create_or_update(resource_group_name: str, server_name: str, failover_group_name: str, parameters: _models.FailoverGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FailoverGroup][source]
begin_create_or_update(resource_group_name: str, server_name: str, failover_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FailoverGroup]

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

  • server_name (str) – The name of the server containing the failover group. Required.

  • failover_group_name (str) – The name of the failover group. Required.

  • parameters (FailoverGroup or IO) – The failover group parameters. Is either a FailoverGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[FailoverGroup]

Raises

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

  • server_name (str) – The name of the server containing the failover group. Required.

  • failover_group_name (str) – The name of the failover group. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server containing the failover group. Required.

  • failover_group_name (str) – The name of the failover group. Required.

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

LROPoller[FailoverGroup]

Raises

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

  • server_name (str) – The name of the server containing the failover group. Required.

  • failover_group_name (str) – The name of the failover group. Required.

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

LROPoller[FailoverGroup]

Raises

HttpResponseError –

begin_update(resource_group_name: str, server_name: str, failover_group_name: str, parameters: _models.FailoverGroupUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FailoverGroup][source]
begin_update(resource_group_name: str, server_name: str, failover_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FailoverGroup]

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

  • server_name (str) – The name of the server containing the failover group. Required.

  • failover_group_name (str) – The name of the failover group. Required.

  • parameters (FailoverGroupUpdate or IO) – The failover group parameters. Is either a FailoverGroupUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[FailoverGroup]

Raises

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

  • server_name (str) – The name of the server containing the failover group. Required.

  • failover_group_name (str) – The name of the failover group. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server containing the failover group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[FailoverGroup]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s firewall_rules attribute.

create_or_update(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: _models.FirewallRule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.FirewallRule[source]
create_or_update(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.FirewallRule

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

  • server_name (str) – The name of the server. Required.

  • firewall_rule_name (str) – The name of the firewall rule. Required.

  • parameters (FirewallRule or IO) – The required parameters for creating or updating a firewall rule. Is either a FirewallRule type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • firewall_rule_name (str) – The name of the firewall rule. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • firewall_rule_name (str) – The name of the firewall rule. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[FirewallRule]

Raises

HttpResponseError –

replace(resource_group_name: str, server_name: str, parameters: _models.FirewallRuleList, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.FirewallRule][source]
replace(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → Optional[_models.FirewallRule]

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

  • server_name (str) – The name of the server. Required.

  • parameters (FirewallRuleList or IO) – Is either a FirewallRuleList type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

FirewallRule or None or the result of cls(response)

Return type

FirewallRule or None

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s geo_backup_policies attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, geo_backup_policy_name: Union[str, _models.GeoBackupPolicyName], parameters: _models.GeoBackupPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GeoBackupPolicy[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, geo_backup_policy_name: Union[str, _models.GeoBackupPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GeoBackupPolicy

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • geo_backup_policy_name (str or GeoBackupPolicyName) – The name of the geo backup policy. “Default” Required.

  • parameters (GeoBackupPolicy or IO) – The required parameters for creating or updating the geo backup policy. Is either a GeoBackupPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • geo_backup_policy_name (str or GeoBackupPolicyName) – The name of the geo backup policy. “Default” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GeoBackupPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s ipv6_firewall_rules attribute.

create_or_update(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: _models.IPv6FirewallRule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IPv6FirewallRule[source]
create_or_update(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IPv6FirewallRule

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

  • server_name (str) – The name of the server. Required.

  • firewall_rule_name (str) – The name of the firewall rule. Required.

  • parameters (IPv6FirewallRule or IO) – The required parameters for creating or updating an IPv6 firewall rule. Is either a IPv6FirewallRule type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • firewall_rule_name (str) – The name of the firewall rule. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • firewall_rule_name (str) – The name of the firewall rule. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[IPv6FirewallRule]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s instance_failover_groups attribute.

begin_create_or_update(resource_group_name: str, location_name: str, failover_group_name: str, parameters: _models.InstanceFailoverGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InstanceFailoverGroup][source]
begin_create_or_update(resource_group_name: str, location_name: str, failover_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InstanceFailoverGroup]

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

  • location_name (str) – The name of the region where the resource is located. Required.

  • failover_group_name (str) – The name of the failover group. Required.

  • parameters (InstanceFailoverGroup or IO) – The failover group parameters. Is either a InstanceFailoverGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • location_name (str) – The name of the region where the resource is located. Required.

  • failover_group_name (str) – The name of the failover group. Required.

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[None]

Raises

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

  • location_name (str) – The name of the region where the resource is located. Required.

  • failover_group_name (str) – The name of the failover group. Required.

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

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

  • location_name (str) – The name of the region where the resource is located. Required.

  • failover_group_name (str) – The name of the failover group. Required.

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

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

  • location_name (str) – The name of the region where the resource is located. Required.

  • failover_group_name (str) – The name of the failover group. Required.

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

HttpResponseError –

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

  • location_name (str) – The name of the region where the resource is located. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[InstanceFailoverGroup]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s instance_pools attribute.

begin_create_or_update(resource_group_name: str, instance_pool_name: str, parameters: _models.InstancePool, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InstancePool][source]
begin_create_or_update(resource_group_name: str, instance_pool_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InstancePool]

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

  • instance_pool_name (str) – The name of the instance pool to be created or updated. Required.

  • parameters (InstancePool or IO) – The requested instance pool resource state. Is either a InstancePool type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • instance_pool_name (str) – The name of the instance pool to be deleted. Required.

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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, instance_pool_name: str, parameters: _models.InstancePoolUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InstancePool][source]
begin_update(resource_group_name: str, instance_pool_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.InstancePool]

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

  • instance_pool_name (str) – The name of the instance pool to be updated. Required.

  • parameters (InstancePoolUpdate or IO) – The requested instance pool resource state. Is either a InstancePoolUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • instance_pool_name (str) – The name of the instance pool to be retrieved. Required.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.InstancePool][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 InstancePool or the result of cls(response)

Return type

ItemPaged[InstancePool]

Raises

HttpResponseError –

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[InstancePool]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s job_agents attribute.

begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: _models.JobAgent, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.JobAgent][source]
begin_create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.JobAgent]

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent to be created or updated. Required.

  • parameters (JobAgent or IO) – The requested job agent resource state. Is either a JobAgent type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent to be deleted. Required.

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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: _models.JobAgentUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.JobAgent][source]
begin_update(resource_group_name: str, server_name: str, job_agent_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.JobAgent]

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent to be updated. Required.

  • parameters (JobAgentUpdate or IO) – The update to the job agent. Is either a JobAgentUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent to be retrieved. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobAgent]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s job_credentials attribute.

create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, parameters: _models.JobCredential, *, content_type: str = "'application/json'", **kwargs: Any) → _models.JobCredential[source]
create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.JobCredential

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • credential_name (str) – The name of the credential. Required.

  • parameters (JobCredential or IO) – The requested job credential state. Is either a JobCredential type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • credential_name (str) – The name of the credential. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • credential_name (str) – The name of the credential. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobCredential]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s job_executions attribute.

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • job_execution_id (str) – The job execution id to create the job execution under. Required.

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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job. Required.

  • job_execution_id (str) – The id of the job execution to cancel. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job. Required.

  • job_execution_id (str) – The id of the job execution. Required.

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

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.JobExecution][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. Required.

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. Default value is None.

  • create_time_max (datetime) – If specified, only job executions created before the specified time are included. Default value is None.

  • end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included. Default value is None.

  • end_time_max (datetime) – If specified, only job executions completed before the specified time are included. Default value is None.

  • is_active (bool) – If specified, only active or only completed job executions are included. Default value is None.

  • skip (int) – The number of elements in the collection to skip. Default value is None.

  • top (int) – The number of elements to return from the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobExecution]

Raises

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.JobExecution][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. Required.

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. Default value is None.

  • create_time_max (datetime) – If specified, only job executions created before the specified time are included. Default value is None.

  • end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included. Default value is None.

  • end_time_max (datetime) – If specified, only job executions completed before the specified time are included. Default value is None.

  • is_active (bool) – If specified, only active or only completed job executions are included. Default value is None.

  • skip (int) – The number of elements in the collection to skip. Default value is None.

  • top (int) – The number of elements to return from the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobExecution]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s job_step_executions attribute.

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • job_execution_id (str) – The unique id of the job execution. Required.

  • step_name (str) – The name of the step. Required.

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

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.JobExecution][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. Required.

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • job_execution_id (str) – The id of the job execution. Required.

  • create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. Default value is None.

  • create_time_max (datetime) – If specified, only job executions created before the specified time are included. Default value is None.

  • end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included. Default value is None.

  • end_time_max (datetime) – If specified, only job executions completed before the specified time are included. Default value is None.

  • is_active (bool) – If specified, only active or only completed job executions are included. Default value is None.

  • skip (int) – The number of elements in the collection to skip. Default value is None.

  • top (int) – The number of elements to return from the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobExecution]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s job_steps attribute.

create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, parameters: _models.JobStep, *, content_type: str = "'application/json'", **kwargs: Any) → _models.JobStep[source]
create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.JobStep

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job. Required.

  • step_name (str) – The name of the job step. Required.

  • parameters (JobStep or IO) – The requested state of the job step. Is either a JobStep type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job. Required.

  • step_name (str) – The name of the job step to delete. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job. Required.

  • step_name (str) – The name of the job step. Required.

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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job. Required.

  • job_version (int) – The version of the job to get. Required.

  • step_name (str) – The name of the job step. Required.

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

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.JobStep][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. Required.

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobStep]

Raises

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.JobStep][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. Required.

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • job_version (int) – The version of the job to get. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobStep]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s job_target_executions attribute.

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • job_execution_id (str) – The unique id of the job execution. Required.

  • step_name (str) – The name of the step. Required.

  • target_id (str) – The target id. Required.

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

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.JobExecution][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. Required.

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • job_execution_id (str) – The id of the job execution. Required.

  • create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. Default value is None.

  • create_time_max (datetime) – If specified, only job executions created before the specified time are included. Default value is None.

  • end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included. Default value is None.

  • end_time_max (datetime) – If specified, only job executions completed before the specified time are included. Default value is None.

  • is_active (bool) – If specified, only active or only completed job executions are included. Default value is None.

  • skip (int) – The number of elements in the collection to skip. Default value is None.

  • top (int) – The number of elements to return from the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobExecution]

Raises

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.JobExecution][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. Required.

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • job_execution_id (str) – The id of the job execution. Required.

  • step_name (str) – The name of the step. Required.

  • create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. Default value is None.

  • create_time_max (datetime) – If specified, only job executions created before the specified time are included. Default value is None.

  • end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included. Default value is None.

  • end_time_max (datetime) – If specified, only job executions completed before the specified time are included. Default value is None.

  • is_active (bool) – If specified, only active or only completed job executions are included. Default value is None.

  • skip (int) – The number of elements in the collection to skip. Default value is None.

  • top (int) – The number of elements to return from the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobExecution]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s job_target_groups attribute.

create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, target_group_name: str, parameters: _models.JobTargetGroup, *, content_type: str = "'application/json'", **kwargs: Any) → _models.JobTargetGroup[source]
create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, target_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.JobTargetGroup

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • target_group_name (str) – The name of the target group. Required.

  • parameters (JobTargetGroup or IO) – The requested state of the target group. Is either a JobTargetGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • target_group_name (str) – The name of the target group. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • target_group_name (str) – The name of the target group. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobTargetGroup]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s job_versions attribute.

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job. Required.

  • job_version (int) – The version of the job to get. Required.

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

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.JobVersion][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. Required.

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobVersion]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s jobs attribute.

create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, parameters: _models.Job, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Job[source]
create_or_update(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Job

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

  • parameters (Job or IO) – The requested job state. Is either a Job type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to delete. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

  • job_name (str) – The name of the job to get. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • job_agent_name (str) – The name of the job agent. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Job]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s ledger_digest_uploads attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, ledger_digest_uploads: Union[str, _models.LedgerDigestUploadsName], parameters: _models.LedgerDigestUploads, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LedgerDigestUploads][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, ledger_digest_uploads: Union[str, _models.LedgerDigestUploadsName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LedgerDigestUploads]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • ledger_digest_uploads (str or LedgerDigestUploadsName) – “current” Required.

  • parameters (LedgerDigestUploads or IO) – Is either a LedgerDigestUploads type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • ledger_digest_uploads (str or LedgerDigestUploadsName) – “current” Required.

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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • ledger_digest_uploads (str or LedgerDigestUploadsName) – “current” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LedgerDigestUploads]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s long_term_retention_backups attribute.

begin_copy(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.CopyLongTermRetentionBackupParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionBackupOperationResult][source]
begin_copy(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionBackupOperationResult]

Copy an existing long term retention backup.

Parameters

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • backup_name (str) – The backup name. Required.

  • parameters (CopyLongTermRetentionBackupParameters or IO) – The parameters needed for long term retention copy request. Is either a CopyLongTermRetentionBackupParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[LongTermRetentionBackupOperationResult]

Raises

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: _models.CopyLongTermRetentionBackupParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionBackupOperationResult][source]
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: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionBackupOperationResult]

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

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • backup_name (str) – The backup name. Required.

  • parameters (CopyLongTermRetentionBackupParameters or IO) – The parameters needed for long term retention copy request. Is either a CopyLongTermRetentionBackupParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[LongTermRetentionBackupOperationResult]

Raises

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

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • backup_name (str) – The backup name. Required.

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[None]

Raises

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

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • backup_name (str) – The backup name. Required.

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[None]

Raises

HttpResponseError –

begin_update(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: _models.UpdateLongTermRetentionBackupParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionBackupOperationResult][source]
begin_update(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionBackupOperationResult]

Updates an existing long term retention backup.

Parameters

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • backup_name (str) – The backup name. Required.

  • parameters (UpdateLongTermRetentionBackupParameters or IO) – The requested backup resource state. Is either a UpdateLongTermRetentionBackupParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[LongTermRetentionBackupOperationResult]

Raises

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: _models.UpdateLongTermRetentionBackupParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionBackupOperationResult][source]
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: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionBackupOperationResult]

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

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • backup_name (str) – The backup name. Required.

  • parameters (UpdateLongTermRetentionBackupParameters or IO) – The requested backup resource state. Is either a UpdateLongTermRetentionBackupParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[LongTermRetentionBackupOperationResult]

Raises

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

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • backup_name (str) – The backup name. Required.

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

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

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • backup_name (str) – The backup name. Required.

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

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

Lists all long term retention backups for a database.

Parameters

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LongTermRetentionBackup]

Raises

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

Lists the long term retention backups for a given location.

Parameters

  • location_name (str) – The location of the database. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LongTermRetentionBackup]

Raises

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.LongTermRetentionBackup][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. Required.

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • long_term_retention_database_name (str) – The name of the database. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LongTermRetentionBackup]

Raises

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.LongTermRetentionBackup][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. Required.

  • location_name (str) – The location of the database. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LongTermRetentionBackup]

Raises

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.LongTermRetentionBackup][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. Required.

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LongTermRetentionBackup]

Raises

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

Lists the long term retention backups for a given server.

Parameters

  • location_name (str) – The location of the database. Required.

  • long_term_retention_server_name (str) – The name of the server. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LongTermRetentionBackup]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s long_term_retention_managed_instance_backups attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database. Required.

  • backup_name (str) – The backup name. Required.

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[None]

Raises

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

  • location_name (str) – The location of the database. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database. Required.

  • backup_name (str) – The backup name. Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database. Required.

  • backup_name (str) – The backup name. Required.

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

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

  • location_name (str) – The location of the database. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database. Required.

  • backup_name (str) – The backup name. Required.

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

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

Lists all long term retention backups for a managed database.

Parameters

  • location_name (str) – The location of the database. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackup]

Raises

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

Lists the long term retention backups for a given managed instance.

Parameters

  • location_name (str) – The location of the database. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackup]

Raises

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

Lists the long term retention backups for managed databases in a given location.

Parameters

  • location_name (str) – The location of the database. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackup]

Raises

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.ManagedInstanceLongTermRetentionBackup][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. Required.

  • location_name (str) – The location of the database. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackup]

Raises

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.ManagedInstanceLongTermRetentionBackup][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. Required.

  • location_name (str) – The location of the database. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackup]

Raises

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.ManagedInstanceLongTermRetentionBackup][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. Required.

  • location_name (str) – The location of the database. Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.

  • database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Known values are: “All”, “Live”, and “Deleted”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceLongTermRetentionBackup]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s long_term_retention_policies attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, _models.LongTermRetentionPolicyName], parameters: _models.LongTermRetentionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionPolicy][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, _models.LongTermRetentionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LongTermRetentionPolicy]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or LongTermRetentionPolicyName) – The policy name. Should always be Default. “default” Required.

  • parameters (LongTermRetentionPolicy or IO) – The long term retention policy info. Is either a LongTermRetentionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or LongTermRetentionPolicyName) – The policy name. Should always be Default. “default” Required.

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

HttpResponseError –

list_by_database(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LongTermRetentionPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s maintenance_window_options attribute.

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database to get maintenance windows options for. Required.

  • maintenance_window_options_name (str) – Maintenance window options name. Required.

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

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s maintenance_windows attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, maintenance_window_name: str, parameters: _models.MaintenanceWindows, *, content_type: str = "'application/json'", **kwargs: Any) → None[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, maintenance_window_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database to set maintenance windows for. Required.

  • maintenance_window_name (str) – Maintenance window name. Required.

  • parameters (MaintenanceWindows or IO) – Is either a MaintenanceWindows type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database to get maintenance windows for. Required.

  • maintenance_window_name (str) – Maintenance window name. Required.

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

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_backup_short_term_retention_policies attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, _models.ManagedShortTermRetentionPolicyName], parameters: _models.ManagedBackupShortTermRetentionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedBackupShortTermRetentionPolicy][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, _models.ManagedShortTermRetentionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedBackupShortTermRetentionPolicy]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”. “default” Required.

  • parameters (ManagedBackupShortTermRetentionPolicy or IO) – The short term retention policy info. Is either a ManagedBackupShortTermRetentionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ManagedBackupShortTermRetentionPolicy]

Raises

HttpResponseError –

begin_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, _models.ManagedShortTermRetentionPolicyName], parameters: _models.ManagedBackupShortTermRetentionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedBackupShortTermRetentionPolicy][source]
begin_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, _models.ManagedShortTermRetentionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedBackupShortTermRetentionPolicy]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”. “default” Required.

  • parameters (ManagedBackupShortTermRetentionPolicy or IO) – The short term retention policy info. Is either a ManagedBackupShortTermRetentionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ManagedBackupShortTermRetentionPolicy]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. “default” Required.

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

ManagedBackupShortTermRetentionPolicy

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedBackupShortTermRetentionPolicy]

Raises

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.ManagedDatabaseAdvancedThreatProtectionSettingsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_advanced_threat_protection_settings attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, advanced_threat_protection_name: Union[str, _models.AdvancedThreatProtectionName], parameters: _models.ManagedDatabaseAdvancedThreatProtection, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedDatabaseAdvancedThreatProtection[source]
create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, advanced_threat_protection_name: Union[str, _models.AdvancedThreatProtectionName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedDatabaseAdvancedThreatProtection

Creates or updates a managed database’s Advanced Threat Protection state.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state. “Default” Required.

  • parameters (ManagedDatabaseAdvancedThreatProtection or IO) – The managed database Advanced Threat Protection state. Is either a ManagedDatabaseAdvancedThreatProtection type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ManagedDatabaseAdvancedThreatProtection or the result of cls(response)

Return type

ManagedDatabaseAdvancedThreatProtection

Raises

HttpResponseError –

get(resource_group_name: str, managed_instance_name: str, database_name: str, advanced_threat_protection_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdvancedThreatProtectionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabaseAdvancedThreatProtection[source]

Gets a managed database’s Advanced Threat Protection state.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state. “Default” Required.

Keyword Arguments

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

Returns

ManagedDatabaseAdvancedThreatProtection or the result of cls(response)

Return type

ManagedDatabaseAdvancedThreatProtection

Raises

HttpResponseError –

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

Gets a list of managed database’s Advanced Threat Protection states.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedDatabaseAdvancedThreatProtection]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_columns attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

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

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.DatabaseColumn][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema (list[str]) – Default value is None.

  • table (list[str]) – Default value is None.

  • column (list[str]) – Default value is None.

  • order_by (list[str]) – Default value is None.

  • skiptoken (str) – An opaque token that identifies a starting point in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseColumn]

Raises

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.DatabaseColumn][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseColumn]

Raises

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.ManagedDatabaseMoveOperationsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_move_operations attribute.

get(resource_group_name: str, location_name: str, operation_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabaseMoveOperationResult[source]

Gets a managed database move operation.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • location_name (str) – Required.

  • operation_id (str) – Required.

Keyword Arguments

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

Returns

ManagedDatabaseMoveOperationResult or the result of cls(response)

Return type

ManagedDatabaseMoveOperationResult

Raises

HttpResponseError –

list_by_location(resource_group_name: str, location_name: str, only_latest_per_database: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedDatabaseMoveOperationResult][source]

Lists managed database move operations.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • location_name (str) – Required.

  • only_latest_per_database (bool) – Whether or not to only get the latest operation for each database. Has higher priority than $filter. Default value is None.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedDatabaseMoveOperationResult]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_queries attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • query_id (str) – Required.

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

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.QueryStatistics][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • query_id (str) – Required.

  • start_time (str) – Start time for observed period. Default value is None.

  • end_time (str) – End time for observed period. Default value is None.

  • interval (str or QueryTimeGrainType) – The time step to be used to summarize the metric values. Known values are: “PT1H” and “P1D”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[QueryStatistics]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_recommended_sensitivity_labels attribute.

update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: _models.RecommendedSensitivityLabelUpdateList, *, content_type: str = "'application/json'", **kwargs: Any) → None[source]
update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (RecommendedSensitivityLabelUpdateList or IO) – Is either a RecommendedSensitivityLabelUpdateList type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_restore_details attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • restore_details_name (str or RestoreDetailsName) – The name of the restore details to retrieve. “Default” Required.

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

ManagedDatabaseRestoreDetailsResult

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_schemas attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

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

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.DatabaseSchema][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseSchema]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_security_alert_policies attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: _models.ManagedDatabaseSecurityAlertPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedDatabaseSecurityAlertPolicy[source]
create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedDatabaseSecurityAlertPolicy

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database for which the security alert policy is defined. Required.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy. “Default” Required.

  • parameters (ManagedDatabaseSecurityAlertPolicy or IO) – The database security alert policy. Is either a ManagedDatabaseSecurityAlertPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database for which the security alert policy is defined. Required.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy. “Default” Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database for which the security alert policies are defined. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedDatabaseSecurityAlertPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_security_events attribute.

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.SecurityEvent][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database for which the security events are retrieved. Required.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

  • skip (int) – The number of elements in the collection to skip. Default value is None.

  • top (int) – The number of elements to return from the collection. Default value is None.

  • skiptoken (str) – An opaque token that identifies a starting point in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SecurityEvent]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_sensitivity_labels attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, parameters: _models.SensitivityLabel, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SensitivityLabel[source]
create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SensitivityLabel

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

  • parameters (SensitivityLabel or IO) – The column sensitivity label resource. Is either a SensitivityLabel type or a IO type. Required.

Keyword Arguments

  • sensitivity_label_source (str) – The source of the sensitivity label. Default value is “current”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

SensitivityLabel or the result of cls(response)

Return type

SensitivityLabel

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

Keyword Arguments

  • sensitivity_label_source (str) – The source of the sensitivity label. Default value is “current”. Note that overriding this default value may result in unsupported behavior.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

Keyword Arguments

  • sensitivity_label_source (str) – Default value is “recommended”. Note that overriding this default value may result in unsupported behavior.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

Keyword Arguments

  • sensitivity_label_source (str) – Default value is “recommended”. Note that overriding this default value may result in unsupported behavior.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

  • sensitivity_label_source (str or SensitivityLabelSource) – The source of the sensitivity label. Known values are: “current” and “recommended”. Required.

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

SensitivityLabel

Raises

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.SensitivityLabel][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • skip_token (str) – Default value is None.

  • count (bool) – Default value is None.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SensitivityLabel]

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • skip_token (str) – Default value is None.

  • include_disabled_recommendations (bool) – Specifies whether to include disabled recommendations or not. Default value is None.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SensitivityLabel]

Raises

HttpResponseError –

update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: _models.SensitivityLabelUpdateList, *, content_type: str = "'application/json'", **kwargs: Any) → None[source]
update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (SensitivityLabelUpdateList or IO) – Is either a SensitivityLabelUpdateList type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_tables attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

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

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.DatabaseTable][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseTable]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_transparent_data_encryption attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, tde_name: Union[str, _models.TransparentDataEncryptionName], parameters: _models.ManagedTransparentDataEncryption, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedTransparentDataEncryption[source]
create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, tde_name: Union[str, _models.TransparentDataEncryptionName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedTransparentDataEncryption

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database for which the security alert policy is defined. Required.

  • tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration. “current” Required.

  • parameters (ManagedTransparentDataEncryption or IO) – The database transparent data encryption. Is either a ManagedTransparentDataEncryption type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database for which the transparent data encryption is defined. Required.

  • tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration. “current” Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the managed database for which the transparent data encryption is defined. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedTransparentDataEncryption]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_vulnerability_assessment_rule_baselines attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, _models.VulnerabilityAssessmentPolicyBaselineName], parameters: _models.DatabaseVulnerabilityAssessmentRuleBaseline, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseVulnerabilityAssessmentRuleBaseline[source]
create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, _models.VulnerabilityAssessmentPolicyBaselineName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseVulnerabilityAssessmentRuleBaseline

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

  • 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). Known values are: “master” and “default”. Required.

  • parameters (DatabaseVulnerabilityAssessmentRuleBaseline or IO) – The requested rule baseline resource. Is either a DatabaseVulnerabilityAssessmentRuleBaseline type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseVulnerabilityAssessmentRuleBaseline or the result of cls(response)

Return type

DatabaseVulnerabilityAssessmentRuleBaseline

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

  • 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). Known values are: “master” and “default”. Required.

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

None

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

  • 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). Known values are: “master” and “default”. Required.

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

DatabaseVulnerabilityAssessmentRuleBaseline

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_vulnerability_assessment_scans attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve. Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the scanned database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • scan_id (str) – The vulnerability assessment scan Id. Required.

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

DatabaseVulnerabilityAssessmentScansExport

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve. Required.

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

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.VulnerabilityAssessmentScanRecord][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VulnerabilityAssessmentScanRecord]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_database_vulnerability_assessments attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: _models.DatabaseVulnerabilityAssessment, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseVulnerabilityAssessment[source]
create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseVulnerabilityAssessment

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • parameters (DatabaseVulnerabilityAssessment or IO) – The requested resource. Is either a DatabaseVulnerabilityAssessment type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseVulnerabilityAssessment or the result of cls(response)

Return type

DatabaseVulnerabilityAssessment

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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

None

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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

DatabaseVulnerabilityAssessment

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database for which the vulnerability assessment is defined. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DatabaseVulnerabilityAssessment]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_databases attribute.

begin_cancel_move(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: _models.ManagedDatabaseMoveDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_cancel_move(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Cancels a managed database move operation.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (ManagedDatabaseMoveDefinition or IO) – Parameters of the cancel managed database move operation. Is either a ManagedDatabaseMoveDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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[None]

Raises

HttpResponseError –

begin_complete_move(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: _models.ManagedDatabaseMoveDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_complete_move(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Completes a managed database move operation.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (ManagedDatabaseMoveDefinition or IO) – Parameters of the complete managed database move operation. Is either a ManagedDatabaseMoveDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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[None]

Raises

HttpResponseError –

begin_complete_restore(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: _models.CompleteDatabaseRestoreDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_complete_restore(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (CompleteDatabaseRestoreDefinition or IO) – The definition for completing the restore of this managed database. Is either a CompleteDatabaseRestoreDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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[None]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: _models.ManagedDatabase, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedDatabase][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedDatabase]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (ManagedDatabase or IO) – The requested database resource state. Is either a ManagedDatabase type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ManagedDatabase]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

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[None]

Raises

HttpResponseError –

begin_start_move(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: _models.ManagedDatabaseStartMoveDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_start_move(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Starts a managed database move operation.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (ManagedDatabaseStartMoveDefinition or IO) – Parameters of the start managed database move operation. Is either a ManagedDatabaseStartMoveDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: _models.ManagedDatabaseUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedDatabase][source]
begin_update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedDatabase]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (ManagedDatabaseUpdate or IO) – The requested database resource state. Is either a ManagedDatabaseUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ManagedDatabase]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedDatabase]

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedDatabase]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_administrators attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, administrator_name: Union[str, _models.AdministratorName], parameters: _models.ManagedInstanceAdministrator, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceAdministrator][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, administrator_name: Union[str, _models.AdministratorName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceAdministrator]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • administrator_name (str or AdministratorName) – “ActiveDirectory” Required.

  • parameters (ManagedInstanceAdministrator or IO) – The requested administrator parameters. Is either a ManagedInstanceAdministrator type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • administrator_name (str or AdministratorName) – “ActiveDirectory” Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • administrator_name (str or AdministratorName) – “ActiveDirectory” Required.

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

ManagedInstanceAdministrator

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceAdministrator]

Raises

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.ManagedInstanceAdvancedThreatProtectionSettingsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_advanced_threat_protection_settings attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, advanced_threat_protection_name: Union[str, _models.AdvancedThreatProtectionName], parameters: _models.ManagedInstanceAdvancedThreatProtection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceAdvancedThreatProtection][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, advanced_threat_protection_name: Union[str, _models.AdvancedThreatProtectionName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceAdvancedThreatProtection]

Creates or updates Advanced Threat Protection 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state. “Default” Required.

  • parameters (ManagedInstanceAdvancedThreatProtection or IO) – The managed instance Advanced Threat Protection state. Is either a ManagedInstanceAdvancedThreatProtection type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ManagedInstanceAdvancedThreatProtection or the result of cls(response)

Return type

LROPoller[ManagedInstanceAdvancedThreatProtection]

Raises

HttpResponseError –

get(resource_group_name: str, managed_instance_name: str, advanced_threat_protection_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdvancedThreatProtectionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceAdvancedThreatProtection[source]

Get a managed instance’s Advanced Threat Protection state.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state. “Default” Required.

Keyword Arguments

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

Returns

ManagedInstanceAdvancedThreatProtection or the result of cls(response)

Return type

ManagedInstanceAdvancedThreatProtection

Raises

HttpResponseError –

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

Get the managed instance’s Advanced Threat Protection 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceAdvancedThreatProtection]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_azure_ad_only_authentications attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, authentication_name: Union[str, _models.AuthenticationName], parameters: _models.ManagedInstanceAzureADOnlyAuthentication, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceAzureADOnlyAuthentication][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, authentication_name: Union[str, _models.AuthenticationName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceAzureADOnlyAuthentication]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication. “Default” Required.

  • parameters (ManagedInstanceAzureADOnlyAuthentication or IO) – The required parameters for creating or updating an Active Directory only authentication property. Is either a ManagedInstanceAzureADOnlyAuthentication type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication. “Default” Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication. “Default” Required.

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

ManagedInstanceAzureADOnlyAuthentication

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceAzureADOnlyAuthentication]

Raises

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.ManagedInstanceDtcsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_dtcs attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, dtc_name: Union[str, _models.DtcName], parameters: _models.ManagedInstanceDtc, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceDtc][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, dtc_name: Union[str, _models.DtcName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceDtc]

Updates managed instance DTC 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • dtc_name (str or DtcName) – The name of the managed instance DTC. “current” Required.

  • parameters (ManagedInstanceDtc or IO) – Managed instance DTC settings. Is either a ManagedInstanceDtc type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ManagedInstanceDtc or the result of cls(response)

Return type

LROPoller[ManagedInstanceDtc]

Raises

HttpResponseError –

get(resource_group_name: str, managed_instance_name: str, dtc_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.DtcName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceDtc[source]

Gets managed instance DTC 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • dtc_name (str or DtcName) – The name of the managed instance DTC. “current” Required.

Keyword Arguments

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

Returns

ManagedInstanceDtc or the result of cls(response)

Return type

ManagedInstanceDtc

Raises

HttpResponseError –

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

Gets a list of managed instance DTC 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceDtc]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_encryption_protectors attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, encryption_protector_name: Union[str, _models.EncryptionProtectorName], parameters: _models.ManagedInstanceEncryptionProtector, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceEncryptionProtector][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, encryption_protector_name: Union[str, _models.EncryptionProtectorName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceEncryptionProtector]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated. “current” Required.

  • parameters (ManagedInstanceEncryptionProtector or IO) – The requested encryption protector resource state. Is either a ManagedInstanceEncryptionProtector type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated. “current” Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be retrieved. “current” Required.

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

ManagedInstanceEncryptionProtector

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceEncryptionProtector]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_keys attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, key_name: str, parameters: _models.ManagedInstanceKey, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceKey][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, key_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceKey]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • key_name (str) – The name of the managed instance key to be operated on (updated or created). Required.

  • parameters (ManagedInstanceKey or IO) – The requested managed instance key resource state. Is either a ManagedInstanceKey type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • key_name (str) – The name of the managed instance key to be deleted. Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • key_name (str) – The name of the managed instance key to be retrieved. Required.

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

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.ManagedInstanceKey][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceKey]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_long_term_retention_policies attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, _models.ManagedInstanceLongTermRetentionPolicyName], parameters: _models.ManagedInstanceLongTermRetentionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceLongTermRetentionPolicy][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, _models.ManagedInstanceLongTermRetentionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstanceLongTermRetentionPolicy]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or ManagedInstanceLongTermRetentionPolicyName) – The policy name. Should always be Default. “default” Required.

  • parameters (ManagedInstanceLongTermRetentionPolicy or IO) – The long term retention policy info. Is either a ManagedInstanceLongTermRetentionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • policy_name (str or ManagedInstanceLongTermRetentionPolicyName) – The policy name. Should always be Default. “default” Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceLongTermRetentionPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_operations attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • operation_id (str) – Required.

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

None

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • operation_id (str) – Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceOperation]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_private_endpoint_connections attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, private_endpoint_connection_name: str, parameters: _models.ManagedInstancePrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstancePrivateEndpointConnection][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, private_endpoint_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstancePrivateEndpointConnection]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • private_endpoint_connection_name (str) – Required.

  • parameters (ManagedInstancePrivateEndpointConnection or IO) – Is either a ManagedInstancePrivateEndpointConnection type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • private_endpoint_connection_name (str) – Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

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

ManagedInstancePrivateEndpointConnection

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstancePrivateEndpointConnection]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_private_link_resources attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • group_name (str) – The name of the private link resource. Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstancePrivateLink]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_tde_certificates attribute.

begin_create(resource_group_name: str, managed_instance_name: str, parameters: _models.TdeCertificate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_create(resource_group_name: str, managed_instance_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • parameters (TdeCertificate or IO) – The requested TDE certificate to be created or updated. Is either a TdeCertificate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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[None]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instance_vulnerability_assessments attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: _models.ManagedInstanceVulnerabilityAssessment, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedInstanceVulnerabilityAssessment[source]
create_or_update(resource_group_name: str, managed_instance_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ManagedInstanceVulnerabilityAssessment

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

  • managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • parameters (ManagedInstanceVulnerabilityAssessment or IO) – The requested resource. Is either a ManagedInstanceVulnerabilityAssessment type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ManagedInstanceVulnerabilityAssessment or the result of cls(response)

Return type

ManagedInstanceVulnerabilityAssessment

Raises

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

  • managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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

None

Raises

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

  • managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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

ManagedInstanceVulnerabilityAssessment

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance for which the vulnerability assessments is defined. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstanceVulnerabilityAssessment]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_instances attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, parameters: _models.ManagedInstance, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstance][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstance]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • parameters (ManagedInstance or IO) – The requested managed instance resource state. Is either a ManagedInstance type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance to failover. Required.

  • replica_type (str or ReplicaType) – The type of replica to be failed over. Known values are: “Primary” and “ReadableSecondary”. Default value is None.

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[None]

Raises

HttpResponseError –

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

Starts 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

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[None]

Raises

HttpResponseError –

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

Stops 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, managed_instance_name: str, parameters: _models.ManagedInstanceUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstance][source]
begin_update(resource_group_name: str, managed_instance_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedInstance]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • parameters (ManagedInstanceUpdate or IO) – The requested managed instance resource state. Is either a ManagedInstanceUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

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

HttpResponseError –

list(expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstance][source]

Gets a list of all managed instances in the subscription.

Parameters

expand (str) – The child resources to include in the response. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstance]

Raises

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.ManagedInstance][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. Required.

  • instance_pool_name (str) – The instance pool name. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstance]

Raises

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.TopQueries][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • number_of_queries (int) – How many ‘top queries’ to return. Default is 5. Default value is None.

  • databases (str) – Comma separated list of databases to be included into search. All DB’s are included if this parameter is not specified. Default value is None.

  • start_time (str) – Start time for observed period. Default value is None.

  • end_time (str) – End time for observed period. Default value is None.

  • interval (str or QueryTimeGrainType) – The time step to be used to summarize the metric values. Default value is PT1H. Known values are: “PT1H” and “P1D”. Default value is None.

  • aggregation_function (str or AggregationFunctionType) – Aggregation function to be used, default value is ‘sum’. Known values are: “avg”, “min”, “max”, “stdev”, and “sum”. Default value is None.

  • observation_metric (str or MetricType) – Metric to be used for ranking top queries. Default is ‘cpu’. Known values are: “cpu”, “io”, “logIo”, “duration”, and “dtu”. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TopQueries]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstance][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. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedInstance]

Raises

HttpResponseError –

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

Gets the collection of outbound network dependencies for the 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[OutboundEnvironmentEndpoint]

Raises

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.ManagedLedgerDigestUploadsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_ledger_digest_uploads attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, ledger_digest_uploads: Union[str, _models.ManagedLedgerDigestUploadsName], parameters: _models.ManagedLedgerDigestUploads, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedLedgerDigestUploads][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, ledger_digest_uploads: Union[str, _models.ManagedLedgerDigestUploadsName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedLedgerDigestUploads]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • ledger_digest_uploads (str or ManagedLedgerDigestUploadsName) – The name of the Ledger Digest Upload Configurations. “current” Required.

  • parameters (ManagedLedgerDigestUploads or IO) – The Ledger Digest Storage Endpoint. Is either a ManagedLedgerDigestUploads type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ManagedLedgerDigestUploads or the result of cls(response)

Return type

LROPoller[ManagedLedgerDigestUploads]

Raises

HttpResponseError –

begin_disable(resource_group_name: str, managed_instance_name: str, database_name: str, ledger_digest_uploads: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedLedgerDigestUploadsName], **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedLedgerDigestUploads][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • ledger_digest_uploads (str or ManagedLedgerDigestUploadsName) – “current” Required.

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 ManagedLedgerDigestUploads or the result of cls(response)

Return type

LROPoller[ManagedLedgerDigestUploads]

Raises

HttpResponseError –

get(resource_group_name: str, managed_instance_name: str, database_name: str, ledger_digest_uploads: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedLedgerDigestUploadsName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedLedgerDigestUploads[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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

  • ledger_digest_uploads (str or ManagedLedgerDigestUploadsName) – “current” Required.

Keyword Arguments

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

Returns

ManagedLedgerDigestUploads or the result of cls(response)

Return type

ManagedLedgerDigestUploads

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedLedgerDigestUploads]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_restorable_dropped_database_backup_short_term_retention_policies attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, _models.ManagedShortTermRetentionPolicyName], parameters: _models.ManagedBackupShortTermRetentionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedBackupShortTermRetentionPolicy][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, _models.ManagedShortTermRetentionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedBackupShortTermRetentionPolicy]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • restorable_dropped_database_id (str) – Required.

  • policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”. “default” Required.

  • parameters (ManagedBackupShortTermRetentionPolicy or IO) – The short term retention policy info. Is either a ManagedBackupShortTermRetentionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ManagedBackupShortTermRetentionPolicy]

Raises

HttpResponseError –

begin_update(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, _models.ManagedShortTermRetentionPolicyName], parameters: _models.ManagedBackupShortTermRetentionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedBackupShortTermRetentionPolicy][source]
begin_update(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, _models.ManagedShortTermRetentionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedBackupShortTermRetentionPolicy]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • restorable_dropped_database_id (str) – Required.

  • policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”. “default” Required.

  • parameters (ManagedBackupShortTermRetentionPolicy or IO) – The short term retention policy info. Is either a ManagedBackupShortTermRetentionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ManagedBackupShortTermRetentionPolicy]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • restorable_dropped_database_id (str) – Required.

  • policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. “default” Required.

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

ManagedBackupShortTermRetentionPolicy

Raises

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.ManagedBackupShortTermRetentionPolicy][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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • restorable_dropped_database_id (str) – Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedBackupShortTermRetentionPolicy]

Raises

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.ManagedServerDnsAliasesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_server_dns_aliases attribute.

begin_acquire(resource_group_name: str, managed_instance_name: str, dns_alias_name: str, parameters: _models.ManagedServerDnsAliasAcquisition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedServerDnsAlias][source]
begin_acquire(resource_group_name: str, managed_instance_name: str, dns_alias_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedServerDnsAlias]

Acquires managed server DNS alias from another managed 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • dns_alias_name (str) – Required.

  • parameters (ManagedServerDnsAliasAcquisition or IO) – Is either a ManagedServerDnsAliasAcquisition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ManagedServerDnsAlias or the result of cls(response)

Return type

LROPoller[ManagedServerDnsAlias]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, managed_instance_name: str, dns_alias_name: str, parameters: _models.ManagedServerDnsAliasCreation, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedServerDnsAlias][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, dns_alias_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedServerDnsAlias]

Creates a managed 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • dns_alias_name (str) – Required.

  • parameters (ManagedServerDnsAliasCreation or IO) – Is either a ManagedServerDnsAliasCreation type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ManagedServerDnsAlias or the result of cls(response)

Return type

LROPoller[ManagedServerDnsAlias]

Raises

HttpResponseError –

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

Deletes the managed 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • dns_alias_name (str) – Required.

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[None]

Raises

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • dns_alias_name (str) – Required.

Keyword Arguments

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

Returns

ManagedServerDnsAlias or the result of cls(response)

Return type

ManagedServerDnsAlias

Raises

HttpResponseError –

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

Gets a list of managed server DNS aliases for a managed 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedServerDnsAlias]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s managed_server_security_alert_policies attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: _models.ManagedServerSecurityAlertPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedServerSecurityAlertPolicy][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ManagedServerSecurityAlertPolicy]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy. “Default” Required.

  • parameters (ManagedServerSecurityAlertPolicy or IO) – The managed server security alert policy. Is either a ManagedServerSecurityAlertPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy. “Default” Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ManagedServerSecurityAlertPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.Operation][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 Operation or the result of cls(response)

Return type

ItemPaged[Operation]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s outbound_firewall_rules attribute.

begin_create_or_update(resource_group_name: str, server_name: str, outbound_rule_fqdn: str, parameters: _models.OutboundFirewallRule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OutboundFirewallRule][source]
begin_create_or_update(resource_group_name: str, server_name: str, outbound_rule_fqdn: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OutboundFirewallRule]

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

  • server_name (str) – The name of the server. Required.

  • outbound_rule_fqdn (str) – Required.

  • parameters (OutboundFirewallRule or IO) – Is either a OutboundFirewallRule type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • outbound_rule_fqdn (str) – Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • outbound_rule_fqdn (str) – Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[OutboundFirewallRule]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s private_endpoint_connections attribute.

begin_create_or_update(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection][source]
begin_create_or_update(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

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

  • server_name (str) – The name of the server. Required.

  • private_endpoint_connection_name (str) – Required.

  • parameters (PrivateEndpointConnection or IO) – Is either a PrivateEndpointConnection type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • private_endpoint_connection_name (str) – Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection. Required.

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

PrivateEndpointConnection

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PrivateEndpointConnection]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s private_link_resources attribute.

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

  • server_name (str) – The name of the server. Required.

  • group_name (str) – The name of the private link resource. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PrivateLinkResource]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s recommended_sensitivity_labels attribute.

update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.RecommendedSensitivityLabelUpdateList, *, content_type: str = "'application/json'", **kwargs: Any) → None[source]
update(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (RecommendedSensitivityLabelUpdateList or IO) – Is either a RecommendedSensitivityLabelUpdateList type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s recoverable_databases attribute.

get(resource_group_name: str, server_name: str, database_name: str, expand: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RecoverableDatabase[source]

Gets a recoverable 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RecoverableDatabase]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s recoverable_managed_databases attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • recoverable_database_name (str) – Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RecoverableManagedDatabase]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s replication_links attribute.

begin_delete(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]

Deletes the 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • link_id (str) – Required.

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[None]

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • link_id (str) – The name of the replication link. Required.

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 ReplicationLink or the result of cls(response)

Return type

LROPoller[ReplicationLink]

Raises

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[azure.mgmt.sql.models._models_py3.ReplicationLink][source]

Fails over from the current primary server to this server allowing 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • link_id (str) – The name of the replication link. Required.

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 ReplicationLink or the result of cls(response)

Return type

LROPoller[ReplicationLink]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • link_id (str) – The name of the replication link. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReplicationLink]

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReplicationLink]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s restorable_dropped_databases attribute.

get(resource_group_name: str, server_name: str, restorable_dropped_database_id: str, expand: Optional[str] = None, filter: Optional[str] = None, **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. Required.

  • server_name (str) – The name of the server. Required.

  • restorable_dropped_database_id (str) – Required.

  • expand (str) – The child resources to include in the response. Default value is None.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableDroppedDatabase]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s restorable_dropped_managed_databases attribute.

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • restorable_dropped_database_id (str) – Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorableDroppedManagedDatabase]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s restore_points attribute.

begin_create(resource_group_name: str, server_name: str, database_name: str, parameters: _models.CreateDatabaseRestorePointDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RestorePoint][source]
begin_create(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RestorePoint]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (CreateDatabaseRestorePointDefinition or IO) – The definition for creating the restore point of this database. Is either a CreateDatabaseRestorePointDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • restore_point_name (str) – The name of the restore point. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • restore_point_name (str) – The name of the restore point. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RestorePoint]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sensitivity_labels attribute.

create_or_update(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, parameters: _models.SensitivityLabel, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SensitivityLabel[source]
create_or_update(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SensitivityLabel

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

  • parameters (SensitivityLabel or IO) – The column sensitivity label resource. Is either a SensitivityLabel type or a IO type. Required.

Keyword Arguments

  • sensitivity_label_source (str) – The source of the sensitivity label. Default value is “current”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

SensitivityLabel or the result of cls(response)

Return type

SensitivityLabel

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

Keyword Arguments

  • sensitivity_label_source (str) – The source of the sensitivity label. Default value is “current”. Note that overriding this default value may result in unsupported behavior.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

Keyword Arguments

  • sensitivity_label_source (str) – Default value is “recommended”. Note that overriding this default value may result in unsupported behavior.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

Keyword Arguments

  • sensitivity_label_source (str) – Default value is “recommended”. Note that overriding this default value may result in unsupported behavior.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • schema_name (str) – The name of the schema. Required.

  • table_name (str) – The name of the table. Required.

  • column_name (str) – The name of the column. Required.

  • sensitivity_label_source (str or SensitivityLabelSource) – The source of the sensitivity label. Known values are: “current” and “recommended”. Required.

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

SensitivityLabel

Raises

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.SensitivityLabel][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • skip_token (str) – Default value is None.

  • count (bool) – Default value is None.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SensitivityLabel]

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • skip_token (str) – Default value is None.

  • include_disabled_recommendations (bool) – Specifies whether to include disabled recommendations or not. Default value is None.

  • filter (str) – An OData filter expression that filters elements in the collection. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SensitivityLabel]

Raises

HttpResponseError –

update(resource_group_name: str, server_name: str, database_name: str, parameters: _models.SensitivityLabelUpdateList, *, content_type: str = "'application/json'", **kwargs: Any) → None[source]
update(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • parameters (SensitivityLabelUpdateList or IO) – Is either a SensitivityLabelUpdateList type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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.ServerAdvancedThreatProtectionSettingsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_advanced_threat_protection_settings attribute.

begin_create_or_update(resource_group_name: str, server_name: str, advanced_threat_protection_name: Union[str, _models.AdvancedThreatProtectionName], parameters: _models.ServerAdvancedThreatProtection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerAdvancedThreatProtection][source]
begin_create_or_update(resource_group_name: str, server_name: str, advanced_threat_protection_name: Union[str, _models.AdvancedThreatProtectionName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerAdvancedThreatProtection]

Creates or updates an Advanced Threat Protection state.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state. “Default” Required.

  • parameters (ServerAdvancedThreatProtection or IO) – The server Advanced Threat Protection state. Is either a ServerAdvancedThreatProtection type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ServerAdvancedThreatProtection or the result of cls(response)

Return type

LROPoller[ServerAdvancedThreatProtection]

Raises

HttpResponseError –

get(resource_group_name: str, server_name: str, advanced_threat_protection_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdvancedThreatProtectionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerAdvancedThreatProtection[source]

Get a server’s Advanced Threat Protection state.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state. “Default” Required.

Keyword Arguments

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

Returns

ServerAdvancedThreatProtection or the result of cls(response)

Return type

ServerAdvancedThreatProtection

Raises

HttpResponseError –

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

Get a list of the server’s Advanced Threat Protection states.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerAdvancedThreatProtection]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_advisors attribute.

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

  • server_name (str) – The name of the server. Required.

  • advisor_name (str) – The name of the Server Advisor. Required.

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

Advisor

Raises

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

  • server_name (str) – The name of the server. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

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

HttpResponseError –

update(resource_group_name: str, server_name: str, advisor_name: str, parameters: _models.Advisor, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Advisor[source]
update(resource_group_name: str, server_name: str, advisor_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Advisor

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

  • server_name (str) – The name of the server. Required.

  • advisor_name (str) – The name of the Server Advisor. Required.

  • parameters (Advisor or IO) – The requested advisor resource state. Is either a Advisor type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

Advisor or the result of cls(response)

Return type

Advisor

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_automatic_tuning attribute.

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

  • server_name (str) – The name of the server. Required.

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

HttpResponseError –

update(resource_group_name: str, server_name: str, parameters: _models.ServerAutomaticTuning, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServerAutomaticTuning[source]
update(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServerAutomaticTuning

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

  • server_name (str) – The name of the server. Required.

  • parameters (ServerAutomaticTuning or IO) – The requested automatic tuning resource state. Is either a ServerAutomaticTuning type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_azure_ad_administrators attribute.

begin_create_or_update(resource_group_name: str, server_name: str, administrator_name: Union[str, _models.AdministratorName], parameters: _models.ServerAzureADAdministrator, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerAzureADAdministrator][source]
begin_create_or_update(resource_group_name: str, server_name: str, administrator_name: Union[str, _models.AdministratorName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerAzureADAdministrator]

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

  • server_name (str) – The name of the server. Required.

  • administrator_name (str or AdministratorName) – The name of server active directory administrator. “ActiveDirectory” Required.

  • parameters (ServerAzureADAdministrator or IO) – The requested Azure Active Directory administrator Resource state. Is either a ServerAzureADAdministrator type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ServerAzureADAdministrator]

Raises

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

  • server_name (str) – The name of the server. Required.

  • administrator_name (str or AdministratorName) – The name of server active directory administrator. “ActiveDirectory” Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • administrator_name (str or AdministratorName) – The name of server active directory administrator. “ActiveDirectory” Required.

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

ServerAzureADAdministrator

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerAzureADAdministrator]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_azure_ad_only_authentications attribute.

begin_create_or_update(resource_group_name: str, server_name: str, authentication_name: Union[str, _models.AuthenticationName], parameters: _models.ServerAzureADOnlyAuthentication, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerAzureADOnlyAuthentication][source]
begin_create_or_update(resource_group_name: str, server_name: str, authentication_name: Union[str, _models.AuthenticationName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerAzureADOnlyAuthentication]

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

  • server_name (str) – The name of the server. Required.

  • authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication. “Default” Required.

  • parameters (ServerAzureADOnlyAuthentication or IO) – The required parameters for creating or updating an Active Directory only authentication property. Is either a ServerAzureADOnlyAuthentication type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication. “Default” Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication. “Default” Required.

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

ServerAzureADOnlyAuthentication

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerAzureADOnlyAuthentication]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_blob_auditing_policies attribute.

begin_create_or_update(resource_group_name: str, server_name: str, parameters: _models.ServerBlobAuditingPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerBlobAuditingPolicy][source]
begin_create_or_update(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerBlobAuditingPolicy]

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

  • server_name (str) – The name of the server. Required.

  • parameters (ServerBlobAuditingPolicy or IO) – Properties of blob auditing policy. Is either a ServerBlobAuditingPolicy type or a IO type. Required.

Keyword Arguments

  • blob_auditing_policy_name (str) – The name of the blob auditing policy. Default value is “default”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

  • blob_auditing_policy_name (str) – The name of the blob auditing policy. Default value is “default”. Note that overriding this default value may result in unsupported behavior.

  • 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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerBlobAuditingPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_communication_links attribute.

begin_create_or_update(resource_group_name: str, server_name: str, communication_link_name: str, parameters: _models.ServerCommunicationLink, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerCommunicationLink][source]
begin_create_or_update(resource_group_name: str, server_name: str, communication_link_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerCommunicationLink]

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

  • server_name (str) – The name of the server. Required.

  • communication_link_name (str) – The name of the server communication link. Required.

  • parameters (ServerCommunicationLink or IO) – The required parameters for creating a server communication link. Is either a ServerCommunicationLink type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • communication_link_name (str) – The name of the server communication link. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • communication_link_name (str) – The name of the server communication link. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerCommunicationLink]

Raises

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.ServerConfigurationOptionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_configuration_options attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, server_configuration_option_name: Union[str, _models.ServerConfigurationOptionName], parameters: _models.ServerConfigurationOption, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerConfigurationOption][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, server_configuration_option_name: Union[str, _models.ServerConfigurationOptionName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerConfigurationOption]

Updates managed instance server configuration option.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • server_configuration_option_name (str or ServerConfigurationOptionName) – The name of the server configuration option. “allowPolybaseExport” Required.

  • parameters (ServerConfigurationOption or IO) – Server configuration option parameters. Is either a ServerConfigurationOption type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 ServerConfigurationOption or the result of cls(response)

Return type

LROPoller[ServerConfigurationOption]

Raises

HttpResponseError –

get(resource_group_name: str, managed_instance_name: str, server_configuration_option_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ServerConfigurationOptionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerConfigurationOption[source]

Gets managed instance server configuration option.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • server_configuration_option_name (str or ServerConfigurationOptionName) – The name of the server configuration option. “allowPolybaseExport” Required.

Keyword Arguments

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

Returns

ServerConfigurationOption or the result of cls(response)

Return type

ServerConfigurationOption

Raises

HttpResponseError –

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

Gets a list of managed instance server configuration 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerConfigurationOption]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_connection_policies attribute.

begin_create_or_update(resource_group_name: str, server_name: str, connection_policy_name: Union[str, _models.ConnectionPolicyName], parameters: _models.ServerConnectionPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerConnectionPolicy][source]
begin_create_or_update(resource_group_name: str, server_name: str, connection_policy_name: Union[str, _models.ConnectionPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerConnectionPolicy]

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

  • server_name (str) – The name of the server. Required.

  • connection_policy_name (str or ConnectionPolicyName) – The name of the connection policy. “default” Required.

  • parameters (ServerConnectionPolicy or IO) – The required parameters for updating a server connection policy. Is either a ServerConnectionPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • connection_policy_name (str or ConnectionPolicyName) – The name of the connection policy. “default” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerConnectionPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_dev_ops_audit_settings attribute.

begin_create_or_update(resource_group_name: str, server_name: str, dev_ops_auditing_settings_name: Union[str, _models.DevOpsAuditingSettingsName], parameters: _models.ServerDevOpsAuditingSettings, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerDevOpsAuditingSettings][source]
begin_create_or_update(resource_group_name: str, server_name: str, dev_ops_auditing_settings_name: Union[str, _models.DevOpsAuditingSettingsName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerDevOpsAuditingSettings]

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

  • server_name (str) – The name of the server. Required.

  • dev_ops_auditing_settings_name (str or DevOpsAuditingSettingsName) – “Default” Required.

  • parameters (ServerDevOpsAuditingSettings or IO) – Properties of DevOps audit settings. Is either a ServerDevOpsAuditingSettings type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

HttpResponseError –

get(resource_group_name: str, server_name: str, dev_ops_auditing_settings_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.DevOpsAuditingSettingsName], **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. Required.

  • server_name (str) – The name of the server. Required.

  • dev_ops_auditing_settings_name (str or DevOpsAuditingSettingsName) – “Default” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerDevOpsAuditingSettings]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_dns_aliases attribute.

begin_acquire(resource_group_name: str, server_name: str, dns_alias_name: str, parameters: _models.ServerDnsAliasAcquisition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerDnsAlias][source]
begin_acquire(resource_group_name: str, server_name: str, dns_alias_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerDnsAlias]

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

  • server_name (str) – The name of the server that the alias is pointing to. Required.

  • dns_alias_name (str) – The name of the server dns alias. Required.

  • parameters (ServerDnsAliasAcquisition or IO) – Is either a ServerDnsAliasAcquisition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server that the alias is pointing to. Required.

  • dns_alias_name (str) – The name of the server dns alias. Required.

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

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

  • server_name (str) – The name of the server that the alias is pointing to. Required.

  • dns_alias_name (str) – The name of the server dns alias. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server that the alias is pointing to. Required.

  • dns_alias_name (str) – The name of the server dns alias. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server that the alias is pointing to. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerDnsAlias]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_keys attribute.

begin_create_or_update(resource_group_name: str, server_name: str, key_name: str, parameters: _models.ServerKey, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerKey][source]
begin_create_or_update(resource_group_name: str, server_name: str, key_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerKey]

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

  • server_name (str) – The name of the server. Required.

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

  • parameters (ServerKey or IO) – The requested server key resource state. Is either a ServerKey type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • key_name (str) – The name of the server key to be deleted. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • key_name (str) – The name of the server key to be retrieved. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerKey]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_operations attribute.

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerOperation]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_security_alert_policies attribute.

begin_create_or_update(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: _models.ServerSecurityAlertPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerSecurityAlertPolicy][source]
begin_create_or_update(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerSecurityAlertPolicy]

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

  • server_name (str) – The name of the server. Required.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the threat detection policy. “Default” Required.

  • parameters (ServerSecurityAlertPolicy or IO) – The server security alert policy. Is either a ServerSecurityAlertPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy. “Default” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerSecurityAlertPolicy]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_trust_certificates attribute.

begin_create_or_update(resource_group_name: str, managed_instance_name: str, certificate_name: str, parameters: _models.ServerTrustCertificate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerTrustCertificate][source]
begin_create_or_update(resource_group_name: str, managed_instance_name: str, certificate_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerTrustCertificate]

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • certificate_name (str) – Name of of the certificate to upload. Required.

  • parameters (ServerTrustCertificate or IO) – The server trust certificate info. Is either a ServerTrustCertificate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • certificate_name (str) – Name of of the certificate to delete. Required.

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[None]

Raises

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • certificate_name (str) – Name of of the certificate to get. Required.

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

HttpResponseError –

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

Gets a list of server trust certificates that were uploaded from box to 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. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerTrustCertificate]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_trust_groups attribute.

begin_create_or_update(resource_group_name: str, location_name: str, server_trust_group_name: str, parameters: _models.ServerTrustGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerTrustGroup][source]
begin_create_or_update(resource_group_name: str, location_name: str, server_trust_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerTrustGroup]

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

  • location_name (str) – The name of the region where the resource is located. Required.

  • server_trust_group_name (str) – The name of the server trust group. Required.

  • parameters (ServerTrustGroup or IO) – The server trust group parameters. Is either a ServerTrustGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • location_name (str) – The name of the region where the resource is located. Required.

  • server_trust_group_name (str) – The name of the server trust group. Required.

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[None]

Raises

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

  • location_name (str) – The name of the region where the resource is located. Required.

  • server_trust_group_name (str) – The name of the server trust group. Required.

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

HttpResponseError –

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

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerTrustGroup]

Raises

HttpResponseError –

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

  • location_name (str) – The name of the region where the resource is located. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerTrustGroup]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_usages attribute.

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerUsage]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s server_vulnerability_assessments attribute.

create_or_update(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: _models.ServerVulnerabilityAssessment, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServerVulnerabilityAssessment[source]
create_or_update(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServerVulnerabilityAssessment

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

  • server_name (str) – The name of the server for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • parameters (ServerVulnerabilityAssessment or IO) – The requested resource. Is either a ServerVulnerabilityAssessment type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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

None

Raises

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

  • server_name (str) – The name of the server for which the vulnerability assessment is defined. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServerVulnerabilityAssessment]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s servers attribute.

begin_create_or_update(resource_group_name: str, server_name: str, parameters: _models.Server, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Server][source]
begin_create_or_update(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Server]

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

  • server_name (str) – The name of the server. Required.

  • parameters (Server or IO) – The requested server resource state. Is either a Server type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

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[None]

Raises

HttpResponseError –

begin_import_database(resource_group_name: str, server_name: str, parameters: _models.ImportNewDatabaseDefinition, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImportExportOperationResult][source]
begin_import_database(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ImportExportOperationResult]

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

  • server_name (str) – The name of the server. Required.

  • parameters (ImportNewDatabaseDefinition or IO) – The database import request parameters. Is either a ImportNewDatabaseDefinition type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[ImportExportOperationResult]

Raises

HttpResponseError –

begin_refresh_status(resource_group_name: str, server_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.RefreshExternalGovernanceStatusOperationResult][source]

Refresh external governance enablement status.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

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 RefreshExternalGovernanceStatusOperationResult or the result of cls(response)

Return type

LROPoller[RefreshExternalGovernanceStatusOperationResult]

Raises

HttpResponseError –

begin_update(resource_group_name: str, server_name: str, parameters: _models.ServerUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Server][source]
begin_update(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Server]

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

  • server_name (str) – The name of the server. Required.

  • parameters (ServerUpdate or IO) – The requested server resource state. Is either a ServerUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

HttpResponseError –

check_name_availability(parameters: _models.CheckNameAvailabilityRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResponse[source]
check_name_availability(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResponse

Determines whether a resource can be created with the specified name.

Parameters

parameters (CheckNameAvailabilityRequest or IO) – The name availability request parameters. Is either a CheckNameAvailabilityRequest type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

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

HttpResponseError –

list(expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.Server][source]

Gets a list of all servers in the subscription.

Parameters

expand (str) – The child resources to include in the response. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Server]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.Server][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. Required.

  • expand (str) – The child resources to include in the response. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Server]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s service_objectives attribute.

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

  • server_name (str) – The name of the server. Required.

  • service_objective_name (str) – The name of the service objective to retrieve. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ServiceObjective]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_agent attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, parameters: _models.SqlAgentConfiguration, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SqlAgentConfiguration[source]
create_or_update(resource_group_name: str, managed_instance_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SqlAgentConfiguration

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

  • managed_instance_name (str) – The name of the managed instance. Required.

  • parameters (SqlAgentConfiguration or IO) – Is either a SqlAgentConfiguration type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • managed_instance_name (str) – The name of the managed instance. Required.

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

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.SqlVulnerabilityAssessmentBaselineOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessment_baseline attribute.

get(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.BaselineName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSqlVulnerabilityAssessmentBaselineSet[source]

Gets a list of database’s sql vulnerability assessment rule baselines.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

DatabaseSqlVulnerabilityAssessmentBaselineSet or the result of cls(response)

Return type

DatabaseSqlVulnerabilityAssessmentBaselineSet

Raises

HttpResponseError –

list_by_sql_vulnerability_assessment(resource_group_name: str, server_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.DatabaseSqlVulnerabilityAssessmentBaselineSet][source]

Gets a list of database’s sql vulnerability assessment rule baselines.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

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

Return type

ItemPaged[DatabaseSqlVulnerabilityAssessmentBaselineSet]

Raises

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.SqlVulnerabilityAssessmentBaselinesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessment_baselines attribute.

create_or_update(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], baseline_name: Union[str, _models.BaselineName], parameters: _models.DatabaseSqlVulnerabilityAssessmentRuleBaselineListInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSqlVulnerabilityAssessmentBaselineSet[source]
create_or_update(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], baseline_name: Union[str, _models.BaselineName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSqlVulnerabilityAssessmentBaselineSet

Add a database’s vulnerability assessment rule baseline 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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

  • parameters (DatabaseSqlVulnerabilityAssessmentRuleBaselineListInput or IO) – The requested rule baseline resource. Is either a DatabaseSqlVulnerabilityAssessmentRuleBaselineListInput type or a IO type. Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseSqlVulnerabilityAssessmentBaselineSet or the result of cls(response)

Return type

DatabaseSqlVulnerabilityAssessmentBaselineSet

Raises

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.SqlVulnerabilityAssessmentExecuteScanOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessment_execute_scan attribute.

begin_execute(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

  • 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[None]

Raises

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.SqlVulnerabilityAssessmentRuleBaselineOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessment_rule_baseline attribute.

create_or_update(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], baseline_name: Union[str, _models.BaselineName], rule_id: str, parameters: _models.DatabaseSqlVulnerabilityAssessmentRuleBaselineInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSqlVulnerabilityAssessmentRuleBaseline[source]
create_or_update(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], baseline_name: Union[str, _models.BaselineName], rule_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DatabaseSqlVulnerabilityAssessmentRuleBaseline

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

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

  • parameters (DatabaseSqlVulnerabilityAssessmentRuleBaselineInput or IO) – The requested rule baseline resource. Is either a DatabaseSqlVulnerabilityAssessmentRuleBaselineInput type or a IO type. Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DatabaseSqlVulnerabilityAssessmentRuleBaseline or the result of cls(response)

Return type

DatabaseSqlVulnerabilityAssessmentRuleBaseline

Raises

HttpResponseError –

get(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.BaselineName], rule_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSqlVulnerabilityAssessmentRuleBaseline[source]

Gets a system database’s sql 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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

DatabaseSqlVulnerabilityAssessmentRuleBaseline or the result of cls(response)

Return type

DatabaseSqlVulnerabilityAssessmentRuleBaseline

Raises

HttpResponseError –

list_by_baseline(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.BaselineName], **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseSqlVulnerabilityAssessmentRuleBaseline][source]

Gets a system database’s sql 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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

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

Return type

ItemPaged[DatabaseSqlVulnerabilityAssessmentRuleBaseline]

Raises

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.SqlVulnerabilityAssessmentRuleBaselinesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessment_rule_baselines attribute.

delete(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.BaselineName], rule_id: str, **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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • baseline_name (str or BaselineName) – “default” Required.

  • rule_id (str) – The vulnerability assessment rule ID. Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

None or the result of cls(response)

Return type

None

Raises

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.SqlVulnerabilityAssessmentScanResultOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessment_scan_result attribute.

get(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SQLVulnerabilityAssessmentName], scan_id: str, scan_result_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SqlVulnerabilityAssessmentScanResults[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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or SQLVulnerabilityAssessmentName) – The name of the SQL Vulnerability Assessment. “default” Required.

  • scan_id (str) – The scan id of the SQL Vulnerability Assessment scan to retrieve result from. Required.

  • scan_result_id (str) – The scan result id of the specific result to retrieve. Required.

Keyword Arguments

  • system_database_name (str) – The SQL vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

SqlVulnerabilityAssessmentScanResults or the result of cls(response)

Return type

SqlVulnerabilityAssessmentScanResults

Raises

HttpResponseError –

list_by_scan(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SQLVulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SqlVulnerabilityAssessmentScanResults][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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or SQLVulnerabilityAssessmentName) – The name of the SQL Vulnerability Assessment. “default” Required.

  • scan_id (str) – The scan id of the SQL Vulnerability Assessment scan to retrieve result from. Required.

Keyword Arguments

  • system_database_name (str) – The SQL vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

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

Return type

ItemPaged[SqlVulnerabilityAssessmentScanResults]

Raises

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.SqlVulnerabilityAssessmentScansOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessment_scans attribute.

get(resource_group_name: str, server_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.SqlVulnerabilityAssessmentScanRecord[source]

Get a system database vulnerability assessment scan record.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

  • scan_id (str) – Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

SqlVulnerabilityAssessmentScanRecord or the result of cls(response)

Return type

SqlVulnerabilityAssessmentScanRecord

Raises

HttpResponseError –

list_by_sql_vulnerability_assessments(resource_group_name: str, server_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.SqlVulnerabilityAssessmentScanRecord][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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment. “default” Required.

Keyword Arguments

  • system_database_name (str) – The vulnerability assessment system database name. Default value is “master”. Note that overriding this default value may result in unsupported behavior.

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

Returns

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

Return type

ItemPaged[SqlVulnerabilityAssessmentScanRecord]

Raises

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.SqlVulnerabilityAssessmentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessments attribute.

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 SQL 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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the SQL Vulnerability Assessment. “default” Required.

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

None

Raises

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.SqlVulnerabilityAssessmentsSettingsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sql_vulnerability_assessments_settings attribute.

create_or_update(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: _models.SqlVulnerabilityAssessment, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SqlVulnerabilityAssessment[source]
create_or_update(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, _models.VulnerabilityAssessmentName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SqlVulnerabilityAssessment

Creates or updates SQL Vulnerability Assessment 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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the SQL Vulnerability Assessment. “default” Required.

  • parameters (SqlVulnerabilityAssessment or IO) – The requested resource. Is either a SqlVulnerabilityAssessment type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

SqlVulnerabilityAssessment or the result of cls(response)

Return type

SqlVulnerabilityAssessment

Raises

HttpResponseError –

get(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SqlVulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.SqlVulnerabilityAssessment[source]

Gets SQL Vulnerability Assessment 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. Required.

  • server_name (str) – The name of the server. Required.

  • vulnerability_assessment_name (str or SqlVulnerabilityAssessmentName) – The name of the SQL Vulnerability Assessment. “default” Required.

Keyword Arguments

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

Returns

SqlVulnerabilityAssessment or the result of cls(response)

Return type

SqlVulnerabilityAssessment

Raises

HttpResponseError –

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

Lists SQL 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. Required.

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SqlVulnerabilityAssessment]

Raises

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.StartStopManagedInstanceSchedulesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s start_stop_managed_instance_schedules attribute.

create_or_update(resource_group_name: str, managed_instance_name: str, start_stop_schedule_name: Union[str, _models.StartStopScheduleName], parameters: _models.StartStopManagedInstanceSchedule, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StartStopManagedInstanceSchedule[source]
create_or_update(resource_group_name: str, managed_instance_name: str, start_stop_schedule_name: Union[str, _models.StartStopScheduleName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StartStopManagedInstanceSchedule

Creates or updates the managed instance’s Start/Stop schedule.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • start_stop_schedule_name (str or StartStopScheduleName) – Name of the managed instance Start/Stop schedule. “default” Required.

  • parameters (StartStopManagedInstanceSchedule or IO) – The requested managed instance Start/Stop schedule. Is either a StartStopManagedInstanceSchedule type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

StartStopManagedInstanceSchedule or the result of cls(response)

Return type

StartStopManagedInstanceSchedule

Raises

HttpResponseError –

delete(resource_group_name: str, managed_instance_name: str, start_stop_schedule_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.StartStopScheduleName], **kwargs: Any) → None[source]

Deletes the managed instance’s Start/Stop schedule.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • start_stop_schedule_name (str or StartStopScheduleName) – Name of the managed instance Start/Stop schedule. “default” Required.

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

None

Raises

HttpResponseError –

get(resource_group_name: str, managed_instance_name: str, start_stop_schedule_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.StartStopScheduleName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.StartStopManagedInstanceSchedule[source]

Gets the managed instance’s Start/Stop schedule.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

  • start_stop_schedule_name (str or StartStopScheduleName) – Name of the managed instance Start/Stop schedule. “default” Required.

Keyword Arguments

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

Returns

StartStopManagedInstanceSchedule or the result of cls(response)

Return type

StartStopManagedInstanceSchedule

Raises

HttpResponseError –

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

Lists the managed instance’s Start/Stop schedules.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • managed_instance_name (str) – The name of the managed instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[StartStopManagedInstanceSchedule]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s subscription_usages attribute.

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

  • usage_name (str) – Name of usage metric to return. Required.

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

HttpResponseError –

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

Gets all subscription usage metrics in a given location.

Parameters

location_name (str) – The name of the region where the resource is located. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SubscriptionUsage]

Raises

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.SynapseLinkWorkspacesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s synapse_link_workspaces attribute.

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

Gets all synapselink workspaces 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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SynapseLinkWorkspace]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sync_agents attribute.

begin_create_or_update(resource_group_name: str, server_name: str, sync_agent_name: str, parameters: _models.SyncAgent, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncAgent][source]
begin_create_or_update(resource_group_name: str, server_name: str, sync_agent_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncAgent]

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

  • server_name (str) – The name of the server on which the sync agent is hosted. Required.

  • sync_agent_name (str) – The name of the sync agent. Required.

  • parameters (SyncAgent or IO) – The requested sync agent resource state. Is either a SyncAgent type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server on which the sync agent is hosted. Required.

  • sync_agent_name (str) – The name of the sync agent. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server on which the sync agent is hosted. Required.

  • sync_agent_name (str) – The name of the sync agent. Required.

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

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

  • server_name (str) – The name of the server on which the sync agent is hosted. Required.

  • sync_agent_name (str) – The name of the sync agent. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server on which the sync agent is hosted. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncAgent]

Raises

HttpResponseError –

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

  • server_name (str) – The name of the server on which the sync agent is hosted. Required.

  • sync_agent_name (str) – The name of the sync agent. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncAgentLinkedDatabase]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sync_groups attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: _models.SyncGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncGroup][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncGroup]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

  • parameters (SyncGroup or IO) – The requested sync group resource state. Is either a SyncGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: _models.SyncGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncGroup][source]
begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncGroup]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

  • parameters (SyncGroup or IO) – The requested sync group resource state. Is either a SyncGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

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

None

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncGroup]

Raises

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.SyncFullSchemaProperties][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncFullSchemaProperties]

Raises

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.SyncGroupLogProperties][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

  • start_time (str) – Get logs generated after this time. Required.

  • end_time (str) – Get logs generated before this time. Required.

  • type (str or SyncGroupsType) – The types of logs to retrieve. Known values are: “All”, “Error”, “Warning”, and “Success”. Required.

  • continuation_token_parameter (str) – The continuation token for this operation. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncGroupLogProperties]

Raises

HttpResponseError –

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

Gets a collection of sync database ids.

Parameters

location_name (str) – The name of the region where the resource is located. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncDatabaseIdProperties]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

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

None

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s sync_members attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: _models.SyncMember, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncMember][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncMember]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group on which the sync member is hosted. Required.

  • sync_member_name (str) – The name of the sync member. Required.

  • parameters (SyncMember or IO) – The requested sync member resource state. Is either a SyncMember type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group on which the sync member is hosted. Required.

  • sync_member_name (str) – The name of the sync member. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group on which the sync member is hosted. Required.

  • sync_member_name (str) – The name of the sync member. Required.

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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: _models.SyncMember, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncMember][source]
begin_update(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SyncMember]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group on which the sync member is hosted. Required.

  • sync_member_name (str) – The name of the sync member. Required.

  • parameters (SyncMember or IO) – The requested sync member resource state. Is either a SyncMember type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group on which the sync member is hosted. Required.

  • sync_member_name (str) – The name of the sync member. Required.

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

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.SyncMember][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncMember]

Raises

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.SyncFullSchemaProperties][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database on which the sync group is hosted. Required.

  • sync_group_name (str) – The name of the sync group on which the sync member is hosted. Required.

  • sync_member_name (str) – The name of the sync member. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SyncFullSchemaProperties]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s tde_certificates attribute.

begin_create(resource_group_name: str, server_name: str, parameters: _models.TdeCertificate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None][source]
begin_create(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

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

  • server_name (str) – The name of the server. Required.

  • parameters (TdeCertificate or IO) – The requested TDE certificate to be created or updated. Is either a TdeCertificate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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[None]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s time_zones attribute.

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) – Required.

  • time_zone_id (str) – Required.

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

HttpResponseError –

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

Gets a list of managed instance time zones by location.

Parameters

location_name (str) – Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TimeZone]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s transparent_data_encryptions attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, tde_name: Union[str, _models.TransparentDataEncryptionName], parameters: _models.LogicalDatabaseTransparentDataEncryption, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LogicalDatabaseTransparentDataEncryption][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, tde_name: Union[str, _models.TransparentDataEncryptionName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LogicalDatabaseTransparentDataEncryption]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the logical database for which the security alert policy is defined. Required.

  • tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration. “current” Required.

  • parameters (LogicalDatabaseTransparentDataEncryption or IO) – The database transparent data encryption. Is either a LogicalDatabaseTransparentDataEncryption type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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 LogicalDatabaseTransparentDataEncryption or the result of cls(response)

Return type

LROPoller[LogicalDatabaseTransparentDataEncryption]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the logical database for which the transparent data encryption is defined. Required.

  • tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration. “current” Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the logical database for which the transparent data encryption is defined. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LogicalDatabaseTransparentDataEncryption]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s usages attribute.

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.Usage][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. Required.

  • instance_pool_name (str) – The name of the instance pool to be retrieved. Required.

  • expand_children (bool) – Optional request parameter to include managed instance usages within the instance pool. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Usage]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s virtual_clusters attribute.

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

  • virtual_cluster_name (str) – The name of the virtual cluster. Required.

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[None]

Raises

HttpResponseError –

begin_update(resource_group_name: str, virtual_cluster_name: str, parameters: _models.VirtualClusterUpdate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualCluster][source]
begin_update(resource_group_name: str, virtual_cluster_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualCluster]

Updates an existing 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. Required.

  • virtual_cluster_name (str) – The name of the virtual cluster. Required.

  • parameters (VirtualClusterUpdate or IO) – The requested virtual cluster resource state. Is either a VirtualClusterUpdate type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

LROPoller[VirtualCluster]

Raises

HttpResponseError –

begin_update_dns_servers(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.UpdateVirtualClusterDnsServersOperation][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. Required.

  • virtual_cluster_name (str) – The name of the virtual cluster. Required.

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 UpdateVirtualClusterDnsServersOperation or the result of cls(response)

Return type

LROPoller[UpdateVirtualClusterDnsServersOperation]

Raises

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

  • virtual_cluster_name (str) – The name of the virtual cluster. Required.

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

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VirtualCluster][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 VirtualCluster or the result of cls(response)

Return type

ItemPaged[VirtualCluster]

Raises

HttpResponseError –

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualCluster]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s virtual_network_rules attribute.

begin_create_or_update(resource_group_name: str, server_name: str, virtual_network_rule_name: str, parameters: _models.VirtualNetworkRule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkRule][source]
begin_create_or_update(resource_group_name: str, server_name: str, virtual_network_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkRule]

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

  • server_name (str) – The name of the server. Required.

  • virtual_network_rule_name (str) – The name of the virtual network rule. Required.

  • parameters (VirtualNetworkRule or IO) – The requested virtual Network Rule Resource state. Is either a VirtualNetworkRule type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • virtual_network_rule_name (str) – The name of the virtual network rule. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • virtual_network_rule_name (str) – The name of the virtual network rule. Required.

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

HttpResponseError –

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

  • server_name (str) – The name of the server. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VirtualNetworkRule]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s workload_classifiers attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, workload_classifier_name: str, parameters: _models.WorkloadClassifier, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.WorkloadClassifier][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, workload_classifier_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.WorkloadClassifier]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • workload_group_name (str) – The name of the workload group from which to receive the classifier from. Required.

  • workload_classifier_name (str) – The name of the workload classifier to create/update. Required.

  • parameters (WorkloadClassifier or IO) – The properties of the workload classifier. Is either a WorkloadClassifier type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • workload_group_name (str) – The name of the workload group from which to receive the classifier from. Required.

  • workload_classifier_name (str) – The name of the workload classifier to delete. Required.

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[None]

Raises

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • workload_group_name (str) – The name of the workload group from which to receive the classifier from. Required.

  • workload_classifier_name (str) – The name of the workload classifier. Required.

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

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.WorkloadClassifier][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. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • workload_group_name (str) – The name of the workload group from which to receive the classifiers from. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[WorkloadClassifier]

Raises

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(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SqlManagementClient’s workload_groups attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, parameters: _models.WorkloadGroup, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.WorkloadGroup][source]
begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.WorkloadGroup]

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • workload_group_name (str) – The name of the workload group. Required.

  • parameters (WorkloadGroup or IO) – The requested workload group state. Is either a WorkloadGroup type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • 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

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

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • workload_group_name (str) – The name of the workload group to delete. Required.

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[None]

Raises

HttpResponseError –

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

Gets a workload group.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

  • workload_group_name (str) – The name of the workload group. Required.

Keyword Arguments

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

Returns

WorkloadGroup or the result of cls(response)

Return type

WorkloadGroup

Raises

HttpResponseError –

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

Gets the list of workload groups.

Parameters

  • resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

  • server_name (str) – The name of the server. Required.

  • database_name (str) – The name of the database. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[WorkloadGroup]

Raises

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'>