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
’sbackup_short_term_retention_policies
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.BackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.BackupShortTermRetentionPolicy][source]¶ Updates a database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
policy_name (str or ShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (BackupShortTermRetentionPolicy) – The short term retention policy info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 BackupShortTermRetentionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.BackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.BackupShortTermRetentionPolicy][source]¶ Updates a database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
policy_name (str or ShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (BackupShortTermRetentionPolicy) – The short term retention policy info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 BackupShortTermRetentionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
policy_name (str or ShortTermRetentionPolicyName) – The policy name. Should always be “default”.
- Keyword Arguments
- Returns
BackupShortTermRetentionPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.BackupShortTermRetentionPolicyListResult][source]¶ Gets a database’s short term retention policy.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either BackupShortTermRetentionPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
CapabilitiesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’scapabilities
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.
include (str or CapabilityGroup) – If specified, restricts the response to only include the selected item. Default value is None.
- Keyword Arguments
- Returns
LocationCapabilities, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DataMaskingPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdata_masking_policies
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.DataMaskingPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DataMaskingPolicy[source]¶ Creates or updates a database data masking policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (DataMaskingPolicy) – Parameters for creating or updating a data masking policy.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2014-04-01”. Note that overriding this default value may result in unsupported behavior.
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
- Raises
~azure.core.exceptions.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
- Keyword Arguments
api_version (str) – Api Version. Default value is “2014-04-01”. Note that overriding this default value may result in unsupported behavior.
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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DataMaskingRulesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdata_masking_rules
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, data_masking_rule_name: str, parameters: azure.mgmt.sql.models._models_py3.DataMaskingRule, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DataMaskingRule[source]¶ Creates or updates a database data masking rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
data_masking_rule_name (str) – The name of the data masking rule.
parameters (DataMaskingRule) – The required parameters for creating or updating a data masking rule.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2014-04-01”. Note that overriding this default value may result in unsupported behavior.
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
DataMaskingRule, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DataMaskingRuleListResult][source]¶ Gets a list of database data masking rules.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2014-04-01”. Note that overriding this default value may result in unsupported behavior.
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 DataMaskingRuleListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DataWarehouseUserActivitiesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdata_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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
data_warehouse_user_activity_name (str or DataWarehouseUserActivityName) – The activity name of the data warehouse.
- Keyword Arguments
- Returns
DataWarehouseUserActivities, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DataWarehouseUserActivitiesListResult][source]¶ List the user activities of a data warehouse which includes running and suspended queries.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DataWarehouseUserActivitiesListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseAdvancedThreatProtectionSettingsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_advanced_threat_protection_settings
attribute.-
create_or_update
(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], parameters: azure.mgmt.sql.models._models_py3.DatabaseAdvancedThreatProtection, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseAdvancedThreatProtection[source]¶ 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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state.
parameters (DatabaseAdvancedThreatProtection) – The database Advanced Threat Protection state.
- Keyword Arguments
- Returns
DatabaseAdvancedThreatProtection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state.
- Keyword Arguments
- Returns
DatabaseAdvancedThreatProtection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseAdvancedThreatProtectionListResult][source]¶ Gets a list of database’s Advanced Threat Protection states.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseAdvancedThreatProtectionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseAdvisorsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
advisor_name (str) – The name of the Database Advisor.
- Keyword Arguments
- Returns
Advisor, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, expand: Optional[str] = None, **kwargs: Any) → List[azure.mgmt.sql.models._models_py3.Advisor][source]¶ Gets a list of database advisors.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
expand (str) – The child resources to include in the response. Default value is None.
- Keyword Arguments
- Returns
list of Advisor, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, parameters: azure.mgmt.sql.models._models_py3.Advisor, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Advisor[source]¶ Updates a database advisor.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
advisor_name (str) – The name of the Database Advisor.
parameters (Advisor) – The requested advisor resource state.
- Keyword Arguments
- Returns
Advisor, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseAutomaticTuningOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_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
- Keyword Arguments
- Returns
DatabaseAutomaticTuning, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.DatabaseAutomaticTuning, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseAutomaticTuning[source]¶ Update automatic tuning properties for target database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (DatabaseAutomaticTuning) – The requested automatic tuning resource state.
- Keyword Arguments
- Returns
DatabaseAutomaticTuning, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseBlobAuditingPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_blob_auditing_policies
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.DatabaseBlobAuditingPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseBlobAuditingPolicy[source]¶ Creates or updates a database’s blob auditing policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (DatabaseBlobAuditingPolicy) – The database blob auditing policy.
- Keyword Arguments
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.
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseBlobAuditingPolicy[source]¶ Gets a database’s blob auditing policy.
- Parameters
- 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.
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseBlobAuditingPolicyListResult][source]¶ Lists auditing settings of a database.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseBlobAuditingPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseColumnsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
- Keyword Arguments
- Returns
DatabaseColumn, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, schema: Optional[List[str]] = None, table: Optional[List[str]] = None, column: Optional[List[str]] = None, order_by: Optional[List[str]] = None, skiptoken: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseColumnListResult][source]¶ List database columns.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
skiptoken (str) – An opaque token that identifies a starting point in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseColumnListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_table
(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseColumnListResult][source]¶ List database columns.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
filter (str) – An OData filter expression that filters elements in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseColumnListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseExtensionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_extensions
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, extension_name: str, parameters: azure.mgmt.sql.models._models_py3.DatabaseExtensions, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ImportExportExtensionsOperationResult][source]¶ Perform a database extension operation, like polybase import.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
extension_name (str) –
parameters (DatabaseExtensions) – The database import request parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 ImportExportExtensionsOperationResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, extension_name: str, **kwargs: Any) → None[source]¶ Gets a database extension. This will return resource not found as it is not supported.
- Parameters
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ImportExportExtensionsOperationListResult][source]¶ List database extension. This will return an empty list as it is not supported.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ImportExportExtensionsOperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseOperationsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
operation_id (str) – The operation identifier.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseOperationListResult][source]¶ Gets a list of operations performed on the database.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseOperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseRecommendedActionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
advisor_name (str) – The name of the Database Advisor.
recommended_action_name (str) – The name of Database Recommended Action.
- Keyword Arguments
- Returns
RecommendedAction, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database_advisor
(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, **kwargs: Any) → List[azure.mgmt.sql.models._models_py3.RecommendedAction][source]¶ Gets list of Database Recommended Actions.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
advisor_name (str) – The name of the Database Advisor.
- Keyword Arguments
- Returns
list of RecommendedAction, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, server_name: str, database_name: str, advisor_name: str, recommended_action_name: str, parameters: azure.mgmt.sql.models._models_py3.RecommendedAction, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RecommendedAction[source]¶ Updates a database recommended action.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
advisor_name (str) – The name of the Database Advisor.
recommended_action_name (str) – The name of Database Recommended Action.
parameters (RecommendedAction) – The requested recommended action resource state.
- Keyword Arguments
- Returns
RecommendedAction, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseSchemasOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_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
- Keyword Arguments
- Returns
DatabaseSchema, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseSchemaListResult][source]¶ List database schemas.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
filter (str) – An OData filter expression that filters elements in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseSchemaListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseSecurityAlertPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_security_alert_policies
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.sql.models._models_py3.DatabaseSecurityAlertPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSecurityAlertPolicy[source]¶ Creates or updates a database’s security alert policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the security alert policy is defined.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
parameters (DatabaseSecurityAlertPolicy) – The database security alert policy.
- Keyword Arguments
- Returns
DatabaseSecurityAlertPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseSecurityAlertPolicy[source]¶ Gets a database’s security alert policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the security alert policy is defined.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
- Keyword Arguments
- Returns
DatabaseSecurityAlertPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseSecurityAlertListResult][source]¶ Gets a list of database’s security alert policies.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the security alert policy is defined.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseSecurityAlertListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseTablesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
- Keyword Arguments
- Returns
DatabaseTable, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_schema
(resource_group_name: str, server_name: str, database_name: str, schema_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseTableListResult][source]¶ List database tables.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
filter (str) – An OData filter expression that filters elements in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseTableListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseUsagesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_usages
attribute.-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseUsageListResult][source]¶ Gets database usages.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseUsageListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseVulnerabilityAssessmentRuleBaselinesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_vulnerability_assessment_rule_baselines
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], parameters: azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline[source]¶ Creates or updates a database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).
parameters (DatabaseVulnerabilityAssessmentRuleBaseline) – The requested rule baseline resource.
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessmentRuleBaseline, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], **kwargs: Any) → None[source]¶ Removes the database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline[source]¶ Gets a database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessmentRuleBaseline, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseVulnerabilityAssessmentScansOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
export
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentScansExport[source]¶ Convert an existing scan result to a human readable format. If already exists nothing happens.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the scanned database.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id.
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessmentScansExport, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentScanRecord[source]¶ Gets a vulnerability assessment scan record of a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
- Keyword Arguments
- Returns
VulnerabilityAssessmentScanRecord, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentScanRecordListResult][source]¶ Lists the vulnerability assessment scans of a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
An iterator like instance of either VulnerabilityAssessmentScanRecordListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabaseVulnerabilityAssessmentsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabase_vulnerability_assessments
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], parameters: azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment[source]¶ Creates or updates the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
parameters (DatabaseVulnerabilityAssessment) – The requested resource.
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → None[source]¶ Removes the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment[source]¶ Gets the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentListResult][source]¶ Lists the vulnerability assessment policies associated with a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment policies are defined.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseVulnerabilityAssessmentListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DatabasesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdatabases
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.Database, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Database][source]¶ Creates a new database or updates an existing database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (Database) – The requested database resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 Database or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes the database.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_export
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ExportDatabaseDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ImportExportOperationResult][source]¶ Exports a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (ExportDatabaseDefinition) – The database export request parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 ImportExportOperationResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_failover
(resource_group_name: str, server_name: str, database_name: str, replica_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ReplicaType]] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Failovers a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to failover.
replica_type (str or ReplicaType) – The type of replica to be failed over. Default value is None.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_import_method
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ImportExistingDatabaseDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ImportExportOperationResult][source]¶ Imports a bacpac into a new database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (ImportExistingDatabaseDefinition) – The database import request parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 ImportExportOperationResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_pause
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Database][source]¶ Pauses a database.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 Database or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_resume
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Database][source]¶ Resumes a database.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 Database or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.DatabaseUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Database][source]¶ Updates an existing database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (DatabaseUpdate) – The requested database resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 Database or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_upgrade_data_warehouse
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Upgrades a data warehouse.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Database[source]¶ Gets a database.
- Parameters
- Keyword Arguments
- Returns
Database, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_elastic_pool
(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseListResult][source]¶ Gets a list of databases in an elastic pool.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseListResult][source]¶ Gets a list of databases.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_inaccessible_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseListResult][source]¶ Gets a list of inaccessible databases in a logical server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_metric_definitions
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.MetricDefinitionListResult][source]¶ Returns database metric definitions.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either MetricDefinitionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_metrics
(resource_group_name: str, server_name: str, database_name: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.MetricListResult][source]¶ Returns database metrics.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
filter (str) – An OData filter expression that describes a subset of metrics to return.
- Keyword Arguments
- Returns
An iterator like instance of either MetricListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
rename
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ResourceMoveDefinition, **kwargs: Any) → None[source]¶ Renames a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to rename.
parameters (ResourceMoveDefinition) – The resource move definition for renaming this database.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DeletedServersOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdeleted_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
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 DeletedServer or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(location_name: str, deleted_server_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DeletedServer[source]¶ Gets a deleted server.
- Parameters
- Keyword Arguments
- Returns
DeletedServer, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DeletedServerListResult][source]¶ Gets a list of all deleted servers in a subscription.
- Keyword Arguments
- Returns
An iterator like instance of either DeletedServerListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_location
(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DeletedServerListResult][source]¶ Gets a list of deleted servers for a location.
- Parameters
location_name (str) – The name of the region where the resource is located.
- Keyword Arguments
- Returns
An iterator like instance of either DeletedServerListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
DistributedAvailabilityGroupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sdistributed_availability_groups
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, parameters: azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup][source]¶ Creates a distributed availability group between Sql On-Prem and Sql Managed Instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
distributed_availability_group_name (str) – The distributed availability group name.
parameters (DistributedAvailabilityGroup) – The distributed availability group info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 DistributedAvailabilityGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Drops a distributed availability group between Sql On-Prem and Sql Managed Instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
distributed_availability_group_name (str) – The distributed availability group name.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, parameters: azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup][source]¶ Updates a distributed availability group replication mode.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
distributed_availability_group_name (str) – The distributed availability group name.
parameters (DistributedAvailabilityGroup) – The distributed availability group info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 DistributedAvailabilityGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, distributed_availability_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroup[source]¶ Gets a distributed availability group info.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
distributed_availability_group_name (str) – The distributed availability group name.
- Keyword Arguments
- Returns
DistributedAvailabilityGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DistributedAvailabilityGroupsListResult][source]¶ Gets a list of a distributed availability groups in instance.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either DistributedAvailabilityGroupsListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ElasticPoolActivitiesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’selastic_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.ElasticPoolActivityListResult][source]¶ Returns elastic pool activities.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool for which to get the current activity.
- Keyword Arguments
- Returns
An iterator like instance of either ElasticPoolActivityListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ElasticPoolDatabaseActivitiesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’selastic_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.ElasticPoolDatabaseActivityListResult][source]¶ Returns activity on databases inside of an elastic pool.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ElasticPoolDatabaseActivityListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ElasticPoolOperationsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’selastic_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
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_elastic_pool
(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ElasticPoolOperationListResult][source]¶ Gets a list of operations performed on the elastic pool.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ElasticPoolOperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ElasticPoolsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’selastic_pools
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: azure.mgmt.sql.models._models_py3.ElasticPool, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ElasticPool][source]¶ Creates or updates an elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
parameters (ElasticPool) – The elastic pool parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-08-01-preview”. 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 ElasticPool or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes an elastic pool.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-08-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_failover
(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Failovers an elastic pool.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-08-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, server_name: str, elastic_pool_name: str, parameters: azure.mgmt.sql.models._models_py3.ElasticPoolUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ElasticPool][source]¶ Updates an elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
parameters (ElasticPoolUpdate) – The elastic pool update parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-08-01-preview”. 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 ElasticPool or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ElasticPool[source]¶ Gets an elastic pool.
- Parameters
- Keyword Arguments
- Returns
ElasticPool, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ElasticPoolListResult][source]¶ Gets all elastic pools in a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ElasticPoolListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_metric_definitions
(resource_group_name: str, server_name: str, elastic_pool_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.MetricDefinitionListResult][source]¶ Returns elastic pool metric definitions.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either MetricDefinitionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_metrics
(resource_group_name: str, server_name: str, elastic_pool_name: str, filter: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.MetricListResult][source]¶ Returns elastic pool metrics.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
filter (str) – An OData filter expression that describes a subset of metrics to return.
- Keyword Arguments
- Returns
An iterator like instance of either MetricListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
EncryptionProtectorsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sencryption_protectors
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], parameters: azure.mgmt.sql.models._models_py3.EncryptionProtector, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.EncryptionProtector][source]¶ Updates an existing encryption protector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated.
parameters (EncryptionProtector) – The requested encryption protector resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 EncryptionProtector or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_revalidate
(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Revalidates an existing encryption protector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.EncryptionProtector[source]¶ Gets a server encryption protector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be retrieved.
- Keyword Arguments
- Returns
EncryptionProtector, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.EncryptionProtectorListResult][source]¶ Gets a list of server encryption protectors.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either EncryptionProtectorListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
EndpointCertificatesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sendpoint_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.
managed_instance_name (str) – The name of the managed instance.
endpoint_type (str) – Type of the endpoint whose certificate the customer is looking for.
- Keyword Arguments
- Returns
EndpointCertificate, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.EndpointCertificateListResult][source]¶ List certificates used on endpoints on the target instance.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either EndpointCertificateListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ExtendedDatabaseBlobAuditingPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sextended_database_blob_auditing_policies
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ExtendedDatabaseBlobAuditingPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ExtendedDatabaseBlobAuditingPolicy[source]¶ Creates or updates an extended database’s blob auditing policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (ExtendedDatabaseBlobAuditingPolicy) – The extended database blob auditing policy.
- Keyword Arguments
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.
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ExtendedDatabaseBlobAuditingPolicy[source]¶ Gets an extended database’s blob auditing policy.
- Parameters
- 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.
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ExtendedDatabaseBlobAuditingPolicyListResult][source]¶ Lists extended auditing settings of a database.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ExtendedDatabaseBlobAuditingPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ExtendedServerBlobAuditingPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sextended_server_blob_auditing_policies
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ExtendedServerBlobAuditingPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ExtendedServerBlobAuditingPolicy][source]¶ Creates or updates an extended server’s blob auditing policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ExtendedServerBlobAuditingPolicy) – Properties of extended blob auditing policy.
- Keyword Arguments
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.
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 ExtendedServerBlobAuditingPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ExtendedServerBlobAuditingPolicy[source]¶ Gets an extended server’s blob auditing policy.
- Parameters
- 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.
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ExtendedServerBlobAuditingPolicyListResult][source]¶ Lists extended auditing settings of a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ExtendedServerBlobAuditingPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
FailoverGroupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sfailover_groups
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, failover_group_name: str, parameters: azure.mgmt.sql.models._models_py3.FailoverGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.FailoverGroup][source]¶ Creates or updates a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
parameters (FailoverGroup) – The failover group parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 FailoverGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a failover group.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_failover
(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.FailoverGroup][source]¶ Fails over from the current primary server to this server.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 FailoverGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_force_failover_allow_data_loss
(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.FailoverGroup][source]¶ Fails over from the current primary server to this server. This operation might result in data loss.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 FailoverGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, server_name: str, failover_group_name: str, parameters: azure.mgmt.sql.models._models_py3.FailoverGroupUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.FailoverGroup][source]¶ Updates a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
parameters (FailoverGroupUpdate) – The failover group parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 FailoverGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, failover_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.FailoverGroup[source]¶ Gets a failover group.
- Parameters
- Keyword Arguments
- Returns
FailoverGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.FailoverGroupListResult][source]¶ Lists the failover groups in a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either FailoverGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
FirewallRulesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sfirewall_rules
attribute.-
create_or_update
(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: azure.mgmt.sql.models._models_py3.FirewallRule, **kwargs: Any) → azure.mgmt.sql.models._models_py3.FirewallRule[source]¶ Creates or updates a firewall rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
firewall_rule_name (str) – The name of the firewall rule.
parameters (FirewallRule) – The required parameters for creating or updating a firewall rule.
- Keyword Arguments
- Returns
FirewallRule, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) → None[source]¶ Deletes a firewall rule.
- Parameters
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.FirewallRule[source]¶ Gets a firewall rule.
- Parameters
- Keyword Arguments
- Returns
FirewallRule, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.FirewallRuleListResult][source]¶ Gets a list of firewall rules.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either FirewallRuleListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
replace
(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.FirewallRuleList, **kwargs: Any) → Optional[azure.mgmt.sql.models._models_py3.FirewallRule][source]¶ Replaces all firewall rules on the server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (FirewallRuleList) –
- Keyword Arguments
- Returns
FirewallRule, or the result of cls(response)
- Return type
FirewallRule or None
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
GeoBackupPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sgeo_backup_policies
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, geo_backup_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.GeoBackupPolicyName], parameters: azure.mgmt.sql.models._models_py3.GeoBackupPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.GeoBackupPolicy[source]¶ Updates a database geo backup policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
geo_backup_policy_name (str or GeoBackupPolicyName) – The name of the geo backup policy.
parameters (GeoBackupPolicy) – The required parameters for creating or updating the geo backup policy.
- Keyword Arguments
- Returns
GeoBackupPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, geo_backup_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.GeoBackupPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.GeoBackupPolicy[source]¶ Gets a geo backup policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
geo_backup_policy_name (str or GeoBackupPolicyName) – The name of the geo backup policy.
- Keyword Arguments
- Returns
GeoBackupPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.GeoBackupPolicyListResult][source]¶ Returns a list of geo backup policies.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either GeoBackupPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
IPv6FirewallRulesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sipv6_firewall_rules
attribute.-
create_or_update
(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: azure.mgmt.sql.models._models_py3.IPv6FirewallRule, **kwargs: Any) → azure.mgmt.sql.models._models_py3.IPv6FirewallRule[source]¶ Creates or updates an IPv6 firewall rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
firewall_rule_name (str) – The name of the firewall rule.
parameters (IPv6FirewallRule) – The required parameters for creating or updating an IPv6 firewall rule.
- Keyword Arguments
- Returns
IPv6FirewallRule, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) → None[source]¶ Deletes an IPv6 firewall rule.
- Parameters
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.IPv6FirewallRule[source]¶ Gets an IPv6 firewall rule.
- Parameters
- Keyword Arguments
- Returns
IPv6FirewallRule, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.IPv6FirewallRuleListResult][source]¶ Gets a list of IPv6 firewall rules.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either IPv6FirewallRuleListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
InstanceFailoverGroupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sinstance_failover_groups
attribute.-
begin_create_or_update
(resource_group_name: str, location_name: str, failover_group_name: str, parameters: azure.mgmt.sql.models._models_py3.InstanceFailoverGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstanceFailoverGroup][source]¶ Creates or updates a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
parameters (InstanceFailoverGroup) – The failover group parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 InstanceFailoverGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a failover group.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_failover
(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstanceFailoverGroup][source]¶ Fails over from the current primary managed instance to this managed instance.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 InstanceFailoverGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_force_failover_allow_data_loss
(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstanceFailoverGroup][source]¶ Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 InstanceFailoverGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, location_name: str, failover_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.InstanceFailoverGroup[source]¶ Gets a failover group.
- Parameters
- Keyword Arguments
- Returns
InstanceFailoverGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_location
(resource_group_name: str, location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.InstanceFailoverGroupListResult][source]¶ Lists the failover groups in a location.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either InstanceFailoverGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
InstancePoolsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sinstance_pools
attribute.-
begin_create_or_update
(resource_group_name: str, instance_pool_name: str, parameters: azure.mgmt.sql.models._models_py3.InstancePool, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstancePool][source]¶ Creates or updates an instance pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The name of the instance pool to be created or updated.
parameters (InstancePool) – The requested instance pool resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 InstancePool or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, instance_pool_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes an instance pool.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, instance_pool_name: str, parameters: azure.mgmt.sql.models._models_py3.InstancePoolUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.InstancePool][source]¶ Updates an instance pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The name of the instance pool to be updated.
parameters (InstancePoolUpdate) – The requested instance pool resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 InstancePool or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, instance_pool_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.InstancePool[source]¶ Gets an instance pool.
- Parameters
- Keyword Arguments
- Returns
InstancePool, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.InstancePoolListResult][source]¶ Gets a list of all instance pools in the subscription.
- Keyword Arguments
- Returns
An iterator like instance of either InstancePoolListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.InstancePoolListResult][source]¶ Gets a list of instance pools in the resource group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Keyword Arguments
- Returns
An iterator like instance of either InstancePoolListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobAgentsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjob_agents
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, job_agent_name: str, parameters: azure.mgmt.sql.models._models_py3.JobAgent, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.JobAgent][source]¶ Creates or updates a job agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be created or updated.
parameters (JobAgent) – The requested job agent resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 JobAgent or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a job agent.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, server_name: str, job_agent_name: str, parameters: azure.mgmt.sql.models._models_py3.JobAgentUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.JobAgent][source]¶ Updates a job agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be updated.
parameters (JobAgentUpdate) – The update to the job agent.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 JobAgent or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobAgent[source]¶ Gets a job agent.
- Parameters
- Keyword Arguments
- Returns
JobAgent, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobAgentListResult][source]¶ Gets a list of job agents in a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either JobAgentListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobCredentialsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjob_credentials
attribute.-
create_or_update
(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, parameters: azure.mgmt.sql.models._models_py3.JobCredential, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobCredential[source]¶ Creates or updates a job credential.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
parameters (JobCredential) – The requested job credential state.
- Keyword Arguments
- Returns
JobCredential, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, **kwargs: Any) → None[source]¶ Deletes a job credential.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, job_agent_name: str, credential_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobCredential[source]¶ Gets a jobs credential.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
- Keyword Arguments
- Returns
JobCredential, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_agent
(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobCredentialListResult][source]¶ Gets a list of jobs credentials.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either JobCredentialListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobExecutionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjob_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.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 JobExecution or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_create_or_update
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.JobExecution][source]¶ Creates or updates a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The job execution id to create the job execution under.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 JobExecution or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
cancel
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, **kwargs: Any) → None[source]¶ Requests cancellation of a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_execution_id (str) – The id of the job execution to cancel.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobExecution[source]¶ Gets a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_execution_id (str) – The id of the job execution.
- Keyword Arguments
- Returns
JobExecution, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_agent
(resource_group_name: str, server_name: str, job_agent_name: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][source]¶ Lists all executions in a job agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. 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
- Returns
An iterator like instance of either JobExecutionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_job
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][source]¶ Lists a job’s executions.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. 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
- Returns
An iterator like instance of either JobExecutionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobStepExecutionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjob_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.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The unique id of the job execution.
step_name (str) – The name of the step.
- Keyword Arguments
- Returns
JobExecution, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_job_execution
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][source]¶ Lists the step executions of a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. 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
- Returns
An iterator like instance of either JobExecutionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobStepsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjob_steps
attribute.-
create_or_update
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, parameters: azure.mgmt.sql.models._models_py3.JobStep, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobStep[source]¶ Creates or updates a job step. This will implicitly create a new job version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step.
parameters (JobStep) – The requested state of the job step.
- Keyword Arguments
- Returns
JobStep, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, **kwargs: Any) → None[source]¶ Deletes a job step. This will implicitly create a new job version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step to delete.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, step_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobStep[source]¶ Gets a job step in a job’s current version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step.
- Keyword Arguments
- Returns
JobStep, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get_by_version
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_version: int, step_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobStep[source]¶ Gets the specified version of a job step.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_version (int) – The version of the job to get.
step_name (str) – The name of the job step.
- Keyword Arguments
- Returns
JobStep, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_job
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobStepListResult][source]¶ Gets all job steps for a job’s current version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
- Keyword Arguments
- Returns
An iterator like instance of either JobStepListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_version
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_version: int, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobStepListResult][source]¶ Gets all job steps in the specified job version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_version (int) – The version of the job to get.
- Keyword Arguments
- Returns
An iterator like instance of either JobStepListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobTargetExecutionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjob_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.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The unique id of the job execution.
step_name (str) – The name of the step.
target_id (str) – The target id.
- Keyword Arguments
- Returns
JobExecution, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_job_execution
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][source]¶ Lists target executions for all steps of a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. 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
- Returns
An iterator like instance of either JobExecutionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_step
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, job_execution_id: str, step_name: str, create_time_min: Optional[datetime.datetime] = None, create_time_max: Optional[datetime.datetime] = None, end_time_min: Optional[datetime.datetime] = None, end_time_max: Optional[datetime.datetime] = None, is_active: Optional[bool] = None, skip: Optional[int] = None, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobExecutionListResult][source]¶ Lists the target executions of a job step execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution.
step_name (str) – The name of the step.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included. 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
- Returns
An iterator like instance of either JobExecutionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobTargetGroupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjob_target_groups
attribute.-
create_or_update
(resource_group_name: str, server_name: str, job_agent_name: str, target_group_name: str, parameters: azure.mgmt.sql.models._models_py3.JobTargetGroup, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobTargetGroup[source]¶ Creates or updates a target group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
parameters (JobTargetGroup) – The requested state of the target group.
- Keyword Arguments
- Returns
JobTargetGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, job_agent_name: str, target_group_name: str, **kwargs: Any) → None[source]¶ Deletes a target group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, job_agent_name: str, target_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.JobTargetGroup[source]¶ Gets a target group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
- Keyword Arguments
- Returns
JobTargetGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_agent
(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobTargetGroupListResult][source]¶ Gets all target groups in an agent.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either JobTargetGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobVersionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjob_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.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_version (int) – The version of the job to get.
- Keyword Arguments
- Returns
JobVersion, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_job
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobVersionListResult][source]¶ Gets all versions of a job.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
- Keyword Arguments
- Returns
An iterator like instance of either JobVersionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
JobsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sjobs
attribute.-
create_or_update
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, parameters: azure.mgmt.sql.models._models_py3.Job, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Job[source]¶ Creates or updates a job.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
parameters (Job) – The requested job state.
- Keyword Arguments
- Returns
Job, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → None[source]¶ Deletes a job.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to delete.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, job_agent_name: str, job_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Job[source]¶ Gets a job.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
- Keyword Arguments
- Returns
Job, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_agent
(resource_group_name: str, server_name: str, job_agent_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.JobListResult][source]¶ Gets a list of jobs.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either JobListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
LedgerDigestUploadsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sledger_digest_uploads
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, ledger_digest_uploads: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LedgerDigestUploadsName], parameters: azure.mgmt.sql.models._models_py3.LedgerDigestUploads, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LedgerDigestUploads][source]¶ Enables upload ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
ledger_digest_uploads (str or LedgerDigestUploadsName) –
parameters (LedgerDigestUploads) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 LedgerDigestUploads or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_disable
(resource_group_name: str, server_name: str, database_name: str, ledger_digest_uploads: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LedgerDigestUploadsName], **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LedgerDigestUploads][source]¶ Disables uploading ledger digests to an Azure Storage account or an Azure Confidential Ledger instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
ledger_digest_uploads (str or LedgerDigestUploadsName) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 LedgerDigestUploads or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, ledger_digest_uploads: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LedgerDigestUploadsName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.LedgerDigestUploads[source]¶ Gets the current ledger digest upload configuration for a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
ledger_digest_uploads (str or LedgerDigestUploadsName) –
- Keyword Arguments
- Returns
LedgerDigestUploads, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LedgerDigestUploadsListResult][source]¶ Gets all ledger digest upload settings on a database.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either LedgerDigestUploadsListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
LongTermRetentionBackupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’slong_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: azure.mgmt.sql.models._models_py3.CopyLongTermRetentionBackupParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupOperationResult][source]¶ Copy an existing long term retention backup.
- Parameters
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
long_term_retention_database_name (str) – The name of the database.
backup_name (str) – The backup name.
parameters (CopyLongTermRetentionBackupParameters) – The parameters needed for long term retention copy request.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 LongTermRetentionBackupOperationResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_copy_by_resource_group
(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: azure.mgmt.sql.models._models_py3.CopyLongTermRetentionBackupParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupOperationResult][source]¶ Copy an existing long term retention backup to a different server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
long_term_retention_database_name (str) – The name of the database.
backup_name (str) – The backup name.
parameters (CopyLongTermRetentionBackupParameters) – The parameters needed for long term retention copy request.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 LongTermRetentionBackupOperationResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a long term retention backup.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete_by_resource_group
(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a long term retention backup.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
long_term_retention_database_name (str) – The name of the database.
backup_name (str) – The backup name.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: azure.mgmt.sql.models._models_py3.UpdateLongTermRetentionBackupParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupOperationResult][source]¶ Updates an existing long term retention backup.
- Parameters
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
long_term_retention_database_name (str) – The name of the database.
backup_name (str) – The backup name.
parameters (UpdateLongTermRetentionBackupParameters) – The requested backup resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 LongTermRetentionBackupOperationResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update_by_resource_group
(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, parameters: azure.mgmt.sql.models._models_py3.UpdateLongTermRetentionBackupParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupOperationResult][source]¶ Updates an existing long term retention backup.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
long_term_retention_database_name (str) – The name of the database.
backup_name (str) – The backup name.
parameters (UpdateLongTermRetentionBackupParameters) – The requested backup resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 LongTermRetentionBackupOperationResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.LongTermRetentionBackup[source]¶ Gets a long term retention backup.
- Parameters
- Keyword Arguments
- Returns
LongTermRetentionBackup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get_by_resource_group
(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, backup_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.LongTermRetentionBackup[source]¶ Gets a long term retention backup.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
long_term_retention_database_name (str) – The name of the database.
backup_name (str) – The backup name.
- Keyword Arguments
- Returns
LongTermRetentionBackup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][source]¶ Lists all long term retention backups for a database.
- Parameters
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
long_term_retention_database_name (str) – The name of the database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_location
(location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][source]¶ Lists the long term retention backups for a given location.
- Parameters
location_name (str) – The location of the database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group_database
(resource_group_name: str, location_name: str, long_term_retention_server_name: str, long_term_retention_database_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][source]¶ Lists all long term retention backups for a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
long_term_retention_database_name (str) – The name of the database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group_location
(resource_group_name: str, location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][source]¶ Lists the long term retention backups for a given location.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group_server
(resource_group_name: str, location_name: str, long_term_retention_server_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][source]¶ Lists the long term retention backups for a given server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(location_name: str, long_term_retention_server_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionBackupListResult][source]¶ Lists the long term retention backups for a given server.
- Parameters
location_name (str) – The location of the database.
long_term_retention_server_name (str) – The name of the server.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either LongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
LongTermRetentionManagedInstanceBackupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’slong_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
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete_by_resource_group
(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a long term retention backup.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
backup_name (str) – The backup name.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackup[source]¶ Gets a long term retention backup for a managed database.
- Parameters
- Keyword Arguments
- Returns
ManagedInstanceLongTermRetentionBackup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get_by_resource_group
(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, backup_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackup[source]¶ Gets a long term retention backup for a managed database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
backup_name (str) – The backup name.
- Keyword Arguments
- Returns
ManagedInstanceLongTermRetentionBackup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(location_name: str, managed_instance_name: str, database_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][source]¶ Lists all long term retention backups for a managed database.
- Parameters
location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(location_name: str, managed_instance_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][source]¶ Lists the long term retention backups for a given managed instance.
- Parameters
location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_location
(location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][source]¶ Lists the long term retention backups for managed databases in a given location.
- Parameters
location_name (str) – The location of the database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group_database
(resource_group_name: str, location_name: str, managed_instance_name: str, database_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][source]¶ Lists all long term retention backups for a managed database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group_instance
(resource_group_name: str, location_name: str, managed_instance_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][source]¶ Lists the long term retention backups for a given managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
managed_instance_name (str) – The name of the managed instance.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group_location
(resource_group_name: str, location_name: str, only_latest_per_database: Optional[bool] = None, database_state: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.DatabaseState]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionBackupListResult][source]¶ Lists the long term retention backups for managed databases in a given location.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The location of the database.
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database. Default value is None.
database_state (str or DatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceLongTermRetentionBackupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
LongTermRetentionPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’slong_term_retention_policies
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LongTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.LongTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.LongTermRetentionPolicy][source]¶ Sets a database’s long term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
policy_name (str or LongTermRetentionPolicyName) – The policy name. Should always be Default.
parameters (LongTermRetentionPolicy) – The long term retention policy info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 LongTermRetentionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.LongTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.LongTermRetentionPolicy[source]¶ Gets a database’s long term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
policy_name (str or LongTermRetentionPolicyName) – The policy name. Should always be Default.
- Keyword Arguments
- Returns
LongTermRetentionPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LongTermRetentionPolicyListResult][source]¶ Gets a database’s long term retention policy.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either LongTermRetentionPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
MaintenanceWindowOptionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smaintenance_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.
server_name (str) – The name of the server.
database_name (str) – The name of the database to get maintenance windows options for.
maintenance_window_options_name (str) – Maintenance window options name.
- Keyword Arguments
- Returns
MaintenanceWindowOptions, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
MaintenanceWindowsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smaintenance_windows
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, maintenance_window_name: str, parameters: azure.mgmt.sql.models._models_py3.MaintenanceWindows, **kwargs: Any) → None[source]¶ Sets maintenance windows settings for a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to set maintenance windows for.
maintenance_window_name (str) – Maintenance window name.
parameters (MaintenanceWindows) –
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, maintenance_window_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.MaintenanceWindows[source]¶ Gets maintenance windows settings for a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to get maintenance windows for.
maintenance_window_name (str) – Maintenance window name.
- Keyword Arguments
- Returns
MaintenanceWindows, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedBackupShortTermRetentionPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy][source]¶ Updates a managed database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (ManagedBackupShortTermRetentionPolicy) – The short term retention policy info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedBackupShortTermRetentionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy][source]¶ Updates a managed database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (ManagedBackupShortTermRetentionPolicy) – The short term retention policy info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedBackupShortTermRetentionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy[source]¶ Gets a managed database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name.
- Keyword Arguments
- Returns
ManagedBackupShortTermRetentionPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicyListResult][source]¶ Gets a managed database’s short term retention policy list.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedBackupShortTermRetentionPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseColumnsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
- Keyword Arguments
- Returns
DatabaseColumn, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, schema: Optional[List[str]] = None, table: Optional[List[str]] = None, column: Optional[List[str]] = None, order_by: Optional[List[str]] = None, skiptoken: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseColumnListResult][source]¶ List managed database columns.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
skiptoken (str) – An opaque token that identifies a starting point in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseColumnListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_table
(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseColumnListResult][source]¶ List managed database columns.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
filter (str) – An OData filter expression that filters elements in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseColumnListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseQueriesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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
- Keyword Arguments
- Returns
ManagedInstanceQuery, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_query
(resource_group_name: str, managed_instance_name: str, database_name: str, query_id: str, start_time: Optional[str] = None, end_time: Optional[str] = None, interval: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.QueryTimeGrainType]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceQueryStatistics][source]¶ Get query execution statistics by query id.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
query_id (str) –
start_time (str) – Start time for observed period. 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 None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceQueryStatistics or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseRecommendedSensitivityLabelsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_database_recommended_sensitivity_labels
attribute.-
update
(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.RecommendedSensitivityLabelUpdateList, **kwargs: Any) → None[source]¶ Update recommended sensitivity labels states of a given database using an operations batch.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
parameters (RecommendedSensitivityLabelUpdateList) –
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseRestoreDetailsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
restore_details_name (str or RestoreDetailsName) – The name of the restore details to retrieve.
- Keyword Arguments
- Returns
ManagedDatabaseRestoreDetailsResult, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseSchemasOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
- Keyword Arguments
- Returns
DatabaseSchema, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseSchemaListResult][source]¶ List managed database schemas.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
filter (str) – An OData filter expression that filters elements in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseSchemaListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseSecurityAlertPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedDatabaseSecurityAlertPolicy, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabaseSecurityAlertPolicy[source]¶ Creates or updates a database’s security alert policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the security alert policy is defined.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
parameters (ManagedDatabaseSecurityAlertPolicy) – The database security alert policy.
- Keyword Arguments
- Returns
ManagedDatabaseSecurityAlertPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabaseSecurityAlertPolicy[source]¶ Gets a managed database’s security alert policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the security alert policy is defined.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
- Keyword Arguments
- Returns
ManagedDatabaseSecurityAlertPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedDatabaseSecurityAlertPolicyListResult][source]¶ Gets a list of managed database’s security alert policies.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the security alert policies are defined.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedDatabaseSecurityAlertPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseSecurityEventsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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.SecurityEventCollection][source]¶ Gets a list of security events.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the security events are retrieved.
filter (str) – An OData filter expression that filters elements in the collection. 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
- Returns
An iterator like instance of either SecurityEventCollection or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseSensitivityLabelsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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: azure.mgmt.sql.models._models_py3.SensitivityLabel, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SensitivityLabel[source]¶ Creates or updates the sensitivity label of a given column.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
parameters (SensitivityLabel) – The column sensitivity label resource.
- Keyword Arguments
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.
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
SensitivityLabel, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None[source]¶ Deletes the sensitivity label of a given column.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
- Keyword Arguments
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.
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
disable_recommendation
(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None[source]¶ Disables sensitivity recommendations on a given column.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
- Keyword Arguments
sensitivity_label_source (str) – Default value is “recommended”. Note that overriding this default value may result in unsupported behavior.
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
enable_recommendation
(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None[source]¶ Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns).
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
- Keyword Arguments
sensitivity_label_source (str) – Default value is “recommended”. Note that overriding this default value may result in unsupported behavior.
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, sensitivity_label_source: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SensitivityLabelSource], **kwargs: Any) → azure.mgmt.sql.models._models_py3.SensitivityLabel[source]¶ Gets the sensitivity label of a given column.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
sensitivity_label_source (str or SensitivityLabelSource) – The source of the sensitivity label.
- Keyword Arguments
- Returns
SensitivityLabel, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_current_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, skip_token: Optional[str] = None, count: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SensitivityLabelListResult][source]¶ Gets the sensitivity labels of a given database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
skip_token (str) – 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
- Returns
An iterator like instance of either SensitivityLabelListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_recommended_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, skip_token: Optional[str] = None, include_disabled_recommendations: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SensitivityLabelListResult][source]¶ Gets the sensitivity labels of a given database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
skip_token (str) – 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
- Returns
An iterator like instance of either SensitivityLabelListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.SensitivityLabelUpdateList, **kwargs: Any) → None[source]¶ Update sensitivity labels of a given database using an operations batch.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
parameters (SensitivityLabelUpdateList) –
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseTablesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
- Keyword Arguments
- Returns
DatabaseTable, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_schema
(resource_group_name: str, managed_instance_name: str, database_name: str, schema_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseTableListResult][source]¶ List managed database tables.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
filter (str) – An OData filter expression that filters elements in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseTableListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseTransparentDataEncryptionOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_database_transparent_data_encryption
attribute.-
create_or_update
(resource_group_name: str, managed_instance_name: str, database_name: str, tde_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionName], parameters: azure.mgmt.sql.models._models_py3.ManagedTransparentDataEncryption, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedTransparentDataEncryption[source]¶ Updates a database’s transparent data encryption configuration.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the security alert policy is defined.
tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration.
parameters (ManagedTransparentDataEncryption) – The database transparent data encryption.
- Keyword Arguments
- Returns
ManagedTransparentDataEncryption, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, tde_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedTransparentDataEncryption[source]¶ Gets a managed database’s transparent data encryption.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the transparent data encryption is defined.
tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration.
- Keyword Arguments
- Returns
ManagedTransparentDataEncryption, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedTransparentDataEncryptionListResult][source]¶ Gets a list of managed database’s transparent data encryptions.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the managed database for which the transparent data encryption is defined.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedTransparentDataEncryptionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseVulnerabilityAssessmentRuleBaselinesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], parameters: azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline[source]¶ Creates or updates a database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).
parameters (DatabaseVulnerabilityAssessmentRuleBaseline) – The requested rule baseline resource.
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessmentRuleBaseline, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], **kwargs: Any) → None[source]¶ Removes the database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], rule_id: str, baseline_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentPolicyBaselineName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentRuleBaseline[source]¶ Gets a database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
rule_id (str) – The vulnerability assessment rule ID.
baseline_name (str or VulnerabilityAssessmentPolicyBaselineName) – The name of the vulnerability assessment rule baseline (default implies a baseline on a database level rule and master for server level rule).
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessmentRuleBaseline, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseVulnerabilityAssessmentScansOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
export
(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentScansExport[source]¶ Convert an existing scan result to a human readable format. If already exists nothing happens.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the scanned database.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id.
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessmentScansExport, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], scan_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentScanRecord[source]¶ Gets a vulnerability assessment scan record of a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
- Keyword Arguments
- Returns
VulnerabilityAssessmentScanRecord, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VulnerabilityAssessmentScanRecordListResult][source]¶ Lists the vulnerability assessment scans of a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
An iterator like instance of either VulnerabilityAssessmentScanRecordListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabaseVulnerabilityAssessmentsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_database_vulnerability_assessments
attribute.-
create_or_update
(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], parameters: azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment, **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment[source]¶ Creates or updates the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
parameters (DatabaseVulnerabilityAssessment) – The requested resource.
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → None[source]¶ Removes the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessment[source]¶ Gets the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
DatabaseVulnerabilityAssessment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.DatabaseVulnerabilityAssessmentListResult][source]¶ Lists the vulnerability assessments of a managed database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
- Keyword Arguments
- Returns
An iterator like instance of either DatabaseVulnerabilityAssessmentListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedDatabasesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_databases
attribute.-
begin_complete_restore
(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.CompleteDatabaseRestoreDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Completes the restore operation on a managed database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
parameters (CompleteDatabaseRestoreDefinition) – The definition for completing the restore of this managed database.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedDatabase, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedDatabase][source]¶ Creates a new database or updates an existing database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
parameters (ManagedDatabase) – The requested database resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedDatabase or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a managed database.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedDatabaseUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedDatabase][source]¶ Updates an existing database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
parameters (ManagedDatabaseUpdate) – The requested database resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedDatabase or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedDatabase[source]¶ Gets a managed database.
- Parameters
- Keyword Arguments
- Returns
ManagedDatabase, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedDatabaseListResult][source]¶ Gets a list of managed databases.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedDatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_inaccessible_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedDatabaseListResult][source]¶ Gets a list of inaccessible managed databases in a managed instance.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedDatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstanceAdministratorsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_instance_administrators
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceAdministrator, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceAdministrator][source]¶ Creates or updates a managed instance administrator.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
administrator_name (str or AdministratorName) –
parameters (ManagedInstanceAdministrator) – The requested administrator parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedInstanceAdministrator or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, managed_instance_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a managed instance administrator.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
administrator_name (str or AdministratorName) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceAdministrator[source]¶ Gets a managed instance administrator.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
administrator_name (str or AdministratorName) –
- Keyword Arguments
- Returns
ManagedInstanceAdministrator, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceAdministratorListResult][source]¶ Gets a list of managed instance administrators.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceAdministratorListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstanceAzureADOnlyAuthenticationsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_instance_azure_ad_only_authentications
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceAzureADOnlyAuthentication, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceAzureADOnlyAuthentication][source]¶ Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.
parameters (ManagedInstanceAzureADOnlyAuthentication) – The required parameters for creating or updating an Active Directory only authentication property.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedInstanceAzureADOnlyAuthentication or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, managed_instance_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes an existing server Active Directory only authentication property.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceAzureADOnlyAuthentication[source]¶ Gets a specific Azure Active Directory only authentication property.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.
- Keyword Arguments
- Returns
ManagedInstanceAzureADOnlyAuthentication, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceAzureADOnlyAuthListResult][source]¶ Gets a list of server Azure Active Directory only authentications.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceAzureADOnlyAuthListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstanceEncryptionProtectorsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_instance_encryption_protectors
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceEncryptionProtector, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceEncryptionProtector][source]¶ Updates an existing encryption protector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated.
parameters (ManagedInstanceEncryptionProtector) – The requested encryption protector resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedInstanceEncryptionProtector or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_revalidate
(resource_group_name: str, managed_instance_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Revalidates an existing encryption protector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be updated.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, encryption_protector_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.EncryptionProtectorName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceEncryptionProtector[source]¶ Gets a managed instance encryption protector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
encryption_protector_name (str or EncryptionProtectorName) – The name of the encryption protector to be retrieved.
- Keyword Arguments
- Returns
ManagedInstanceEncryptionProtector, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceEncryptionProtectorListResult][source]¶ Gets a list of managed instance encryption protectors.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceEncryptionProtectorListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstanceKeysOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_instance_keys
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, key_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceKey, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceKey][source]¶ Creates or updates a managed instance key.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
key_name (str) – The name of the managed instance key to be operated on (updated or created).
parameters (ManagedInstanceKey) – The requested managed instance key resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedInstanceKey or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, managed_instance_name: str, key_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes the managed instance key with the given name.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, key_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceKey[source]¶ Gets a managed instance key.
- Parameters
- Keyword Arguments
- Returns
ManagedInstanceKey, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceKeyListResult][source]¶ Gets a list of managed instance keys.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
filter (str) – An OData filter expression that filters elements in the collection. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceKeyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstanceLongTermRetentionPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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, azure.mgmt.sql.models._sql_management_client_enums.ManagedInstanceLongTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionPolicy][source]¶ Sets a managed database’s long term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
policy_name (str or ManagedInstanceLongTermRetentionPolicyName) – The policy name. Should always be Default.
parameters (ManagedInstanceLongTermRetentionPolicy) – The long term retention policy info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedInstanceLongTermRetentionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, database_name: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedInstanceLongTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionPolicy[source]¶ Gets a managed database’s long term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
policy_name (str or ManagedInstanceLongTermRetentionPolicyName) – The policy name. Should always be Default.
- Keyword Arguments
- Returns
ManagedInstanceLongTermRetentionPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceLongTermRetentionPolicyListResult][source]¶ Gets a database’s long term retention policy.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceLongTermRetentionPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstanceOperationsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, operation_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceOperation[source]¶ Gets a management operation on a managed instance.
- Parameters
- Keyword Arguments
- Returns
ManagedInstanceOperation, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_managed_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceOperationListResult][source]¶ Gets a list of operations performed on the managed instance.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceOperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstancePrivateEndpointConnectionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_instance_private_endpoint_connections
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointConnection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointConnection][source]¶ Approve or reject a private endpoint connection with a given name.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
private_endpoint_connection_name (str) –
parameters (ManagedInstancePrivateEndpointConnection) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedInstancePrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, managed_instance_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a private endpoint connection with a given name.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointConnection[source]¶ Gets a private endpoint connection.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
private_endpoint_connection_name (str) – The name of the private endpoint connection.
- Keyword Arguments
- Returns
ManagedInstancePrivateEndpointConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_managed_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateEndpointConnectionListResult][source]¶ Gets all private endpoint connections on a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstancePrivateEndpointConnectionListResult or the result of cls(response)
- Return type
ItemPaged[ManagedInstancePrivateEndpointConnectionListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstancePrivateLinkResourcesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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
- Keyword Arguments
- Returns
ManagedInstancePrivateLink, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_managed_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstancePrivateLinkListResult][source]¶ Gets the private link resources for SQL server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstancePrivateLinkListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstanceTdeCertificatesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_instance_tde_certificates
attribute.-
begin_create
(resource_group_name: str, managed_instance_name: str, parameters: azure.mgmt.sql.models._models_py3.TdeCertificate, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Creates a TDE certificate for a given server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (TdeCertificate) – The requested TDE certificate to be created or updated.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstanceVulnerabilityAssessmentsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_instance_vulnerability_assessments
attribute.-
create_or_update
(resource_group_name: str, managed_instance_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceVulnerabilityAssessment, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceVulnerabilityAssessment[source]¶ Creates or updates the managed instance’s vulnerability assessment. Learn more about setting SQL vulnerability assessment with managed identity - https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
parameters (ManagedInstanceVulnerabilityAssessment) – The requested resource.
- Keyword Arguments
- Returns
ManagedInstanceVulnerabilityAssessment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, managed_instance_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → None[source]¶ Removes the managed instance’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstanceVulnerabilityAssessment[source]¶ Gets the managed instance’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
ManagedInstanceVulnerabilityAssessment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceVulnerabilityAssessmentListResult][source]¶ Gets the managed instance’s vulnerability assessment policies.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceVulnerabilityAssessmentListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedInstancesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_instances
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedInstance, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstance][source]¶ Creates or updates a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (ManagedInstance) – The requested managed instance resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 ManagedInstance or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a managed instance.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_failover
(resource_group_name: str, managed_instance_name: str, replica_type: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ReplicaType]] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Failovers a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance to failover.
replica_type (str or ReplicaType) – The type of replica to be failed over. Default value is None.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, managed_instance_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedInstanceUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedInstance][source]¶ Updates a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (ManagedInstanceUpdate) – The requested managed instance resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 ManagedInstance or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedInstance[source]¶ Gets a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
expand (str) – The child resources to include in the response. Default value is None.
- Keyword Arguments
- Returns
ManagedInstance, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceListResult][source]¶ Gets a list of all managed instances in the subscription.
- Parameters
expand (str) – The child resources to include in the response. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance_pool
(resource_group_name: str, instance_pool_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceListResult][source]¶ Gets a list of all managed instances in an instance pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The instance pool name.
expand (str) – The child resources to include in the response. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_managed_instance
(resource_group_name: str, managed_instance_name: str, number_of_queries: Optional[int] = None, databases: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, interval: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.QueryTimeGrainType]] = None, aggregation_function: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.AggregationFunctionType]] = None, observation_metric: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.MetricType]] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.TopQueriesListResult][source]¶ Get top resource consuming queries of a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
number_of_queries (int) – How many ‘top queries’ to return. Default is 5.
databases (str) – Comma separated list of databases to be included into search. All DB’s are included if this parameter is not specified. 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.
aggregation_function (str or AggregationFunctionType) – Aggregation function to be used, default value is ‘sum’.
observation_metric (str or MetricType) – Metric to be used for ranking top queries. Default is ‘cpu’.
- Keyword Arguments
- Returns
An iterator like instance of either TopQueriesListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedInstanceListResult][source]¶ Gets a list of managed instances in a resource group.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedInstanceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedRestorableDroppedDatabaseBackupShortTermRetentionPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_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, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy][source]¶ Sets a database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (ManagedBackupShortTermRetentionPolicy) – The short term retention policy info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedBackupShortTermRetentionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy][source]¶ Sets a database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name. Should always be “default”.
parameters (ManagedBackupShortTermRetentionPolicy) – The short term retention policy info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedBackupShortTermRetentionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedShortTermRetentionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicy[source]¶ Gets a dropped database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
restorable_dropped_database_id (str) –
policy_name (str or ManagedShortTermRetentionPolicyName) – The policy name.
- Keyword Arguments
- Returns
ManagedBackupShortTermRetentionPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_restorable_dropped_database
(resource_group_name: str, managed_instance_name: str, restorable_dropped_database_id: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedBackupShortTermRetentionPolicyListResult][source]¶ Gets a dropped database’s short term retention policy list.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedBackupShortTermRetentionPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedServerDnsAliasesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_server_dns_aliases
attribute.-
begin_acquire
(resource_group_name: str, managed_instance_name: str, dns_alias_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedServerDnsAliasAcquisition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedServerDnsAlias][source]¶ 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.
managed_instance_name (str) – The name of the managed instance.
dns_alias_name (str) –
parameters (ManagedServerDnsAliasAcquisition) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 ManagedServerDnsAlias or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, dns_alias_name: str, parameters: azure.mgmt.sql.models._models_py3.ManagedServerDnsAliasCreation, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedServerDnsAlias][source]¶ 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.
managed_instance_name (str) – The name of the managed instance.
dns_alias_name (str) –
parameters (ManagedServerDnsAliasCreation) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 ManagedServerDnsAlias or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.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
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.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
- Keyword Arguments
- Returns
ManagedServerDnsAlias, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_managed_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedServerDnsAliasListResult][source]¶ Gets a list of managed server DNS aliases for a managed server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedServerDnsAliasListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ManagedServerSecurityAlertPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’smanaged_server_security_alert_policies
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.sql.models._models_py3.ManagedServerSecurityAlertPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ManagedServerSecurityAlertPolicy][source]¶ Creates or updates a threat detection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
parameters (ManagedServerSecurityAlertPolicy) – The managed server security alert policy.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ManagedServerSecurityAlertPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ManagedServerSecurityAlertPolicy[source]¶ Get a managed server’s threat detection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
- Keyword Arguments
- Returns
ManagedServerSecurityAlertPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ManagedServerSecurityAlertPolicyListResult][source]¶ Get the managed server’s threat detection policies.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ManagedServerSecurityAlertPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
Operations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’soperations
attribute.-
list
(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.OperationListResult][source]¶ Lists all of the available SQL Rest API operations.
- Keyword Arguments
- Returns
An iterator like instance of either OperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
OutboundFirewallRulesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’soutbound_firewall_rules
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, outbound_rule_fqdn: str, parameters: azure.mgmt.sql.models._models_py3.OutboundFirewallRule, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.OutboundFirewallRule][source]¶ Create a outbound firewall rule with a given name.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
outbound_rule_fqdn (str) –
parameters (OutboundFirewallRule) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 OutboundFirewallRule or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, outbound_rule_fqdn: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a outbound firewall rule with a given name.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, outbound_rule_fqdn: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.OutboundFirewallRule[source]¶ Gets an outbound firewall rule.
- Parameters
- Keyword Arguments
- Returns
OutboundFirewallRule, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.OutboundFirewallRuleListResult][source]¶ Gets all outbound firewall rules on a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either OutboundFirewallRuleListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
PrivateEndpointConnectionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sprivate_endpoint_connections
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.sql.models._models_py3.PrivateEndpointConnection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.PrivateEndpointConnection][source]¶ Approve or reject a private endpoint connection with a given name.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
private_endpoint_connection_name (str) –
parameters (PrivateEndpointConnection) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a private endpoint connection with a given name.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.PrivateEndpointConnection[source]¶ Gets a private endpoint connection.
- Parameters
- Keyword Arguments
- Returns
PrivateEndpointConnection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.PrivateEndpointConnectionListResult][source]¶ Gets all private endpoint connections on a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
PrivateLinkResourcesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sprivate_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
- Keyword Arguments
- Returns
PrivateLinkResource, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.PrivateLinkResourceListResult][source]¶ Gets the private link resources for SQL server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either PrivateLinkResourceListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
RecommendedSensitivityLabelsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’srecommended_sensitivity_labels
attribute.-
update
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.RecommendedSensitivityLabelUpdateList, **kwargs: Any) → None[source]¶ Update recommended sensitivity labels states of a given database using an operations batch.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (RecommendedSensitivityLabelUpdateList) –
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
RecoverableDatabasesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’srecoverable_databases
attribute.-
get
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RecoverableDatabase[source]¶ Gets a recoverable database, which is a resource representing a database’s geo backup.
- Parameters
- Keyword Arguments
- Returns
RecoverableDatabase, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RecoverableDatabaseListResult][source]¶ Gets a list of recoverable databases.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either RecoverableDatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
RecoverableManagedDatabasesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’srecoverable_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
- Keyword Arguments
- Returns
RecoverableManagedDatabase, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RecoverableManagedDatabaseListResult][source]¶ Gets a list of recoverable managed databases.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either RecoverableManagedDatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ReplicationLinksOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sreplication_links
attribute.-
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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
link_id (str) – The name of the replication link.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 ReplicationLink or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_failover_allow_data_loss
(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
link_id (str) – The name of the replication link.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 ReplicationLink or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) → None[source]¶ Deletes the replication link.
- Parameters
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, link_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ReplicationLink[source]¶ Gets a replication link.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
link_id (str) – The name of the replication link.
- Keyword Arguments
- Returns
ReplicationLink, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ReplicationLinkListResult][source]¶ Gets a list of replication links on database.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ReplicationLinkListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ReplicationLinkListResult][source]¶ Gets a list of replication links.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ReplicationLinkListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
RestorableDroppedDatabasesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’srestorable_dropped_databases
attribute.-
get
(resource_group_name: str, server_name: str, restorable_dropped_database_id: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RestorableDroppedDatabase[source]¶ Gets a restorable dropped database.
- Parameters
- Keyword Arguments
- Returns
RestorableDroppedDatabase, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RestorableDroppedDatabaseListResult][source]¶ Gets a list of restorable dropped databases.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either RestorableDroppedDatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
RestorableDroppedManagedDatabasesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’srestorable_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
- Keyword Arguments
- Returns
RestorableDroppedManagedDatabase, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RestorableDroppedManagedDatabaseListResult][source]¶ Gets a list of restorable dropped managed databases.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either RestorableDroppedManagedDatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
RestorePointsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’srestore_points
attribute.-
begin_create
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.CreateDatabaseRestorePointDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.RestorePoint][source]¶ Creates a restore point for a data warehouse.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (CreateDatabaseRestorePointDefinition) – The definition for creating the restore point of this database.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 RestorePoint or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, database_name: str, restore_point_name: str, **kwargs: Any) → None[source]¶ Deletes a restore point.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
restore_point_name (str) – The name of the restore point.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, restore_point_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.RestorePoint[source]¶ Gets a restore point.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
restore_point_name (str) – The name of the restore point.
- Keyword Arguments
- Returns
RestorePoint, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.RestorePointListResult][source]¶ Gets a list of database restore points.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either RestorePointListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
SensitivityLabelsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’ssensitivity_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: azure.mgmt.sql.models._models_py3.SensitivityLabel, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SensitivityLabel[source]¶ Creates or updates the sensitivity label of a given column.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
parameters (SensitivityLabel) – The column sensitivity label resource.
- Keyword Arguments
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.
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
SensitivityLabel, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None[source]¶ Deletes the sensitivity label of a given column.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
- Keyword Arguments
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.
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
disable_recommendation
(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None[source]¶ Disables sensitivity recommendations on a given column.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
- Keyword Arguments
sensitivity_label_source (str) – Default value is “recommended”. Note that overriding this default value may result in unsupported behavior.
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
enable_recommendation
(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, **kwargs: Any) → None[source]¶ Enables sensitivity recommendations on a given column (recommendations are enabled by default on all columns).
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
- Keyword Arguments
sensitivity_label_source (str) – Default value is “recommended”. Note that overriding this default value may result in unsupported behavior.
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, schema_name: str, table_name: str, column_name: str, sensitivity_label_source: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SensitivityLabelSource], **kwargs: Any) → azure.mgmt.sql.models._models_py3.SensitivityLabel[source]¶ Gets the sensitivity label of a given column.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
schema_name (str) – The name of the schema.
table_name (str) – The name of the table.
column_name (str) – The name of the column.
sensitivity_label_source (str or SensitivityLabelSource) – The source of the sensitivity label.
- Keyword Arguments
- Returns
SensitivityLabel, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_current_by_database
(resource_group_name: str, server_name: str, database_name: str, skip_token: Optional[str] = None, count: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SensitivityLabelListResult][source]¶ Gets the sensitivity labels of a given database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
skip_token (str) – 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
- Returns
An iterator like instance of either SensitivityLabelListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_recommended_by_database
(resource_group_name: str, server_name: str, database_name: str, skip_token: Optional[str] = None, include_disabled_recommendations: Optional[bool] = None, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SensitivityLabelListResult][source]¶ Gets the sensitivity labels of a given database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
skip_token (str) – 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
- Returns
An iterator like instance of either SensitivityLabelListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.sql.models._models_py3.SensitivityLabelUpdateList, **kwargs: Any) → None[source]¶ Update sensitivity labels of a given database using an operations batch.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (SensitivityLabelUpdateList) –
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerAdvancedThreatProtectionSettingsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_advanced_threat_protection_settings
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, advanced_threat_protection_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdvancedThreatProtectionName], parameters: azure.mgmt.sql.models._models_py3.ServerAdvancedThreatProtection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerAdvancedThreatProtection][source]¶ 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.
server_name (str) – The name of the server.
advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state.
parameters (ServerAdvancedThreatProtection) – The server Advanced Threat Protection state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 ServerAdvancedThreatProtection or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.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.
server_name (str) – The name of the server.
advanced_threat_protection_name (str or AdvancedThreatProtectionName) – The name of the Advanced Threat Protection state.
- Keyword Arguments
- Returns
ServerAdvancedThreatProtection, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LogicalServerAdvancedThreatProtectionListResult][source]¶ Get a list of the server’s Advanced Threat Protection states.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either LogicalServerAdvancedThreatProtectionListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerAdvisorsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_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
- Keyword Arguments
- Returns
Advisor, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, expand: Optional[str] = None, **kwargs: Any) → List[azure.mgmt.sql.models._models_py3.Advisor][source]¶ Gets a list of server advisors.
- Parameters
- Keyword Arguments
- Returns
list of Advisor, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, server_name: str, advisor_name: str, parameters: azure.mgmt.sql.models._models_py3.Advisor, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Advisor[source]¶ Updates a server advisor.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
advisor_name (str) – The name of the Server Advisor.
parameters (Advisor) – The requested advisor resource state.
- Keyword Arguments
- Returns
Advisor, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerAutomaticTuningOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_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
- Keyword Arguments
- Returns
ServerAutomaticTuning, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update
(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerAutomaticTuning, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerAutomaticTuning[source]¶ Update automatic tuning options on server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ServerAutomaticTuning) – The requested automatic tuning resource state.
- Keyword Arguments
- Returns
ServerAutomaticTuning, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerAzureADAdministratorsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_azure_ad_administrators
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], parameters: azure.mgmt.sql.models._models_py3.ServerAzureADAdministrator, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerAzureADAdministrator][source]¶ Creates or updates an existing Azure Active Directory administrator.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
administrator_name (str or AdministratorName) – The name of server active directory administrator.
parameters (ServerAzureADAdministrator) – The requested Azure Active Directory administrator Resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ServerAzureADAdministrator or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes the Azure Active Directory administrator with the given name.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
administrator_name (str or AdministratorName) – The name of server active directory administrator.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, administrator_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AdministratorName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerAzureADAdministrator[source]¶ Gets a Azure Active Directory administrator.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
administrator_name (str or AdministratorName) – The name of server active directory administrator.
- Keyword Arguments
- Returns
ServerAzureADAdministrator, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.AdministratorListResult][source]¶ Gets a list of Azure Active Directory administrators in a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either AdministratorListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerAzureADOnlyAuthenticationsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_azure_ad_only_authentications
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], parameters: azure.mgmt.sql.models._models_py3.ServerAzureADOnlyAuthentication, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerAzureADOnlyAuthentication][source]¶ Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.
parameters (ServerAzureADOnlyAuthentication) – The required parameters for creating or updating an Active Directory only authentication property.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ServerAzureADOnlyAuthentication or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes an existing server Active Directory only authentication property.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, authentication_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.AuthenticationName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerAzureADOnlyAuthentication[source]¶ Gets a specific Azure Active Directory only authentication property.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
authentication_name (str or AuthenticationName) – The name of server azure active directory only authentication.
- Keyword Arguments
- Returns
ServerAzureADOnlyAuthentication, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.AzureADOnlyAuthListResult][source]¶ Gets a list of server Azure Active Directory only authentications.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either AzureADOnlyAuthListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerBlobAuditingPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_blob_auditing_policies
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerBlobAuditingPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerBlobAuditingPolicy][source]¶ Creates or updates a server’s blob auditing policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ServerBlobAuditingPolicy) – Properties of blob auditing policy.
- Keyword Arguments
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.
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 ServerBlobAuditingPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerBlobAuditingPolicy[source]¶ Gets a server’s blob auditing policy.
- Parameters
- 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.
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerBlobAuditingPolicyListResult][source]¶ Lists auditing settings of a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerBlobAuditingPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerCommunicationLinksOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_communication_links
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, communication_link_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerCommunicationLink, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerCommunicationLink][source]¶ Creates a server communication link.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
communication_link_name (str) – The name of the server communication link.
parameters (ServerCommunicationLink) – The required parameters for creating a server communication link.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2014-04-01”. 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 ServerCommunicationLink or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, communication_link_name: str, **kwargs: Any) → None[source]¶ Deletes a server communication link.
- Parameters
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, communication_link_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerCommunicationLink[source]¶ Returns a server communication link.
- Parameters
- Keyword Arguments
- Returns
ServerCommunicationLink, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerCommunicationLinkListResult][source]¶ Gets a list of server communication links.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerCommunicationLinkListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerConnectionPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_connection_policies
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, connection_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ConnectionPolicyName], parameters: azure.mgmt.sql.models._models_py3.ServerConnectionPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerConnectionPolicy][source]¶ Updates a server connection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
connection_policy_name (str or ConnectionPolicyName) – The name of the connection policy.
parameters (ServerConnectionPolicy) – The required parameters for updating a server connection policy.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-05-01-preview”. 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 ServerConnectionPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, connection_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.ConnectionPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerConnectionPolicy[source]¶ Gets a server connection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
connection_policy_name (str or ConnectionPolicyName) – The name of the connection policy.
- Keyword Arguments
- Returns
ServerConnectionPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerConnectionPolicyListResult][source]¶ Lists connection policy.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerConnectionPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerDevOpsAuditSettingsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_dev_ops_audit_settings
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, dev_ops_auditing_settings_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerDevOpsAuditingSettings, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerDevOpsAuditingSettings][source]¶ Creates or updates a server’s DevOps audit settings.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
dev_ops_auditing_settings_name (str) – The name of the devops audit settings. This should always be ‘default’.
parameters (ServerDevOpsAuditingSettings) – Properties of DevOps audit settings.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ServerDevOpsAuditingSettings or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, dev_ops_auditing_settings_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerDevOpsAuditingSettings[source]¶ Gets a server’s DevOps audit settings.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
dev_ops_auditing_settings_name (str) – The name of the devops audit settings. This should always be ‘default’.
- Keyword Arguments
- Returns
ServerDevOpsAuditingSettings, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerDevOpsAuditSettingsListResult][source]¶ Lists DevOps audit settings of a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerDevOpsAuditSettingsListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerDnsAliasesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_dns_aliases
attribute.-
begin_acquire
(resource_group_name: str, server_name: str, dns_alias_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerDnsAliasAcquisition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerDnsAlias][source]¶ Acquires server DNS alias from another server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server dns alias.
parameters (ServerDnsAliasAcquisition) –
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ServerDnsAlias or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_create_or_update
(resource_group_name: str, server_name: str, dns_alias_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerDnsAlias][source]¶ Creates a server DNS alias.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ServerDnsAlias or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, dns_alias_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes the server DNS alias with the given name.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, dns_alias_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerDnsAlias[source]¶ Gets a server DNS alias.
- Parameters
- Keyword Arguments
- Returns
ServerDnsAlias, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerDnsAliasListResult][source]¶ Gets a list of server DNS aliases for a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerDnsAliasListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerKeysOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_keys
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, key_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerKey, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerKey][source]¶ Creates or updates a server key.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
key_name (str) – The name of the server key to be operated on (updated or created). The key name is required to be in the format of ‘vault_key_version’. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.
parameters (ServerKey) – The requested server key resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ServerKey or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, key_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes the server key with the given name.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, key_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerKey[source]¶ Gets a server key.
- Parameters
- Keyword Arguments
- Returns
ServerKey, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerKeyListResult][source]¶ Gets a list of server keys.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerKeyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerOperationsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_operations
attribute.-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerOperationListResult][source]¶ Gets a list of operations performed on the server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerOperationListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerSecurityAlertPoliciesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_security_alert_policies
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.sql.models._models_py3.ServerSecurityAlertPolicy, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerSecurityAlertPolicy][source]¶ Creates or updates a threat detection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the threat detection policy.
parameters (ServerSecurityAlertPolicy) – The server security alert policy.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ServerSecurityAlertPolicy or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerSecurityAlertPolicy[source]¶ Get a server’s security alert policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.
- Keyword Arguments
- Returns
ServerSecurityAlertPolicy, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LogicalServerSecurityAlertPolicyListResult][source]¶ Get the server’s threat detection policies.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either LogicalServerSecurityAlertPolicyListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerTrustCertificatesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_trust_certificates
attribute.-
begin_create_or_update
(resource_group_name: str, managed_instance_name: str, certificate_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerTrustCertificate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerTrustCertificate][source]¶ Uploads a server trust certificate from box to Sql Managed Instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
certificate_name (str) – Name of of the certificate to upload.
parameters (ServerTrustCertificate) – The server trust certificate info.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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 ServerTrustCertificate or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, managed_instance_name: str, certificate_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a server trust certificate that was uploaded from box to Sql Managed Instance.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, certificate_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerTrustCertificate[source]¶ Gets a server trust certificate that was uploaded from box to Sql Managed Instance.
- Parameters
- Keyword Arguments
- Returns
ServerTrustCertificate, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerTrustCertificatesListResult][source]¶ Gets a list of server trust certificates that were uploaded from box to the given Sql Managed Instance.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerTrustCertificatesListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerTrustGroupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_trust_groups
attribute.-
begin_create_or_update
(resource_group_name: str, location_name: str, server_trust_group_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerTrustGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ServerTrustGroup][source]¶ Creates or updates a server trust group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
server_trust_group_name (str) – The name of the server trust group.
parameters (ServerTrustGroup) – The server trust group parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 ServerTrustGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, location_name: str, server_trust_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a server trust group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
server_trust_group_name (str) – The name of the server trust group.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, location_name: str, server_trust_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerTrustGroup[source]¶ Gets a server trust group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
server_trust_group_name (str) – The name of the server trust group.
- Keyword Arguments
- Returns
ServerTrustGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_instance
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerTrustGroupListResult][source]¶ Gets a server trust groups by instance name.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerTrustGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_location
(resource_group_name: str, location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerTrustGroupListResult][source]¶ Lists a server trust group.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerTrustGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerUsagesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_usages
attribute.-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerUsageListResult][source]¶ Returns server usages.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerUsageListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServerVulnerabilityAssessmentsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sserver_vulnerability_assessments
attribute.-
create_or_update
(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], parameters: azure.mgmt.sql.models._models_py3.ServerVulnerabilityAssessment, **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerVulnerabilityAssessment[source]¶ Creates or updates the server’s vulnerability assessment. Learn more about setting SQL vulnerability assessment with managed identity - https://docs.microsoft.com/azure/azure-sql/database/sql-database-vulnerability-assessment-storage.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
parameters (ServerVulnerabilityAssessment) – The requested resource.
- Keyword Arguments
- Returns
ServerVulnerabilityAssessment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
delete
(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → None[source]¶ Removes the server’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, vulnerability_assessment_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.VulnerabilityAssessmentName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.ServerVulnerabilityAssessment[source]¶ Gets the server’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server for which the vulnerability assessment is defined.
vulnerability_assessment_name (str or VulnerabilityAssessmentName) – The name of the vulnerability assessment.
- Keyword Arguments
- Returns
ServerVulnerabilityAssessment, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerVulnerabilityAssessmentListResult][source]¶ Lists the vulnerability assessment policies associated with a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerVulnerabilityAssessmentListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServersOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sservers
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.Server, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Server][source]¶ Creates or updates a server.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 Server or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a server.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_import_database
(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ImportNewDatabaseDefinition, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.ImportExportOperationResult][source]¶ Imports a bacpac into a new database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ImportNewDatabaseDefinition) – The database import request parameters.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 ImportExportOperationResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.ServerUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.Server][source]¶ Updates a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ServerUpdate) – The requested server resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2021-02-01-preview”. 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 Server or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
check_name_availability
(parameters: azure.mgmt.sql.models._models_py3.CheckNameAvailabilityRequest, **kwargs: Any) → azure.mgmt.sql.models._models_py3.CheckNameAvailabilityResponse[source]¶ Determines whether a resource can be created with the specified name.
- Parameters
parameters (CheckNameAvailabilityRequest) – The name availability request parameters.
- Keyword Arguments
- Returns
CheckNameAvailabilityResponse, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, expand: Optional[str] = None, **kwargs: Any) → azure.mgmt.sql.models._models_py3.Server[source]¶ Gets a server.
- Parameters
- Keyword Arguments
- Returns
Server, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerListResult][source]¶ Gets a list of all servers in the subscription.
- Parameters
expand (str) – The child resources to include in the response. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either ServerListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, expand: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServerListResult][source]¶ Gets a list of servers in a resource groups.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServerListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
ServiceObjectivesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sservice_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
- Keyword Arguments
- Returns
ServiceObjective, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.ServiceObjectiveListResult][source]¶ Returns database service objectives.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either ServiceObjectiveListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
SqlAgentOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’ssql_agent
attribute.-
create_or_update
(resource_group_name: str, managed_instance_name: str, parameters: azure.mgmt.sql.models._models_py3.SqlAgentConfiguration, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SqlAgentConfiguration[source]¶ Puts new sql agent configuration to instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (SqlAgentConfiguration) –
- Keyword Arguments
- Returns
SqlAgentConfiguration, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, managed_instance_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SqlAgentConfiguration[source]¶ Gets current instance sql agent configuration.
- Parameters
- Keyword Arguments
- Returns
SqlAgentConfiguration, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
SubscriptionUsagesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’ssubscription_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
- Keyword Arguments
- Returns
SubscriptionUsage, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_location
(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SubscriptionUsageListResult][source]¶ Gets all subscription usage metrics in a given location.
- Parameters
location_name (str) – The name of the region where the resource is located.
- Keyword Arguments
- Returns
An iterator like instance of either SubscriptionUsageListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
SyncAgentsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’ssync_agents
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, sync_agent_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncAgent, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncAgent][source]¶ Creates or updates a sync agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
parameters (SyncAgent) – The requested sync agent resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 SyncAgent or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a sync agent.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
generate_key
(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SyncAgentKeyProperties[source]¶ Generates a sync agent key.
- Parameters
- Keyword Arguments
- Returns
SyncAgentKeyProperties, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SyncAgent[source]¶ Gets a sync agent.
- Parameters
- Keyword Arguments
- Returns
SyncAgent, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncAgentListResult][source]¶ Lists sync agents in a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either SyncAgentListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_linked_databases
(resource_group_name: str, server_name: str, sync_agent_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncAgentLinkedDatabaseListResult][source]¶ Lists databases linked to a sync agent.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either SyncAgentLinkedDatabaseListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
SyncGroupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’ssync_groups
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncGroup][source]¶ Creates or updates a sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
parameters (SyncGroup) – The requested sync group resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 SyncGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_refresh_hub_schema
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Refreshes a hub database schema.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncGroup][source]¶ Updates a sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
parameters (SyncGroup) – The requested sync group resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 SyncGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
cancel_sync
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → None[source]¶ Cancels a sync group synchronization.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SyncGroup[source]¶ Gets a sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
- Keyword Arguments
- Returns
SyncGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncGroupListResult][source]¶ Lists sync groups under a hub database.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either SyncGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_hub_schemas
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncFullSchemaPropertiesListResult][source]¶ Gets a collection of hub database schemas.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
- Keyword Arguments
- Returns
An iterator like instance of either SyncFullSchemaPropertiesListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_logs
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, start_time: str, end_time: str, type: Union[str, azure.mgmt.sql.models._sql_management_client_enums.SyncGroupsType], continuation_token_parameter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncGroupLogListResult][source]¶ Gets a collection of sync group logs.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
start_time (str) – Get logs generated after this time.
end_time (str) – Get logs generated before this time.
type (str or SyncGroupsType) – The types of logs to retrieve.
continuation_token_parameter (str) – The continuation token for this operation. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either SyncGroupLogListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_sync_database_ids
(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncDatabaseIdListResult][source]¶ Gets a collection of sync database ids.
- Parameters
location_name (str) – The name of the region where the resource is located.
- Keyword Arguments
- Returns
An iterator like instance of either SyncDatabaseIdListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
trigger_sync
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → None[source]¶ Triggers a sync group synchronization.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
- Keyword Arguments
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
SyncMembersOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’ssync_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: azure.mgmt.sql.models._models_py3.SyncMember, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncMember][source]¶ Creates or updates a sync member.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
parameters (SyncMember) – The requested sync member resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 SyncMember or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a sync member.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_refresh_member_schema
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Refreshes a sync member database schema.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, parameters: azure.mgmt.sql.models._models_py3.SyncMember, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.SyncMember][source]¶ Updates an existing sync member.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
parameters (SyncMember) – The requested sync member resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 SyncMember or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.SyncMember[source]¶ Gets a sync member.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
- Keyword Arguments
- Returns
SyncMember, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_sync_group
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncMemberListResult][source]¶ Lists sync members in the given sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
- Keyword Arguments
- Returns
An iterator like instance of either SyncMemberListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_member_schemas
(resource_group_name: str, server_name: str, database_name: str, sync_group_name: str, sync_member_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.SyncFullSchemaPropertiesListResult][source]¶ Gets a sync member database schema.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
- Keyword Arguments
- Returns
An iterator like instance of either SyncFullSchemaPropertiesListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
TdeCertificatesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’stde_certificates
attribute.-
begin_create
(resource_group_name: str, server_name: str, parameters: azure.mgmt.sql.models._models_py3.TdeCertificate, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Creates a TDE certificate for a given server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (TdeCertificate) – The requested TDE certificate to be created or updated.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
TimeZonesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’stime_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
- Keyword Arguments
- Returns
TimeZone, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_location
(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.TimeZoneListResult][source]¶ Gets a list of managed instance time zones by location.
- Parameters
location_name (str) –
- Keyword Arguments
- Returns
An iterator like instance of either TimeZoneListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
TransparentDataEncryptionsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’stransparent_data_encryptions
attribute.-
create_or_update
(resource_group_name: str, server_name: str, database_name: str, tde_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionName], parameters: azure.mgmt.sql.models._models_py3.LogicalDatabaseTransparentDataEncryption, **kwargs: Any) → Optional[azure.mgmt.sql.models._models_py3.LogicalDatabaseTransparentDataEncryption][source]¶ Updates a logical database’s transparent data encryption configuration.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the logical database for which the security alert policy is defined.
tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration.
parameters (LogicalDatabaseTransparentDataEncryption) – The database transparent data encryption.
- Keyword Arguments
- Returns
LogicalDatabaseTransparentDataEncryption, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, tde_name: Union[str, azure.mgmt.sql.models._sql_management_client_enums.TransparentDataEncryptionName], **kwargs: Any) → azure.mgmt.sql.models._models_py3.LogicalDatabaseTransparentDataEncryption[source]¶ Gets a logical database’s transparent data encryption.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the logical database for which the transparent data encryption is defined.
tde_name (str or TransparentDataEncryptionName) – The name of the transparent data encryption configuration.
- Keyword Arguments
- Returns
LogicalDatabaseTransparentDataEncryption, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.LogicalDatabaseTransparentDataEncryptionListResult][source]¶ Gets a list of the logical database’s transparent data encryption.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the logical database for which the transparent data encryption is defined.
- Keyword Arguments
- Returns
An iterator like instance of either LogicalDatabaseTransparentDataEncryptionListResult or the result of cls(response)
- Return type
ItemPaged[LogicalDatabaseTransparentDataEncryptionListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
UsagesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’susages
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.UsageListResult][source]¶ Gets all instance pool usage metrics.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
instance_pool_name (str) – The name of the instance pool to be retrieved.
expand_children (bool) – Optional request parameter to include managed instance usages within the instance pool. Default value is None.
- Keyword Arguments
- Returns
An iterator like instance of either UsageListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
VirtualClustersOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’svirtual_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
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_update
(resource_group_name: str, virtual_cluster_name: str, parameters: azure.mgmt.sql.models._models_py3.VirtualClusterUpdate, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.VirtualCluster][source]¶ Updates a virtual cluster.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
virtual_cluster_name (str) – The name of the virtual cluster.
parameters (VirtualClusterUpdate) – The requested virtual cluster resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 VirtualCluster or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.VirtualCluster[source]¶ Gets a virtual cluster.
- Parameters
- Keyword Arguments
- Returns
VirtualCluster, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(**kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VirtualClusterListResult][source]¶ Gets a list of all virtualClusters in the subscription.
- Keyword Arguments
- Returns
An iterator like instance of either VirtualClusterListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VirtualClusterListResult][source]¶ Gets a list of virtual clusters in a resource group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Keyword Arguments
- Returns
An iterator like instance of either VirtualClusterListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
update_dns_servers
(resource_group_name: str, virtual_cluster_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.UpdateManagedInstanceDnsServersOperation[source]¶ Synchronizes the DNS server settings used by the managed instances inside the given virtual cluster.
- Parameters
- Keyword Arguments
- Returns
UpdateManagedInstanceDnsServersOperation, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
VirtualNetworkRulesOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’svirtual_network_rules
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, virtual_network_rule_name: str, parameters: azure.mgmt.sql.models._models_py3.VirtualNetworkRule, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.VirtualNetworkRule][source]¶ Creates or updates an existing virtual network rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
virtual_network_rule_name (str) – The name of the virtual network rule.
parameters (VirtualNetworkRule) – The requested virtual Network Rule Resource state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, virtual_network_rule_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes the virtual network rule with the given name.
- Parameters
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, virtual_network_rule_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.VirtualNetworkRule[source]¶ Gets a virtual network rule.
- Parameters
- Keyword Arguments
- Returns
VirtualNetworkRule, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.VirtualNetworkRuleListResult][source]¶ Gets a list of virtual network rules in a server.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either VirtualNetworkRuleListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
WorkloadClassifiersOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sworkload_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: azure.mgmt.sql.models._models_py3.WorkloadClassifier, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.WorkloadClassifier][source]¶ Creates or updates a workload classifier.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group from which to receive the classifier from.
workload_classifier_name (str) – The name of the workload classifier to create/update.
parameters (WorkloadClassifier) – The properties of the workload classifier.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 WorkloadClassifier or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, workload_classifier_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a workload classifier.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group from which to receive the classifier from.
workload_classifier_name (str) – The name of the workload classifier to delete.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, workload_classifier_name: str, **kwargs: Any) → azure.mgmt.sql.models._models_py3.WorkloadClassifier[source]¶ Gets a workload classifier.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group from which to receive the classifier from.
workload_classifier_name (str) – The name of the workload classifier.
- Keyword Arguments
- Returns
WorkloadClassifier, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_workload_group
(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.WorkloadClassifierListResult][source]¶ Gets the list of workload classifiers for a workload group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group from which to receive the classifiers from.
- Keyword Arguments
- Returns
An iterator like instance of either WorkloadClassifierListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
-
class
azure.mgmt.sql.operations.
WorkloadGroupsOperations
(*args, **kwargs)[source]¶ Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
SqlManagementClient
’sworkload_groups
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, parameters: azure.mgmt.sql.models._models_py3.WorkloadGroup, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.sql.models._models_py3.WorkloadGroup][source]¶ Creates or updates a workload group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group.
parameters (WorkloadGroup) – The requested workload group state.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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 WorkloadGroup or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, server_name: str, database_name: str, workload_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a workload group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group to delete.
- Keyword Arguments
api_version (str) – Api Version. Default value is “2020-11-01-preview”. 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
- Raises
~azure.core.exceptions.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.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
workload_group_name (str) – The name of the workload group.
- Keyword Arguments
- Returns
WorkloadGroup, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_database
(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any) → Iterable[azure.mgmt.sql.models._models_py3.WorkloadGroupListResult][source]¶ Gets the list of workload groups.
- Parameters
- Keyword Arguments
- Returns
An iterator like instance of either WorkloadGroupListResult or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.sql.models' from '/mnt/vss/_work/1/s/sdk/sql/azure-mgmt-sql/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-