azure.mgmt.sqlvirtualmachine.models module¶

class azure.mgmt.sqlvirtualmachine.models.AdditionalFeaturesServerConfigurations(*, is_rservices_enabled: bool = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Additional SQL Server feature settings.

Parameters: is_rservices_enabled (bool) – Enable or disable R services (SQL 2016 onwards).

class azure.mgmt.sqlvirtualmachine.models.AutoBackupSettings(*, enable: bool = None, enable_encryption: bool = None, retention_period: int = None, storage_account_url: str = None, storage_access_key: str = None, password: str = None, backup_system_dbs: bool = None, backup_schedule_type=None, full_backup_frequency=None, full_backup_start_time: int = None, full_backup_window_hours: int = None, log_backup_frequency: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Configure backups for databases in your SQL virtual machine.

Parameters

enable (bool) – Enable or disable autobackup on SQL virtual machine.
enable_encryption (bool) – Enable or disable encryption for backup on SQL virtual machine.
retention_period (int) – Retention period of backup: 1-30 days.
storage_account_url (str) – Storage account url where backup will be taken to.
storage_access_key (str) – Storage account key where backup will be taken to.
password (str) – Password for encryption on backup.
backup_system_dbs (bool) – Include or exclude system databases from auto backup.
backup_schedule_type (str or BackupScheduleType) – Backup schedule type. Possible values include: ‘Manual’, ‘Automated’
full_backup_frequency (str or FullBackupFrequencyType) – Frequency of full backups. In both cases, full backups begin during the next scheduled time window. Possible values include: ‘Daily’, ‘Weekly’
full_backup_start_time (int) – Start time of a given day during which full backups can take place. 0-23 hours.
full_backup_window_hours (int) – Duration of the time window of a given day during which full backups can take place. 1-23 hours.
log_backup_frequency (int) – Frequency of log backups. 5-60 minutes.

class azure.mgmt.sqlvirtualmachine.models.AutoPatchingSettings(*, enable: bool = None, day_of_week=None, maintenance_window_starting_hour: int = None, maintenance_window_duration: int = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Set a patching window during which Windows and SQL patches will be applied.

Parameters

enable (bool) – Enable or disable autopatching on SQL virtual machine.
day_of_week (str or DayOfWeek) – Day of week to apply the patch on. Possible values include: ‘Monday’, ‘Tuesday’, ‘Wednesday’, ‘Thursday’, ‘Friday’, ‘Saturday’, ‘Sunday’
maintenance_window_starting_hour (int) – Hour of the day when patching is initiated. Local VM time.
maintenance_window_duration (int) – Duration of patching.

class azure.mgmt.sqlvirtualmachine.models.AvailabilityGroupListener(*, availability_group_name: str = None, load_balancer_configurations=None, create_default_availability_group_if_not_exist: bool = None, port: int = None, **kwargs)[source]¶

Bases: azure.mgmt.sqlvirtualmachine.models._models_py3.ProxyResource

A SQL Server availability group listener.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
provisioning_state (str) – Provisioning state to track the async operation status.

Parameters

availability_group_name (str) – Name of the availability group.
load_balancer_configurations (list[LoadBalancerConfiguration]) – List of load balancer configurations for an availability group listener.
create_default_availability_group_if_not_exist (bool) – Create a default availability group if it does not exist.
port (int) – Listener port.

class azure.mgmt.sqlvirtualmachine.models.KeyVaultCredentialSettings(*, enable: bool = None, credential_name: str = None, azure_key_vault_url: str = None, service_principal_name: str = None, service_principal_secret: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.

Parameters

enable (bool) – Enable or disable key vault credential setting.
credential_name (str) – Credential name.
azure_key_vault_url (str) – Azure Key Vault url.
service_principal_name (str) – Service principal name to access key vault.
service_principal_secret (str) – Service principal name secret to access key vault.

class azure.mgmt.sqlvirtualmachine.models.LoadBalancerConfiguration(*, private_ip_address=None, public_ip_address_resource_id: str = None, load_balancer_resource_id: str = None, probe_port: int = None, sql_virtual_machine_instances=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A load balancer configuration for an availability group listener.

Parameters

private_ip_address (PrivateIPAddress) – Private IP address.
public_ip_address_resource_id (str) – Resource id of the public IP.
load_balancer_resource_id (str) – Resource id of the load balancer.
probe_port (int) – Probe port.
sql_virtual_machine_instances (list[str]) – List of the SQL virtual machine instance resource id’s that are enrolled into the availability group listener.

class azure.mgmt.sqlvirtualmachine.models.Operation(**kwargs)[source]¶

Bases: msrest.serialization.Model

SQL REST API operation definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The name of the operation being performed on this particular object.
display (OperationDisplay) – The localized display information for this particular operation / action.
origin (str or OperationOrigin) – The intended executor of the operation. Possible values include: ‘user’, ‘system’
properties (dict[str, object]) – Additional descriptions for the operation.

class azure.mgmt.sqlvirtualmachine.models.OperationDisplay(**kwargs)[source]¶

Bases: msrest.serialization.Model

Display metadata associated with the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provider (str) – The localized friendly form of the resource provider name.
resource (str) – The localized friendly form of the resource type related to this action/operation.
operation (str) – The localized friendly name for the operation.
description (str) – The localized friendly description for the operation.

class azure.mgmt.sqlvirtualmachine.models.PrivateIPAddress(*, ip_address: str = None, subnet_resource_id: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A private IP address bound to the availability group listener.

Parameters

ip_address (str) – Private IP address bound to the availability group listener.
subnet_resource_id (str) – Subnet used to include private IP.

class azure.mgmt.sqlvirtualmachine.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.sqlvirtualmachine.models._models_py3.Resource

ARM proxy resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.sqlvirtualmachine.models.Resource(**kwargs)[source]¶

Bases: msrest.serialization.Model

ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

class azure.mgmt.sqlvirtualmachine.models.ResourceIdentity(*, type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Azure Active Directory identity configuration for a resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

principal_id (str) – The Azure Active Directory principal id.
tenant_id (str) – The Azure Active Directory tenant id.

Parameters

type (str or IdentityType) – The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource. Possible values include: ‘SystemAssigned’

class azure.mgmt.sqlvirtualmachine.models.ServerConfigurationsManagementSettings(*, sql_connectivity_update_settings=None, sql_workload_type_update_settings=None, sql_storage_update_settings=None, additional_features_server_configurations=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Set the connectivity, storage and workload settings.

Parameters

sql_connectivity_update_settings (SqlConnectivityUpdateSettings) – SQL connectivity type settings.
sql_workload_type_update_settings (SqlWorkloadTypeUpdateSettings) – SQL workload type settings.
sql_storage_update_settings (SqlStorageUpdateSettings) – SQL storage update settings.
additional_features_server_configurations (AdditionalFeaturesServerConfigurations) – Additional SQL feature settings.

class azure.mgmt.sqlvirtualmachine.models.SqlConnectivityUpdateSettings(*, connectivity_type=None, port: int = None, sql_auth_update_user_name: str = None, sql_auth_update_password: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Set the access level and network port settings for SQL Server.

Parameters

connectivity_type (str or ConnectivityType) – SQL Server connectivity option. Possible values include: ‘LOCAL’, ‘PRIVATE’, ‘PUBLIC’
port (int) – SQL Server port.
sql_auth_update_user_name (str) – SQL Server sysadmin login to create.
sql_auth_update_password (str) – SQL Server sysadmin login password.

class azure.mgmt.sqlvirtualmachine.models.SQLStorageSettings(*, luns=None, default_file_path: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Set disk storage settings for SQL Server.

Parameters

luns (list[int]) – Logical Unit Numbers for the disks.
default_file_path (str) – SQL Server default file path

class azure.mgmt.sqlvirtualmachine.models.SqlStorageUpdateSettings(*, disk_count: int = None, starting_device_id: int = None, disk_configuration_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Set disk storage settings for SQL Server.

Parameters

disk_count (int) – Virtual machine disk count.
starting_device_id (int) – Device id of the first disk to be updated.
disk_configuration_type (str or DiskConfigurationType) – Disk configuration to apply to SQL Server. Possible values include: ‘NEW’, ‘EXTEND’, ‘ADD’

class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachine(*, location: str, tags=None, identity=None, virtual_machine_resource_id: str = None, sql_image_offer: str = None, sql_server_license_type=None, sql_management=None, sql_image_sku=None, sql_virtual_machine_group_resource_id: str = None, wsfc_domain_credentials=None, auto_patching_settings=None, auto_backup_settings=None, key_vault_credential_settings=None, server_configurations_management_settings=None, storage_configuration_settings=None, **kwargs)[source]¶

Bases: azure.mgmt.sqlvirtualmachine.models._models_py3.TrackedResource

A SQL virtual machine.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
provisioning_state (str) – Provisioning state to track the async operation status.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – Resource tags.
identity (ResourceIdentity) – Azure Active Directory identity of the server.
virtual_machine_resource_id (str) – ARM Resource id of underlying virtual machine created from SQL marketplace image.
sql_image_offer (str) – SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.
sql_server_license_type (str or SqlServerLicenseType) – SQL Server license type. Possible values include: ‘PAYG’, ‘AHUB’, ‘DR’
sql_management (str or SqlManagementMode) – SQL Server Management type. Possible values include: ‘Full’, ‘LightWeight’, ‘NoAgent’
sql_image_sku (str or SqlImageSku) – SQL Server edition type. Possible values include: ‘Developer’, ‘Express’, ‘Standard’, ‘Enterprise’, ‘Web’
sql_virtual_machine_group_resource_id (str) – ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.
wsfc_domain_credentials (WsfcDomainCredentials) – Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.
auto_patching_settings (AutoPatchingSettings) – Auto patching settings for applying critical security updates to SQL virtual machine.
auto_backup_settings (AutoBackupSettings) – Auto backup settings for SQL Server.
key_vault_credential_settings (KeyVaultCredentialSettings) – Key vault credential settings.
server_configurations_management_settings (ServerConfigurationsManagementSettings) – SQL Server configuration management settings.
storage_configuration_settings (StorageConfigurationSettings) – Storage Configuration Settings.

class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachineGroup(*, location: str, tags=None, sql_image_offer: str = None, sql_image_sku=None, wsfc_domain_profile=None, **kwargs)[source]¶

Bases: azure.mgmt.sqlvirtualmachine.models._models_py3.TrackedResource

A SQL virtual machine group.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
provisioning_state (str) – Provisioning state to track the async operation status.
scale_type (str or ScaleType) – Scale type. Possible values include: ‘HA’
cluster_manager_type (str or ClusterManagerType) – Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. Possible values include: ‘WSFC’
cluster_configuration (str or ClusterConfiguration) – Cluster type. Possible values include: ‘Domainful’

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – Resource tags.
sql_image_offer (str) – SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.
sql_image_sku (str or SqlVmGroupImageSku) – SQL image sku. Possible values include: ‘Developer’, ‘Enterprise’
wsfc_domain_profile (WsfcDomainProfile) – Cluster Active Directory domain profile.

class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachineGroupUpdate(*, tags=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An update to a SQL virtual machine group.

Parameters: tags (dict[str, str]) – Resource tags.

class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachineUpdate(*, tags=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An update to a SQL virtual machine.

Parameters: tags (dict[str, str]) – Resource tags.

class azure.mgmt.sqlvirtualmachine.models.SqlWorkloadTypeUpdateSettings(*, sql_workload_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Set workload type to optimize storage for SQL Server.

Parameters: sql_workload_type (str or SqlWorkloadType) – SQL Server workload type. Possible values include: ‘GENERAL’, ‘OLTP’, ‘DW’

class azure.mgmt.sqlvirtualmachine.models.StorageConfigurationSettings(*, sql_data_settings=None, sql_log_settings=None, sql_temp_db_settings=None, disk_configuration_type=None, storage_workload_type=None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Storage Configurations for SQL Data, Log and TempDb.

Parameters

sql_data_settings (SQLStorageSettings) – SQL Server Data Storage Settings.
sql_log_settings (SQLStorageSettings) – SQL Server Log Storage Settings.
sql_temp_db_settings (SQLStorageSettings) – SQL Server TempDb Storage Settings.
disk_configuration_type (str or DiskConfigurationType) – Disk configuration to apply to SQL Server. Possible values include: ‘NEW’, ‘EXTEND’, ‘ADD’
storage_workload_type (str or StorageWorkloadType) – Storage workload type. Possible values include: ‘GENERAL’, ‘OLTP’, ‘DW’

class azure.mgmt.sqlvirtualmachine.models.TrackedResource(*, location: str, tags=None, **kwargs)[source]¶

Bases: azure.mgmt.sqlvirtualmachine.models._models_py3.Resource

ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.

Parameters

location (str) – Required. Resource location.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.sqlvirtualmachine.models.WsfcDomainCredentials(*, cluster_bootstrap_account_password: str = None, cluster_operator_account_password: str = None, sql_service_account_password: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.

Parameters

cluster_bootstrap_account_password (str) – Cluster bootstrap account password.
cluster_operator_account_password (str) – Cluster operator account password.
sql_service_account_password (str) – SQL service account password.

class azure.mgmt.sqlvirtualmachine.models.WsfcDomainProfile(*, domain_fqdn: str = None, ou_path: str = None, cluster_bootstrap_account: str = None, cluster_operator_account: str = None, sql_service_account: str = None, file_share_witness_path: str = None, storage_account_url: str = None, storage_account_primary_key: str = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Active Directory account details to operate Windows Server Failover Cluster.

Parameters

domain_fqdn (str) – Fully qualified name of the domain.
ou_path (str) – Organizational Unit path in which the nodes and cluster will be present.
cluster_bootstrap_account (str) – Account name used for creating cluster (at minimum needs permissions to ‘Create Computer Objects’ in domain).
cluster_operator_account (str) – Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.
sql_service_account (str) – Account name under which SQL service will run on all participating SQL virtual machines in the cluster.
file_share_witness_path (str) – Optional path for fileshare witness.
storage_account_url (str) – Fully qualified ARM resource id of the witness storage account.
storage_account_primary_key (str) – Primary key of the witness storage account.

class azure.mgmt.sqlvirtualmachine.models.AvailabilityGroupListenerPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of AvailabilityGroupListener object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.sqlvirtualmachine.models.OperationPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachineGroupPaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of SqlVirtualMachineGroup object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachinePaged(*args, **kwargs)[source]¶

Bases: msrest.paging.Paged

A paging container for iterating over a list of SqlVirtualMachine object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.sqlvirtualmachine.models.OperationOrigin[source]¶

Bases: str, enum.Enum

An enumeration.

system = 'system'¶

user = 'user'¶

class azure.mgmt.sqlvirtualmachine.models.SqlVmGroupImageSku[source]¶

Bases: str, enum.Enum

An enumeration.

developer = 'Developer'¶

enterprise = 'Enterprise'¶

class azure.mgmt.sqlvirtualmachine.models.ScaleType[source]¶

Bases: str, enum.Enum

An enumeration.

ha = 'HA'¶

class azure.mgmt.sqlvirtualmachine.models.ClusterManagerType[source]¶

Bases: str, enum.Enum

An enumeration.

wsfc = 'WSFC'¶

class azure.mgmt.sqlvirtualmachine.models.ClusterConfiguration[source]¶

Bases: str, enum.Enum

An enumeration.

domainful = 'Domainful'¶

class azure.mgmt.sqlvirtualmachine.models.IdentityType[source]¶

Bases: str, enum.Enum

An enumeration.

system_assigned = 'SystemAssigned'¶

class azure.mgmt.sqlvirtualmachine.models.SqlServerLicenseType[source]¶

Bases: str, enum.Enum

An enumeration.

ahub = 'AHUB'¶

dr = 'DR'¶

payg = 'PAYG'¶

class azure.mgmt.sqlvirtualmachine.models.SqlManagementMode[source]¶

Bases: str, enum.Enum

An enumeration.

full = 'Full'¶

light_weight = 'LightWeight'¶

no_agent = 'NoAgent'¶

class azure.mgmt.sqlvirtualmachine.models.SqlImageSku[source]¶

Bases: str, enum.Enum

An enumeration.

developer = 'Developer'¶

enterprise = 'Enterprise'¶

express = 'Express'¶

standard = 'Standard'¶

web = 'Web'¶

class azure.mgmt.sqlvirtualmachine.models.DayOfWeek[source]¶

Bases: str, enum.Enum

An enumeration.

friday = 'Friday'¶

monday = 'Monday'¶

saturday = 'Saturday'¶

sunday = 'Sunday'¶

thursday = 'Thursday'¶

tuesday = 'Tuesday'¶

wednesday = 'Wednesday'¶

class azure.mgmt.sqlvirtualmachine.models.BackupScheduleType[source]¶

Bases: str, enum.Enum

An enumeration.

automated = 'Automated'¶

manual = 'Manual'¶

class azure.mgmt.sqlvirtualmachine.models.FullBackupFrequencyType[source]¶

Bases: str, enum.Enum

An enumeration.

daily = 'Daily'¶

weekly = 'Weekly'¶

class azure.mgmt.sqlvirtualmachine.models.ConnectivityType[source]¶

Bases: str, enum.Enum

An enumeration.

local = 'LOCAL'¶

private = 'PRIVATE'¶

public = 'PUBLIC'¶

class azure.mgmt.sqlvirtualmachine.models.SqlWorkloadType[source]¶

Bases: str, enum.Enum

An enumeration.

dw = 'DW'¶

general = 'GENERAL'¶

oltp = 'OLTP'¶

class azure.mgmt.sqlvirtualmachine.models.DiskConfigurationType[source]¶

Bases: str, enum.Enum

An enumeration.

add = 'ADD'¶

extend = 'EXTEND'¶

new = 'NEW'¶

class azure.mgmt.sqlvirtualmachine.models.StorageWorkloadType[source]¶

Bases: str, enum.Enum

An enumeration.

dw = 'DW'¶

general = 'GENERAL'¶

oltp = 'OLTP'¶