azure.mgmt.sql.operations module¶
-
class
azure.mgmt.sql.operations.
RecoverableDatabasesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
RecoverableDatabasesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a recoverable database, which is a resource representing a database’s geo backup.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RecoverableDatabase or ClientRawResponse if raw=true
- Return type
RecoverableDatabase or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of recoverable databases.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RecoverableDatabase
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
RestorableDroppedDatabasesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
RestorableDroppedDatabasesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
get
(resource_group_name, server_name, restorable_droppeded_database_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a deleted database that can be restored.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
restorable_droppeded_database_id (str) – The id of the deleted database in the form of databaseName,deletionTimeInFileTimeFormat
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RestorableDroppedDatabase or ClientRawResponse if raw=true
- Return type
RestorableDroppedDatabase or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of deleted databases that can be restored.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RestorableDroppedDatabase
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ServersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServersOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
check_name_availability
(name, custom_headers=None, raw=False, **operation_config)[source]¶ Determines whether a resource can be created with the specified name.
- Parameters
name (str) – The name whose availability is to be checked.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CheckNameAvailabilityResponse or ClientRawResponse if raw=true
- Return type
CheckNameAvailabilityResponse or ClientRawResponse
- Raises
CloudError
-
create_or_update
(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (Server) – The requested server resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Server or ClientRawResponse<Server> if raw==True
- Return type
AzureOperationPoller[Server] or AzureOperationPoller[ClientRawResponse[Server]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Server or ClientRawResponse if raw=true
- Return type
Server or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of all servers in the subscription.
- Parameters
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Server
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of servers in a resource groups.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Server
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ServerUpdate) – The requested server resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Server or ClientRawResponse<Server> if raw==True
- Return type
AzureOperationPoller[Server] or AzureOperationPoller[ClientRawResponse[Server]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
ServerConnectionPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerConnectionPoliciesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
connection_policy_name – The name of the connection policy. Constant value: “default”.
-
create_or_update
(resource_group_name, server_name, connection_type, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates the server’s connection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
connection_type (str or ServerConnectionType) – The server connection type. Possible values include: ‘Default’, ‘Proxy’, ‘Redirect’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerConnectionPolicy or ClientRawResponse if raw=true
- Return type
ServerConnectionPolicy or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the server’s secure connection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerConnectionPolicy or ClientRawResponse if raw=true
- Return type
ServerConnectionPolicy or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabaseThreatDetectionPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabaseThreatDetectionPoliciesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
security_alert_policy_name – The name of the security alert policy. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
create_or_update
(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a database’s threat detection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which database Threat Detection policy is defined.
parameters (DatabaseSecurityAlertPolicy) – The database Threat Detection policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseSecurityAlertPolicy or ClientRawResponse if raw=true
- Return type
DatabaseSecurityAlertPolicy or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database’s threat detection policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which database Threat Detection policy is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseSecurityAlertPolicy or ClientRawResponse if raw=true
- Return type
DatabaseSecurityAlertPolicy or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DataMaskingPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DataMaskingPoliciesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
data_masking_policy_name – The name of the database for which the data masking rule applies. Constant value: “Default”.
-
create_or_update
(resource_group_name, server_name, database_name, data_masking_state, exempt_principals=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a database data masking policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
data_masking_state (str or DataMaskingState) – The state of the data masking policy. Possible values include: ‘Disabled’, ‘Enabled’
exempt_principals (str) – The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DataMaskingPolicy or ClientRawResponse if raw=true
- Return type
DataMaskingPolicy or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database data masking policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DataMaskingPolicy or ClientRawResponse if raw=true
- Return type
DataMaskingPolicy or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DataMaskingRulesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DataMaskingRulesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
data_masking_policy_name – The name of the database for which the data masking rule applies. Constant value: “Default”.
-
create_or_update
(resource_group_name, server_name, database_name, data_masking_rule_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a database data masking rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
data_masking_rule_name (str) – The name of the data masking rule.
parameters (DataMaskingRule) – The required parameters for creating or updating a data masking rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DataMaskingRule or ClientRawResponse if raw=true
- Return type
DataMaskingRule or ClientRawResponse
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of database data masking rules.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of DataMaskingRule
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
FirewallRulesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
FirewallRulesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
create_or_update
(resource_group_name, server_name, firewall_rule_name, start_ip_address, end_ip_address, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a firewall rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
firewall_rule_name (str) – The name of the firewall rule.
start_ip_address (str) – The start IP address of the firewall rule. Must be IPv4 format. Use value ‘0.0.0.0’ to represent all Azure-internal IP addresses.
end_ip_address (str) – The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value ‘0.0.0.0’ to represent all Azure-internal IP addresses.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
FirewallRule or ClientRawResponse if raw=true
- Return type
FirewallRule or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, server_name, firewall_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a firewall rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
firewall_rule_name (str) – The name of the firewall rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, firewall_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a firewall rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
firewall_rule_name (str) – The name of the firewall rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
FirewallRule or ClientRawResponse if raw=true
- Return type
FirewallRule or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns a list of firewall rules.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of FirewallRule
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
GeoBackupPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
GeoBackupPoliciesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
geo_backup_policy_name – The name of the geo backup policy. Constant value: “Default”.
-
create_or_update
(resource_group_name, server_name, database_name, state, custom_headers=None, raw=False, **operation_config)[source]¶ Updates a database geo backup policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
state (str or GeoBackupPolicyState) – The state of the geo backup policy. Possible values include: ‘Disabled’, ‘Enabled’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GeoBackupPolicy or ClientRawResponse if raw=true
- Return type
GeoBackupPolicy or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a geo backup policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GeoBackupPolicy or ClientRawResponse if raw=true
- Return type
GeoBackupPolicy or ClientRawResponse
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns a list of geo backup policies.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of GeoBackupPolicy
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabasesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabasesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
extension_name – The name of the operation to perform. Constant value: “import”.
-
create_import_operation
(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates an import operation that imports a bacpac into an existing database. The existing database must be empty.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from 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 import into
parameters (ImportExtensionRequest) – The required parameters for importing a Bacpac into a database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ImportExportResponse or ClientRawResponse<ImportExportResponse> if raw==True
- Return type
AzureOperationPoller[ImportExportResponse] or AzureOperationPoller[ClientRawResponse[ImportExportResponse]]
- Raises
CloudError
-
create_or_update
(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a new database or updates an existing database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (Database) – The requested database resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True
- Return type
AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes the database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
export
(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Exports a database to a bacpac.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to be exported.
parameters (ExportRequest) – The required parameters for exporting a database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ImportExportResponse or ClientRawResponse<ImportExportResponse> if raw==True
- Return type
AzureOperationPoller[ImportExportResponse] or AzureOperationPoller[ClientRawResponse[ImportExportResponse]]
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Database or ClientRawResponse if raw=true
- Return type
Database or ClientRawResponse
- Raises
CloudError
-
import_method
(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Imports a bacpac into a new database. .
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (ImportRequest) – The required parameters for importing a Bacpac into a database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ImportExportResponse or ClientRawResponse<ImportExportResponse> if raw==True
- Return type
AzureOperationPoller[ImportExportResponse] or AzureOperationPoller[ClientRawResponse[ImportExportResponse]]
- Raises
CloudError
-
list_by_elastic_pool
(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of databases in an elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Database
- Return type
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of databases.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Database
- Return type
- Raises
CloudError
-
list_metric_definitions
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns database metric definitions.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of MetricDefinition
- Return type
- Raises
CloudError
-
list_metrics
(resource_group_name, server_name, database_name, filter, custom_headers=None, raw=False, **operation_config)[source]¶ Returns database metrics.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
filter (str) – An OData filter expression that describes a subset of metrics to return.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Metric
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
pause
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Pauses a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to be paused.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True
- Return type
AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]
- Raises
CloudError
-
rename
(resource_group_name, server_name, database_name, id, custom_headers=None, raw=False, **operation_config)[source]¶ Renames a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to rename.
id (str) – The target ID for the resource
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
resume
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Resumes a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to be resumed.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True
- Return type
AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]
- Raises
CloudError
-
update
(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates an existing database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (DatabaseUpdate) – The requested database resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True
- Return type
AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]
- Raises
CloudError
-
upgrade_data_warehouse
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Upgrades a data warehouse.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to be upgraded.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
ElasticPoolsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ElasticPoolsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
create_or_update
(resource_group_name, server_name, elastic_pool_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates an elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
parameters (ElasticPool) – The elastic pool parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ElasticPool or ClientRawResponse<ElasticPool> if raw==True
- Return type
AzureOperationPoller[ElasticPool] or AzureOperationPoller[ClientRawResponse[ElasticPool]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes an elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ElasticPool or ClientRawResponse if raw=true
- Return type
ElasticPool or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, skip=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all elastic pools in a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
skip (int) – The number of elements in the collection to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ElasticPool
- Return type
- Raises
CloudError
-
list_metric_definitions
(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns elastic pool metric definitions.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of MetricDefinition
- Return type
- Raises
CloudError
-
list_metrics
(resource_group_name, server_name, elastic_pool_name, filter, custom_headers=None, raw=False, **operation_config)[source]¶ Returns elastic pool metrics.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
filter (str) – An OData filter expression that describes a subset of metrics to return.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Metric
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, server_name, elastic_pool_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates an elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
parameters (ElasticPoolUpdate) – The elastic pool update parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ElasticPool or ClientRawResponse<ElasticPool> if raw==True
- Return type
AzureOperationPoller[ElasticPool] or AzureOperationPoller[ClientRawResponse[ElasticPool]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
RecommendedElasticPoolsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
RecommendedElasticPoolsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
get
(resource_group_name, server_name, recommended_elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a recommented elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
recommended_elastic_pool_name (str) – The name of the recommended elastic pool to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RecommendedElasticPool or ClientRawResponse if raw=true
- Return type
RecommendedElasticPool or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns recommended elastic pools.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RecommendedElasticPool
- Return type
- Raises
CloudError
-
list_metrics
(resource_group_name, server_name, recommended_elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns recommented elastic pool metrics.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
recommended_elastic_pool_name (str) – The name of the recommended elastic pool to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RecommendedElasticPoolMetric
- Return type
RecommendedElasticPoolMetricPaged[RecommendedElasticPoolMetric]
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ReplicationLinksOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ReplicationLinksOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
delete
(resource_group_name, server_name, database_name, link_id, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a database replication link. Cannot be done during failover.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database that has the replication link to be dropped.
link_id (str) – The ID of the replication link to be deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
failover
(resource_group_name, server_name, database_name, link_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Sets which replica database is primary by failing over from the current primary replica database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database that has the replication link to be failed over.
link_id (str) – The ID of the replication link to be failed over.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
failover_allow_data_loss
(resource_group_name, server_name, database_name, link_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Sets which replica database is primary by failing over from the current primary replica database. This operation might result in data loss.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database that has the replication link to be failed over.
link_id (str) – The ID of the replication link to be failed over.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, link_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database replication link.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to get the link for.
link_id (str) – The replication link ID to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ReplicationLink or ClientRawResponse if raw=true
- Return type
ReplicationLink or ClientRawResponse
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists a database’s replication links.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database to retrieve links for.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ReplicationLink
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ServerAzureADAdministratorsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerAzureADAdministratorsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
administrator_name – Name of the server administrator resource. Constant value: “activeDirectory”.
-
create_or_update
(resource_group_name, server_name, properties, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a new Server Active Directory Administrator or updates an existing server 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.
properties (ServerAzureADAdministrator) – The required parameters for creating or updating an Active Directory Administrator.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ServerAzureADAdministrator or ClientRawResponse<ServerAzureADAdministrator> if raw==True
- Return type
AzureOperationPoller[ServerAzureADAdministrator] or AzureOperationPoller[ClientRawResponse[ServerAzureADAdministrator]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes an existing server Active Directory Administrator.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ServerAzureADAdministrator or ClientRawResponse<ServerAzureADAdministrator> if raw==True
- Return type
AzureOperationPoller[ServerAzureADAdministrator] or AzureOperationPoller[ClientRawResponse[ServerAzureADAdministrator]]
- Raises
CloudError
-
get
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns an server Administrator.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerAzureADAdministrator or ClientRawResponse if raw=true
- Return type
ServerAzureADAdministrator or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns a list of server Administrators.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ServerAzureADAdministrator
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ServerCommunicationLinksOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerCommunicationLinksOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
create_or_update
(resource_group_name, server_name, communication_link_name, partner_server, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a server communication link.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
communication_link_name (str) – The name of the server communication link.
partner_server (str) – The name of the partner server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ServerCommunicationLink or ClientRawResponse<ServerCommunicationLink> if raw==True
- Return type
AzureOperationPoller[ServerCommunicationLink] or AzureOperationPoller[ClientRawResponse[ServerCommunicationLink]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, communication_link_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a server communication link.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
communication_link_name (str) – The name of the server communication link.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, communication_link_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns a server communication link.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
communication_link_name (str) – The name of the server communication link.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerCommunicationLink or ClientRawResponse if raw=true
- Return type
ServerCommunicationLink or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of server communication links.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ServerCommunicationLink
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ServiceObjectivesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServiceObjectivesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
get
(resource_group_name, server_name, service_objective_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database service objective.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
service_objective_name (str) – The name of the service objective to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServiceObjective or ClientRawResponse if raw=true
- Return type
ServiceObjective or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns database service objectives.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ServiceObjective
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ElasticPoolActivitiesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ElasticPoolActivitiesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
list_by_elastic_pool
(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns elastic pool activities.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool for which to get the current activity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ElasticPoolActivity
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ElasticPoolDatabaseActivitiesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ElasticPoolDatabaseActivitiesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
list_by_elastic_pool
(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns activity on databases inside of an elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) – The name of the elastic pool.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ElasticPoolDatabaseActivity
- Return type
ElasticPoolDatabaseActivityPaged[ElasticPoolDatabaseActivity]
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ServiceTierAdvisorsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServiceTierAdvisorsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
get
(resource_group_name, server_name, database_name, service_tier_advisor_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a service tier advisor.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of database.
service_tier_advisor_name (str) – The name of service tier advisor.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServiceTierAdvisor or ClientRawResponse if raw=true
- Return type
ServiceTierAdvisor or ClientRawResponse
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns service tier advisors for specified database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ServiceTierAdvisor
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
TransparentDataEncryptionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TransparentDataEncryptionsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
transparent_data_encryption_name – The name of the transparent data encryption configuration. Constant value: “current”.
-
create_or_update
(resource_group_name, server_name, database_name, status=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a database’s transparent data encryption configuration.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which setting the transparent data encryption applies.
status (str or TransparentDataEncryptionStatus) – The status of the database transparent data encryption. Possible values include: ‘Enabled’, ‘Disabled’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TransparentDataEncryption or ClientRawResponse if raw=true
- Return type
TransparentDataEncryption or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database’s transparent data encryption configuration.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the transparent data encryption applies.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TransparentDataEncryption or ClientRawResponse if raw=true
- Return type
TransparentDataEncryption or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
TransparentDataEncryptionActivitiesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
TransparentDataEncryptionActivitiesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
transparent_data_encryption_name – The name of the transparent data encryption configuration. Constant value: “current”.
-
list_by_configuration
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns a database’s transparent data encryption operation result.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the transparent data encryption applies.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TransparentDataEncryptionActivity
- Return type
TransparentDataEncryptionActivityPaged[TransparentDataEncryptionActivity]
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ServerUsagesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerUsagesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns server usages.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ServerUsage
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabaseUsagesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabaseUsagesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2014-04-01”.
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Returns database usages.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of DatabaseUsage
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabaseBlobAuditingPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabaseBlobAuditingPoliciesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
blob_auditing_policy_name – The name of the blob auditing policy. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
create_or_update
(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a database’s blob auditing policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the blob auditing policy will be defined.
parameters (DatabaseBlobAuditingPolicy) – The database blob auditing policy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseBlobAuditingPolicy or ClientRawResponse if raw=true
- Return type
DatabaseBlobAuditingPolicy or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database’s blob auditing policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the blob audit policy is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseBlobAuditingPolicy or ClientRawResponse if raw=true
- Return type
DatabaseBlobAuditingPolicy or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabaseAutomaticTuningOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabaseAutomaticTuningOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database’s automatic tuning.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseAutomaticTuning or ClientRawResponse if raw=true
- Return type
DatabaseAutomaticTuning or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, server_name, database_name, desired_state=None, options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Update automatic tuning properties for target database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
desired_state (str or AutomaticTuningMode) – Automatic tuning desired state. Possible values include: ‘Inherit’, ‘Custom’, ‘Auto’, ‘Unspecified’
options (dict[str, AutomaticTuningOptions]) – Automatic tuning options definition.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseAutomaticTuning or ClientRawResponse if raw=true
- Return type
DatabaseAutomaticTuning or ClientRawResponse
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
EncryptionProtectorsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
EncryptionProtectorsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
encryption_protector_name – The name of the encryption protector to be retrieved. Constant value: “current”.
-
create_or_update
(resource_group_name, server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates an existing encryption protector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
parameters (EncryptionProtector) – The requested encryption protector resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns EncryptionProtector or ClientRawResponse<EncryptionProtector> if raw==True
- Return type
AzureOperationPoller[EncryptionProtector] or AzureOperationPoller[ClientRawResponse[EncryptionProtector]]
- Raises
CloudError
-
get
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a server encryption protector.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
EncryptionProtector or ClientRawResponse if raw=true
- Return type
EncryptionProtector or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of server encryption protectors.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of EncryptionProtector
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
FailoverGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
FailoverGroupsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
create_or_update
(resource_group_name, server_name, failover_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
parameters (FailoverGroup) – The failover group parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns FailoverGroup or ClientRawResponse<FailoverGroup> if raw==True
- Return type
AzureOperationPoller[FailoverGroup] or AzureOperationPoller[ClientRawResponse[FailoverGroup]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
failover
(resource_group_name, server_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Fails over from the current primary server to this server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns FailoverGroup or ClientRawResponse<FailoverGroup> if raw==True
- Return type
AzureOperationPoller[FailoverGroup] or AzureOperationPoller[ClientRawResponse[FailoverGroup]]
- Raises
CloudError
-
force_failover_allow_data_loss
(resource_group_name, server_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Fails over from the current primary server to this server. This operation might result in data loss.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns FailoverGroup or ClientRawResponse<FailoverGroup> if raw==True
- Return type
AzureOperationPoller[FailoverGroup] or AzureOperationPoller[ClientRawResponse[FailoverGroup]]
- Raises
CloudError
-
get
(resource_group_name, server_name, failover_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
FailoverGroup or ClientRawResponse if raw=true
- Return type
FailoverGroup or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the failover groups in a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of FailoverGroup
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, server_name, failover_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server containing the failover group.
failover_group_name (str) – The name of the failover group.
parameters (FailoverGroupUpdate) – The failover group parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns FailoverGroup or ClientRawResponse<FailoverGroup> if raw==True
- Return type
AzureOperationPoller[FailoverGroup] or AzureOperationPoller[ClientRawResponse[FailoverGroup]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
ManagedInstancesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ManagedInstancesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
create_or_update
(resource_group_name, managed_instance_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (ManagedInstance) – The requested managed instance resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ManagedInstance or ClientRawResponse<ManagedInstance> if raw==True
- Return type
AzureOperationPoller[ManagedInstance] or AzureOperationPoller[ClientRawResponse[ManagedInstance]]
- Raises
CloudError
-
delete
(resource_group_name, managed_instance_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ManagedInstance or ClientRawResponse if raw=true
- Return type
ManagedInstance or ClientRawResponse
- Raises
CloudError
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of all managed instances in the subscription.
- Parameters
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ManagedInstance
- Return type
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of managed instances in a resource group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ManagedInstance
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, managed_instance_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
parameters (ManagedInstanceUpdate) – The requested managed instance resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ManagedInstance or ClientRawResponse<ManagedInstance> if raw==True
- Return type
AzureOperationPoller[ManagedInstance] or AzureOperationPoller[ClientRawResponse[ManagedInstance]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available SQL Rest API operations.
- Parameters
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Operation
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ServerKeysOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerKeysOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
create_or_update
(resource_group_name, server_name, key_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a server key.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
key_name (str) – The name of the server key to be operated on (updated or created). The key name is required to be in the format of ‘vault_key_version’. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/01234567890123456789012345678901, then the server key name should be formatted as: YourVaultName_YourKeyName_01234567890123456789012345678901
parameters (ServerKey) – The requested server key resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ServerKey or ClientRawResponse<ServerKey> if raw==True
- Return type
AzureOperationPoller[ServerKey] or AzureOperationPoller[ClientRawResponse[ServerKey]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, key_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes the server key with the given name.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
key_name (str) – The name of the server key to be deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, key_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a server key.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
key_name (str) – The name of the server key to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerKey or ClientRawResponse if raw=true
- Return type
ServerKey or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of server keys.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ServerKey
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
SyncAgentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SyncAgentsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
create_or_update
(resource_group_name, server_name, sync_agent_name, sync_database_id=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a sync agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
sync_database_id (str) – ARM resource id of the sync database in the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns SyncAgent or ClientRawResponse<SyncAgent> if raw==True
- Return type
AzureOperationPoller[SyncAgent] or AzureOperationPoller[ClientRawResponse[SyncAgent]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, sync_agent_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a sync agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
generate_key
(resource_group_name, server_name, sync_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶ Generates a sync agent key.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SyncAgentKeyProperties or ClientRawResponse if raw=true
- Return type
SyncAgentKeyProperties or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, sync_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a sync agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SyncAgent or ClientRawResponse if raw=true
- Return type
SyncAgent or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists sync agents in a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SyncAgent
- Return type
- Raises
CloudError
-
list_linked_databases
(resource_group_name, server_name, sync_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists databases linked to a sync agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server on which the sync agent is hosted.
sync_agent_name (str) – The name of the sync agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SyncAgentLinkedDatabase
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
SyncGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SyncGroupsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
cancel_sync
(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Cancels a sync group synchronization.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
create_or_update
(resource_group_name, server_name, database_name, sync_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
parameters (SyncGroup) – The requested sync group resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns SyncGroup or ClientRawResponse<SyncGroup> if raw==True
- Return type
AzureOperationPoller[SyncGroup] or AzureOperationPoller[ClientRawResponse[SyncGroup]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SyncGroup or ClientRawResponse if raw=true
- Return type
SyncGroup or ClientRawResponse
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists sync groups under a hub database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SyncGroup
- Return type
- Raises
CloudError
-
list_hub_schemas
(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a collection of hub database schemas.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SyncFullSchemaProperties
- Return type
- Raises
CloudError
-
list_logs
(resource_group_name, server_name, database_name, sync_group_name, start_time, end_time, type, continuation_token=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a collection of sync group logs.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
start_time (str) – Get logs generated after this time.
end_time (str) – Get logs generated before this time.
type (str) – The types of logs to retrieve. Possible values include: ‘All’, ‘Error’, ‘Warning’, ‘Success’
continuation_token (str) – The continuation token for this operation.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SyncGroupLogProperties
- Return type
- Raises
CloudError
-
list_sync_database_ids
(location_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a collection of sync database ids.
- Parameters
location_name (str) – The name of the region where the resource is located.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SyncDatabaseIdProperties
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
refresh_hub_schema
(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Refreshes a hub database schema.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
trigger_sync
(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Triggers a sync group synchronization.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
update
(resource_group_name, server_name, database_name, sync_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
parameters (SyncGroup) – The requested sync group resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns SyncGroup or ClientRawResponse<SyncGroup> if raw==True
- Return type
AzureOperationPoller[SyncGroup] or AzureOperationPoller[ClientRawResponse[SyncGroup]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
SyncMembersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SyncMembersOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
create_or_update
(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a sync member.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
parameters (SyncMember) – The requested sync member resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns SyncMember or ClientRawResponse<SyncMember> if raw==True
- Return type
AzureOperationPoller[SyncMember] or AzureOperationPoller[ClientRawResponse[SyncMember]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a sync member.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a sync member.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SyncMember or ClientRawResponse if raw=true
- Return type
SyncMember or ClientRawResponse
- Raises
CloudError
-
list_by_sync_group
(resource_group_name, server_name, database_name, sync_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists sync members in the given sync group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SyncMember
- Return type
- Raises
CloudError
-
list_member_schemas
(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a sync member database schema.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SyncFullSchemaProperties
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
refresh_member_schema
(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Refreshes a sync member database schema.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
update
(resource_group_name, server_name, database_name, sync_group_name, sync_member_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates an existing sync member.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database on which the sync group is hosted.
sync_group_name (str) – The name of the sync group on which the sync member is hosted.
sync_member_name (str) – The name of the sync member.
parameters (SyncMember) – The requested sync member resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns SyncMember or ClientRawResponse<SyncMember> if raw==True
- Return type
AzureOperationPoller[SyncMember] or AzureOperationPoller[ClientRawResponse[SyncMember]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
SubscriptionUsagesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
SubscriptionUsagesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
get
(location_name, usage_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a subscription usage metric.
- Parameters
location_name (str) – The name of the region where the resource is located.
usage_name (str) – Name of usage metric to return.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SubscriptionUsage or ClientRawResponse if raw=true
- Return type
SubscriptionUsage or ClientRawResponse
- Raises
CloudError
-
list_by_location
(location_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all subscription usage metrics in a given location.
- Parameters
location_name (str) – The name of the region where the resource is located.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SubscriptionUsage
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
VirtualNetworkRulesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
VirtualNetworkRulesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2015-05-01-preview”.
-
create_or_update
(resource_group_name, server_name, virtual_network_rule_name, virtual_network_subnet_id, ignore_missing_vnet_service_endpoint=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates an existing virtual network rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
virtual_network_rule_name (str) – The name of the virtual network rule.
virtual_network_subnet_id (str) – The ARM resource id of the virtual network subnet.
ignore_missing_vnet_service_endpoint (bool) – Create firewall rule before the virtual network has vnet service endpoint enabled.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns VirtualNetworkRule or ClientRawResponse<VirtualNetworkRule> if raw==True
- Return type
AzureOperationPoller[VirtualNetworkRule] or AzureOperationPoller[ClientRawResponse[VirtualNetworkRule]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, virtual_network_rule_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes the virtual network rule with the given name.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
virtual_network_rule_name (str) – The name of the virtual network rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, virtual_network_rule_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a virtual network rule.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
virtual_network_rule_name (str) – The name of the virtual network rule.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
VirtualNetworkRule or ClientRawResponse if raw=true
- Return type
VirtualNetworkRule or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of virtual network rules in a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of VirtualNetworkRule
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabaseVulnerabilityAssessmentRuleBaselinesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabaseVulnerabilityAssessmentRuleBaselinesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
baseline_name – The name of the vulnerability assessment rule baseline. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create_or_update
(resource_group_name, server_name, database_name, rule_id, baseline_results, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
baseline_results (list[DatabaseVulnerabilityAssessmentRuleBaselineItem]) – The rule baseline result
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse if raw=true
- Return type
DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, server_name, database_name, rule_id, custom_headers=None, raw=False, **operation_config)[source]¶ Removes the database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, rule_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database’s vulnerability assessment rule baseline.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment rule baseline is defined.
rule_id (str) – The vulnerability assessment rule ID.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse if raw=true
- Return type
DatabaseVulnerabilityAssessmentRuleBaseline or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabaseVulnerabilityAssessmentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabaseVulnerabilityAssessmentsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create_or_update
(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
parameters (DatabaseVulnerabilityAssessment) – The requested resource.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseVulnerabilityAssessment or ClientRawResponse if raw=true
- Return type
DatabaseVulnerabilityAssessment or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Removes the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the database’s vulnerability assessment.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database for which the vulnerability assessment is defined.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseVulnerabilityAssessment or ClientRawResponse if raw=true
- Return type
DatabaseVulnerabilityAssessment or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
JobAgentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobAgentsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create_or_update
(resource_group_name, server_name, job_agent_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a job agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be created or updated.
parameters (JobAgent) – The requested job agent resource state.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns JobAgent or ClientRawResponse<JobAgent> if raw==True
- Return type
AzureOperationPoller[JobAgent] or AzureOperationPoller[ClientRawResponse[JobAgent]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a job agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be deleted.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a job agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be retrieved.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobAgent or ClientRawResponse if raw=true
- Return type
JobAgent or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of job agents in a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobAgent
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, server_name, job_agent_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a job agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent to be updated.
tags (dict[str, str]) – Resource tags.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns JobAgent or ClientRawResponse<JobAgent> if raw==True
- Return type
AzureOperationPoller[JobAgent] or AzureOperationPoller[ClientRawResponse[JobAgent]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
JobCredentialsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobCredentialsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create_or_update
(resource_group_name, server_name, job_agent_name, credential_name, username, password, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a job credential.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
username (str) – The credential user name.
password (str) – The credential password.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobCredential or ClientRawResponse if raw=true
- Return type
JobCredential or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, server_name, job_agent_name, credential_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a job credential.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, job_agent_name, credential_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a jobs credential.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
credential_name (str) – The name of the credential.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobCredential or ClientRawResponse if raw=true
- Return type
JobCredential or ClientRawResponse
- Raises
CloudError
-
list_by_agent
(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of jobs credentials.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobCredential
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
JobExecutionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobExecutionsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
cancel
(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers=None, raw=False, **operation_config)[source]¶ Requests cancellation of a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_execution_id (str) – The id of the job execution to cancel.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
create
(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Starts an elastic job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns JobExecution or ClientRawResponse<JobExecution> if raw==True
- Return type
AzureOperationPoller[JobExecution] or AzureOperationPoller[ClientRawResponse[JobExecution]]
- Raises
CloudError
-
create_or_update
(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updatess a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The job execution id to create the job execution under.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns JobExecution or ClientRawResponse<JobExecution> if raw==True
- Return type
AzureOperationPoller[JobExecution] or AzureOperationPoller[ClientRawResponse[JobExecution]]
- Raises
CloudError
-
get
(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_execution_id (str) – The id of the job execution
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobExecution or ClientRawResponse if raw=true
- Return type
JobExecution or ClientRawResponse
- Raises
CloudError
-
list_by_agent
(resource_group_name, server_name, job_agent_name, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all executions in a job agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobExecution
- Return type
- Raises
CloudError
-
list_by_job
(resource_group_name, server_name, job_agent_name, job_name, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists a job’s executions.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobExecution
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
JobsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create_or_update
(resource_group_name, server_name, job_agent_name, job_name, description='', schedule=None, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a job.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
description (str) – User-defined description of the job.
schedule (JobSchedule) – Schedule properties of the job.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Job or ClientRawResponse if raw=true
- Return type
Job or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a job.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to delete.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a job.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
Job or ClientRawResponse if raw=true
- Return type
Job or ClientRawResponse
- Raises
CloudError
-
list_by_agent
(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of jobs.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of Job
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
JobStepExecutionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobStepExecutionsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
get
(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a step execution of a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The unique id of the job execution
step_name (str) – The name of the step.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobExecution or ClientRawResponse if raw=true
- Return type
JobExecution or ClientRawResponse
- Raises
CloudError
-
list_by_job_execution
(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the step executions of a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobExecution
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
JobStepsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobStepsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create_or_update
(resource_group_name, server_name, job_agent_name, job_name, step_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a job step. This will implicitly create a new job version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step.
parameters (JobStep) – The requested state of the job step.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobStep or ClientRawResponse if raw=true
- Return type
JobStep or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a job step. This will implicitly create a new job version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step to delete.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, job_agent_name, job_name, step_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a job step in a job’s current version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
step_name (str) – The name of the job step.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobStep or ClientRawResponse if raw=true
- Return type
JobStep or ClientRawResponse
- Raises
CloudError
-
get_by_version
(resource_group_name, server_name, job_agent_name, job_name, job_version, step_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the specified version of a job step.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_version (int) – The version of the job to get.
step_name (str) – The name of the job step.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobStep or ClientRawResponse if raw=true
- Return type
JobStep or ClientRawResponse
- Raises
CloudError
-
list_by_job
(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all job steps for a job’s current version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobStep
- Return type
- Raises
CloudError
-
list_by_version
(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all job steps in the specified job version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_version (int) – The version of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobStep
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
JobTargetExecutionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobTargetExecutionsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
get
(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, target_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a target execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The unique id of the job execution
step_name (str) – The name of the step.
target_id (str) – The target id.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobExecution or ClientRawResponse if raw=true
- Return type
JobExecution or ClientRawResponse
- Raises
CloudError
-
list_by_job_execution
(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists target executions for all steps of a job execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobExecution
- Return type
- Raises
CloudError
-
list_by_step
(resource_group_name, server_name, job_agent_name, job_name, job_execution_id, step_name, create_time_min=None, create_time_max=None, end_time_min=None, end_time_max=None, is_active=None, skip=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the target executions of a job step execution.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
job_execution_id (str) – The id of the job execution
step_name (str) – The name of the step.
create_time_min (datetime) – If specified, only job executions created at or after the specified time are included.
create_time_max (datetime) – If specified, only job executions created before the specified time are included.
end_time_min (datetime) – If specified, only job executions completed at or after the specified time are included.
end_time_max (datetime) – If specified, only job executions completed before the specified time are included.
is_active (bool) – If specified, only active or only completed job executions are included.
skip (int) – The number of elements in the collection to skip.
top (int) – The number of elements to return from the collection.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobExecution
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
JobTargetGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobTargetGroupsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create_or_update
(resource_group_name, server_name, job_agent_name, target_group_name, members, custom_headers=None, raw=False, **operation_config)[source]¶ Creates or updates a target group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
members (list[JobTarget]) – Members of the target group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobTargetGroup or ClientRawResponse if raw=true
- Return type
JobTargetGroup or ClientRawResponse
- Raises
CloudError
-
delete
(resource_group_name, server_name, job_agent_name, target_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a target group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, job_agent_name, target_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a target group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
target_group_name (str) – The name of the target group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobTargetGroup or ClientRawResponse if raw=true
- Return type
JobTargetGroup or ClientRawResponse
- Raises
CloudError
-
list_by_agent
(resource_group_name, server_name, job_agent_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all target groups in an agent.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobTargetGroup
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
JobVersionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobVersionsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
get
(resource_group_name, server_name, job_agent_name, job_name, job_version, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a job version.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job.
job_version (int) – The version of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
JobVersion or ClientRawResponse if raw=true
- Return type
JobVersion or ClientRawResponse
- Raises
CloudError
-
list_by_job
(resource_group_name, server_name, job_agent_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets all versions of a job.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
job_agent_name (str) – The name of the job agent.
job_name (str) – The name of the job to get.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of JobVersion
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
LongTermRetentionBackupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
LongTermRetentionBackupsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
delete
(location_name, long_term_retention_server_name, long_term_retention_database_name, backup_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a long term retention backup.
- Parameters
location_name (str) – The location of the database
long_term_retention_server_name (str) –
long_term_retention_database_name (str) –
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(location_name, long_term_retention_server_name, long_term_retention_database_name, backup_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a long term retention backup.
- Parameters
location_name (str) – The location of the database.
long_term_retention_server_name (str) –
long_term_retention_database_name (str) –
backup_name (str) – The backup name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
LongTermRetentionBackup or ClientRawResponse if raw=true
- Return type
LongTermRetentionBackup or ClientRawResponse
- Raises
CloudError
-
list_by_database
(location_name, long_term_retention_server_name, long_term_retention_database_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all long term retention backups for a database.
- Parameters
location_name (str) – The location of the database
long_term_retention_server_name (str) –
long_term_retention_database_name (str) –
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of LongTermRetentionBackup
- Return type
- Raises
CloudError
-
list_by_location
(location_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the long term retention backups for a given location.
- Parameters
location_name (str) – The location of the database
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of LongTermRetentionBackup
- Return type
- Raises
CloudError
-
list_by_server
(location_name, long_term_retention_server_name, only_latest_per_database=None, database_state=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the long term retention backups for a given server.
- Parameters
location_name (str) – The location of the database
long_term_retention_server_name (str) –
only_latest_per_database (bool) – Whether or not to only get the latest backup for each database.
database_state (str or LongTermRetentionDatabaseState) – Whether to query against just live databases, just deleted databases, or all databases. Possible values include: ‘All’, ‘Live’, ‘Deleted’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of LongTermRetentionBackup
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
BackupLongTermRetentionPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
BackupLongTermRetentionPoliciesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
policy_name – The policy name. Should always be Default. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create_or_update
(resource_group_name, server_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Sets a database’s long term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
parameters (BackupLongTermRetentionPolicy) – The long term retention policy info.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns BackupLongTermRetentionPolicy or ClientRawResponse<BackupLongTermRetentionPolicy> if raw==True
- Return type
AzureOperationPoller[BackupLongTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[BackupLongTermRetentionPolicy]]
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database’s long term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
BackupLongTermRetentionPolicy or ClientRawResponse if raw=true
- Return type
BackupLongTermRetentionPolicy or ClientRawResponse
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database’s long term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
BackupLongTermRetentionPolicy or ClientRawResponse if raw=true
- Return type
BackupLongTermRetentionPolicy or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ManagedDatabasesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ManagedDatabasesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
complete_restore
(location_name, operation_id, last_backup_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Completes the restore operation on a managed database.
- Parameters
location_name (str) – The name of the region where the resource is located.
operation_id (str) – Management operation id that this request tries to complete.
last_backup_name (str) – The last backup name to apply
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
create_or_update
(resource_group_name, managed_instance_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a new database or updates an existing database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ManagedDatabase or ClientRawResponse<ManagedDatabase> if raw==True
- Return type
AzureOperationPoller[ManagedDatabase] or AzureOperationPoller[ClientRawResponse[ManagedDatabase]]
- Raises
CloudError
-
delete
(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes the 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, managed_instance_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a managed database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ManagedDatabase or ClientRawResponse if raw=true
- Return type
ManagedDatabase or ClientRawResponse
- Raises
CloudError
-
list_by_instance
(resource_group_name, managed_instance_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of managed databases.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
managed_instance_name (str) – The name of the managed instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ManagedDatabase
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, managed_instance_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates an existing database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ManagedDatabase or ClientRawResponse<ManagedDatabase> if raw==True
- Return type
AzureOperationPoller[ManagedDatabase] or AzureOperationPoller[ClientRawResponse[ManagedDatabase]]
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
ServerAutomaticTuningOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerAutomaticTuningOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
get
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Retrieves server automatic tuning options.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerAutomaticTuning or ClientRawResponse if raw=true
- Return type
ServerAutomaticTuning or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, server_name, desired_state=None, options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Update automatic tuning options on server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
desired_state (str or AutomaticTuningServerMode) – Automatic tuning desired state. Possible values include: ‘Custom’, ‘Auto’, ‘Unspecified’
options (dict[str, AutomaticTuningServerOptions]) – Automatic tuning options definition.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerAutomaticTuning or ClientRawResponse if raw=true
- Return type
ServerAutomaticTuning or ClientRawResponse
- Raises
CloudError
-
class
azure.mgmt.sql.operations.
ServerDnsAliasesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ServerDnsAliasesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
acquire
(resource_group_name, server_name, dns_alias_name, old_server_dns_alias_id=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Acquires server DNS alias from another server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server dns alias.
old_server_dns_alias_id (str) – The id of the server alias that will be acquired to point to this server instead.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
create_or_update
(resource_group_name, server_name, dns_alias_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a server dns alias.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server DNS alias.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ServerDnsAlias or ClientRawResponse<ServerDnsAlias> if raw==True
- Return type
AzureOperationPoller[ServerDnsAlias] or AzureOperationPoller[ClientRawResponse[ServerDnsAlias]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, dns_alias_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes the server DNS alias with the given name.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server DNS alias.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get
(resource_group_name, server_name, dns_alias_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a server DNS alias.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
dns_alias_name (str) – The name of the server DNS alias.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ServerDnsAlias or ClientRawResponse if raw=true
- Return type
ServerDnsAlias or ClientRawResponse
- Raises
CloudError
-
list_by_server
(resource_group_name, server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of server DNS aliases for a server.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server that the alias is pointing to.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ServerDnsAlias
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
RestorePointsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
RestorePointsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-03-01-preview”.
-
create
(resource_group_name, server_name, database_name, restore_point_label, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a restore point for a data warehouse.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
restore_point_label (str) – The restore point label to apply
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns RestorePoint or ClientRawResponse<RestorePoint> if raw==True
- Return type
AzureOperationPoller[RestorePoint] or AzureOperationPoller[ClientRawResponse[RestorePoint]]
- Raises
CloudError
-
delete
(resource_group_name, server_name, database_name, restore_point_name, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes a restore point.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
restore_point_name (str) – The name of the restore point.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, restore_point_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a restore point.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
restore_point_name (str) – The name of the restore point.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RestorePoint or ClientRawResponse if raw=true
- Return type
RestorePoint or ClientRawResponse
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of database restore points.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RestorePoint
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabaseOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabaseOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.
-
cancel
(resource_group_name, server_name, database_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶ Cancels the asynchronous operation on the database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
operation_id (str) – The operation identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of operations performed on the database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of DatabaseOperation
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
ElasticPoolOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ElasticPoolOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.
-
cancel
(resource_group_name, server_name, elastic_pool_name, operation_id, custom_headers=None, raw=False, **operation_config)[source]¶ Cancels the asynchronous operation on the elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) –
operation_id (str) – The operation identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
CloudError
-
list_by_elastic_pool
(resource_group_name, server_name, elastic_pool_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of operations performed on the elastic pool.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
elastic_pool_name (str) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ElasticPoolOperation
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
CapabilitiesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
CapabilitiesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.
-
list_by_location
(location_name, include=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the subscription capabilities available for the specified location.
- Parameters
location_name (str) – The location name whose capabilities are retrieved.
include (str or CapabilityGroup) – If specified, restricts the response to only include the selected item. Possible values include: ‘supportedEditions’, ‘supportedElasticPoolEditions’, ‘supportedManagedInstanceVersions’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
LocationCapabilities or ClientRawResponse if raw=true
- Return type
LocationCapabilities or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
DatabaseVulnerabilityAssessmentScansOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
DatabaseVulnerabilityAssessmentScansOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
vulnerability_assessment_name – The name of the vulnerability assessment. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.
-
export
(resource_group_name, server_name, database_name, scan_id, custom_headers=None, raw=False, **operation_config)[source]¶ Convert an existing scan result to a human readable format. If already exists nothing happens.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the scanned database.
scan_id (str) – The vulnerability assessment scan Id.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DatabaseVulnerabilityAssessmentScansExport or ClientRawResponse if raw=true
- Return type
DatabaseVulnerabilityAssessmentScansExport or ClientRawResponse
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, scan_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a vulnerability assessment scan record of a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
VulnerabilityAssessmentScanRecord or ClientRawResponse if raw=true
- Return type
VulnerabilityAssessmentScanRecord or ClientRawResponse
- Raises
CloudError
-
initiate_scan
(resource_group_name, server_name, database_name, scan_id, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Executes a Vulnerability Assessment database scan.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
scan_id (str) – The vulnerability assessment scan Id of the scan to retrieve.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
list_by_database
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the vulnerability assessment scans of a database.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of VulnerabilityAssessmentScanRecord
- Return type
VulnerabilityAssessmentScanRecordPaged[VulnerabilityAssessmentScanRecord]
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
InstanceFailoverGroupsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
InstanceFailoverGroupsOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.
-
create_or_update
(resource_group_name, location_name, failover_group_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
parameters (InstanceFailoverGroup) – The failover group parameters.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns InstanceFailoverGroup or ClientRawResponse<InstanceFailoverGroup> if raw==True
- Return type
AzureOperationPoller[InstanceFailoverGroup] or AzureOperationPoller[ClientRawResponse[InstanceFailoverGroup]]
- Raises
CloudError
-
delete
(resource_group_name, location_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
failover
(resource_group_name, location_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Fails over from the current primary managed instance to this managed instance.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns InstanceFailoverGroup or ClientRawResponse<InstanceFailoverGroup> if raw==True
- Return type
AzureOperationPoller[InstanceFailoverGroup] or AzureOperationPoller[ClientRawResponse[InstanceFailoverGroup]]
- Raises
CloudError
-
force_failover_allow_data_loss
(resource_group_name, location_name, failover_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Fails over from the current primary managed instance to this managed instance. This operation might result in data loss.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns InstanceFailoverGroup or ClientRawResponse<InstanceFailoverGroup> if raw==True
- Return type
AzureOperationPoller[InstanceFailoverGroup] or AzureOperationPoller[ClientRawResponse[InstanceFailoverGroup]]
- Raises
CloudError
-
get
(resource_group_name, location_name, failover_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a failover group.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
failover_group_name (str) – The name of the failover group.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
InstanceFailoverGroup or ClientRawResponse if raw=true
- Return type
InstanceFailoverGroup or ClientRawResponse
- Raises
CloudError
-
list_by_location
(resource_group_name, location_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the failover groups in a location.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
location_name (str) – The name of the region where the resource is located.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of InstanceFailoverGroup
- Return type
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
class
azure.mgmt.sql.operations.
BackupShortTermRetentionPoliciesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
BackupShortTermRetentionPoliciesOperations operations.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
policy_name – The policy name. Should always be “default”. Constant value: “default”.
api_version – The API version to use for the request. Constant value: “2017-10-01-preview”.
-
create_or_update
(resource_group_name, server_name, database_name, retention_days=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns BackupShortTermRetentionPolicy or ClientRawResponse<BackupShortTermRetentionPolicy> if raw==True
- Return type
AzureOperationPoller[BackupShortTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[BackupShortTermRetentionPolicy]]
- Raises
CloudError
-
get
(resource_group_name, server_name, database_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
BackupShortTermRetentionPolicy or ClientRawResponse if raw=true
- Return type
BackupShortTermRetentionPolicy or ClientRawResponse
- Raises
CloudError
-
models
= <module 'azure.mgmt.sql.models' from '/usr/lib/python3.8/site-packages/azure/mgmt/sql/models/__init__.py'>¶
-
update
(resource_group_name, server_name, database_name, retention_days=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates a database’s short term retention policy.
- Parameters
resource_group_name (str) – The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name (str) – The name of the server.
database_name (str) – The name of the database.
retention_days (int) – The backup retention period in days. This is how many days Point-in-Time Restore will be supported.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns BackupShortTermRetentionPolicy or ClientRawResponse<BackupShortTermRetentionPolicy> if raw==True
- Return type
AzureOperationPoller[BackupShortTermRetentionPolicy] or AzureOperationPoller[ClientRawResponse[BackupShortTermRetentionPolicy]]
- Raises
CloudError