azure.mgmt.sqlvirtualmachine.models module

class azure.mgmt.sqlvirtualmachine.models.AADAuthenticationSettings(*, client_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Enable AAD authentication for SQL VM.

Variables

client_id (str) – The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity.

Keyword Arguments

client_id (str) – The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity.

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

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Additional SQL Server feature settings.

Variables

is_r_services_enabled (bool) – Enable or disable R services (SQL 2016 onwards).

Keyword Arguments

is_r_services_enabled (bool) – Enable or disable R services (SQL 2016 onwards).

class azure.mgmt.sqlvirtualmachine.models.AgConfiguration(*, replicas: Optional[List[_models.AgReplica]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Availability group configuration.

Variables

replicas (list[AgReplica]) – Replica configurations.

Keyword Arguments

replicas (list[AgReplica]) – Replica configurations.

class azure.mgmt.sqlvirtualmachine.models.AgReplica(*, sql_virtual_machine_instance_id: Optional[str] = None, role: Optional[Union[str, _models.Role]] = None, commit: Optional[Union[str, _models.Commit]] = None, failover: Optional[Union[str, _models.Failover]] = None, readable_secondary: Optional[Union[str, _models.ReadableSecondary]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Availability group replica configuration.

Variables

  • sql_virtual_machine_instance_id (str) – Sql VirtualMachine Instance Id.

  • role (str or Role) – Replica Role in availability group. Known values are: “PRIMARY” and “SECONDARY”.

  • commit (str or Commit) – Replica commit mode in availability group. Known values are: “SYNCHRONOUS_COMMIT” and “ASYNCHRONOUS_COMMIT”.

  • failover (str or Failover) – Replica failover mode in availability group. Known values are: “AUTOMATIC” and “MANUAL”.

  • readable_secondary (str or ReadableSecondary) – Replica readable secondary mode in availability group. Known values are: “NO”, “ALL”, and “READ_ONLY”.

Keyword Arguments

  • sql_virtual_machine_instance_id (str) – Sql VirtualMachine Instance Id.

  • role (str or Role) – Replica Role in availability group. Known values are: “PRIMARY” and “SECONDARY”.

  • commit (str or Commit) – Replica commit mode in availability group. Known values are: “SYNCHRONOUS_COMMIT” and “ASYNCHRONOUS_COMMIT”.

  • failover (str or Failover) – Replica failover mode in availability group. Known values are: “AUTOMATIC” and “MANUAL”.

  • readable_secondary (str or ReadableSecondary) – Replica readable secondary mode in availability group. Known values are: “NO”, “ALL”, and “READ_ONLY”.

class azure.mgmt.sqlvirtualmachine.models.AssessmentDayOfWeek(value)[source]

Bases: str, enum.Enum

Day of the week to run assessment.

FRIDAY = 'Friday'
MONDAY = 'Monday'
SATURDAY = 'Saturday'
SUNDAY = 'Sunday'
THURSDAY = 'Thursday'
TUESDAY = 'Tuesday'
WEDNESDAY = 'Wednesday'
class azure.mgmt.sqlvirtualmachine.models.AssessmentSettings(*, enable: Optional[bool] = None, run_immediately: Optional[bool] = None, schedule: Optional[_models.Schedule] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Configure SQL best practices Assessment for databases in your SQL virtual machine.

Variables

  • enable (bool) – Enable or disable SQL best practices Assessment feature on SQL virtual machine.

  • run_immediately (bool) – Run SQL best practices Assessment immediately on SQL virtual machine.

  • schedule (Schedule) – Schedule for SQL best practices Assessment.

Keyword Arguments

  • enable (bool) – Enable or disable SQL best practices Assessment feature on SQL virtual machine.

  • run_immediately (bool) – Run SQL best practices Assessment immediately on SQL virtual machine.

  • schedule (Schedule) – Schedule for SQL best practices Assessment.

class azure.mgmt.sqlvirtualmachine.models.AutoBackupDaysOfWeek(value)[source]

Bases: str, enum.Enum

AutoBackupDaysOfWeek.

FRIDAY = 'Friday'
MONDAY = 'Monday'
SATURDAY = 'Saturday'
SUNDAY = 'Sunday'
THURSDAY = 'Thursday'
TUESDAY = 'Tuesday'
WEDNESDAY = 'Wednesday'
class azure.mgmt.sqlvirtualmachine.models.AutoBackupSettings(*, enable: Optional[bool] = None, enable_encryption: Optional[bool] = None, retention_period: Optional[int] = None, storage_account_url: Optional[str] = None, storage_container_name: Optional[str] = None, storage_access_key: Optional[str] = None, password: Optional[str] = None, backup_system_dbs: Optional[bool] = None, backup_schedule_type: Optional[Union[str, _models.BackupScheduleType]] = None, full_backup_frequency: Optional[Union[str, _models.FullBackupFrequencyType]] = None, days_of_week: Optional[List[Union[str, _models.AutoBackupDaysOfWeek]]] = None, full_backup_start_time: Optional[int] = None, full_backup_window_hours: Optional[int] = None, log_backup_frequency: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Configure backups for databases in your SQL virtual machine.

Variables

  • 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-90 days.

  • storage_account_url (str) – Storage account url where backup will be taken to.

  • storage_container_name (str) – Storage container name 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. Known values are: “Manual” and “Automated”.

  • full_backup_frequency (str or FullBackupFrequencyType) – Frequency of full backups. In both cases, full backups begin during the next scheduled time window. Known values are: “Daily” and “Weekly”.

  • days_of_week (list[str or AutoBackupDaysOfWeek]) – Days of the week for the backups when FullBackupFrequency is set to 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.

Keyword Arguments

  • 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-90 days.

  • storage_account_url (str) – Storage account url where backup will be taken to.

  • storage_container_name (str) – Storage container name 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. Known values are: “Manual” and “Automated”.

  • full_backup_frequency (str or FullBackupFrequencyType) – Frequency of full backups. In both cases, full backups begin during the next scheduled time window. Known values are: “Daily” and “Weekly”.

  • days_of_week (list[str or AutoBackupDaysOfWeek]) – Days of the week for the backups when FullBackupFrequency is set to 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: Optional[bool] = None, day_of_week: Optional[Union[str, _models.DayOfWeek]] = None, maintenance_window_starting_hour: Optional[int] = None, maintenance_window_duration: Optional[int] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

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

Variables

  • enable (bool) – Enable or disable autopatching on SQL virtual machine.

  • day_of_week (str or DayOfWeek) – Day of week to apply the patch on. Known values are: “Everyday”, “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

  • maintenance_window_starting_hour (int) – Hour of the day when patching is initiated. Local VM time.

  • maintenance_window_duration (int) – Duration of patching.

Keyword Arguments

  • enable (bool) – Enable or disable autopatching on SQL virtual machine.

  • day_of_week (str or DayOfWeek) – Day of week to apply the patch on. Known values are: “Everyday”, “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “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: Optional[str] = None, load_balancer_configurations: Optional[List[_models.LoadBalancerConfiguration]] = None, multi_subnet_ip_configurations: Optional[List[_models.MultiSubnetIpConfiguration]] = None, create_default_availability_group_if_not_exist: Optional[bool] = None, port: Optional[int] = None, availability_group_configuration: Optional[_models.AgConfiguration] = 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.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

  • provisioning_state (str) – Provisioning state to track the async operation status.

  • availability_group_name (str) – Name of the availability group.

  • load_balancer_configurations (list[LoadBalancerConfiguration]) – List of load balancer configurations for an availability group listener.

  • multi_subnet_ip_configurations (list[MultiSubnetIpConfiguration]) – List of multi subnet IP configurations for an AG listener.

  • create_default_availability_group_if_not_exist (bool) – Create a default availability group if it does not exist.

  • port (int) – Listener port.

  • availability_group_configuration (AgConfiguration) – Availability Group configuration.

Keyword Arguments

  • availability_group_name (str) – Name of the availability group.

  • load_balancer_configurations (list[LoadBalancerConfiguration]) – List of load balancer configurations for an availability group listener.

  • multi_subnet_ip_configurations (list[MultiSubnetIpConfiguration]) – List of multi subnet IP configurations for an AG listener.

  • create_default_availability_group_if_not_exist (bool) – Create a default availability group if it does not exist.

  • port (int) – Listener port.

  • availability_group_configuration (AgConfiguration) – Availability Group configuration.

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

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

A list of availability group listeners.

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

Variables
class azure.mgmt.sqlvirtualmachine.models.BackupScheduleType(value)[source]

Bases: str, enum.Enum

Backup schedule type.

AUTOMATED = 'Automated'
MANUAL = 'Manual'
class azure.mgmt.sqlvirtualmachine.models.ClusterConfiguration(value)[source]

Bases: str, enum.Enum

Cluster type.

DOMAINFUL = 'Domainful'
class azure.mgmt.sqlvirtualmachine.models.ClusterManagerType(value)[source]

Bases: str, enum.Enum

Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.

WSFC = 'WSFC'
class azure.mgmt.sqlvirtualmachine.models.ClusterSubnetType(value)[source]

Bases: str, enum.Enum

Cluster subnet type.

MULTI_SUBNET = 'MultiSubnet'
SINGLE_SUBNET = 'SingleSubnet'
class azure.mgmt.sqlvirtualmachine.models.Commit(value)[source]

Bases: str, enum.Enum

Replica commit mode in availability group.

ASYNCHRONOUS_COMMIT = 'ASYNCHRONOUS_COMMIT'
SYNCHRONOUS_COMMIT = 'SYNCHRONOUS_COMMIT'
class azure.mgmt.sqlvirtualmachine.models.ConnectivityType(value)[source]

Bases: str, enum.Enum

SQL Server connectivity option.

LOCAL = 'LOCAL'
PRIVATE = 'PRIVATE'
PUBLIC = 'PUBLIC'
class azure.mgmt.sqlvirtualmachine.models.CreatedByType(value)[source]

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.sqlvirtualmachine.models.DayOfWeek(value)[source]

Bases: str, enum.Enum

Day of week to apply the patch on.

EVERYDAY = 'Everyday'
FRIDAY = 'Friday'
MONDAY = 'Monday'
SATURDAY = 'Saturday'
SUNDAY = 'Sunday'
THURSDAY = 'Thursday'
TUESDAY = 'Tuesday'
WEDNESDAY = 'Wednesday'
class azure.mgmt.sqlvirtualmachine.models.DiskConfigurationType(value)[source]

Bases: str, enum.Enum

Disk configuration to apply to SQL Server.

ADD = 'ADD'
EXTEND = 'EXTEND'
NEW = 'NEW'
class azure.mgmt.sqlvirtualmachine.models.ErrorAdditionalInfo(**kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

The resource management error additional info.

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

Variables

  • type (str) – The additional info type.

  • info (JSON) – The additional info.

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

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

The error detail.

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

Variables
class azure.mgmt.sqlvirtualmachine.models.ErrorResponse(*, error: Optional[_models.ErrorDetail] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Variables

error (ErrorDetail) – The error object.

Keyword Arguments

error (ErrorDetail) – The error object.

class azure.mgmt.sqlvirtualmachine.models.Failover(value)[source]

Bases: str, enum.Enum

Replica failover mode in availability group.

AUTOMATIC = 'AUTOMATIC'
MANUAL = 'MANUAL'
class azure.mgmt.sqlvirtualmachine.models.FullBackupFrequencyType(value)[source]

Bases: str, enum.Enum

Frequency of full backups. In both cases, full backups begin during the next scheduled time window.

DAILY = 'Daily'
WEEKLY = 'Weekly'
class azure.mgmt.sqlvirtualmachine.models.IdentityType(value)[source]

Bases: str, enum.Enum

The identity type. Set this to ‘SystemAssigned’ in order to automatically create and assign an Azure Active Directory principal for the resource.

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

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

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

Variables

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

Keyword Arguments

  • 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.LeastPrivilegeMode(value)[source]

Bases: str, enum.Enum

SQL IaaS Agent least privilege mode.

ENABLED = 'Enabled'
NOT_SET = 'NotSet'
class azure.mgmt.sqlvirtualmachine.models.LoadBalancerConfiguration(*, private_ip_address: Optional[_models.PrivateIPAddress] = None, public_ip_address_resource_id: Optional[str] = None, load_balancer_resource_id: Optional[str] = None, probe_port: Optional[int] = None, sql_virtual_machine_instances: Optional[List[str]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

A load balancer configuration for an availability group listener.

Variables

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

Keyword Arguments

  • 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.MultiSubnetIpConfiguration(*, private_ip_address: _models.PrivateIPAddress, sql_virtual_machine_instance: str, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Multi subnet ip configuration for an availability group listener.

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

Variables

  • private_ip_address (PrivateIPAddress) – Private IP address. Required.

  • sql_virtual_machine_instance (str) – SQL virtual machine instance resource id that are enrolled into the availability group listener. Required.

Keyword Arguments

  • private_ip_address (PrivateIPAddress) – Private IP address. Required.

  • sql_virtual_machine_instance (str) – SQL virtual machine instance resource id that are enrolled into the availability group listener. Required.

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

Bases: azure.mgmt.sqlvirtualmachine._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. Known values are: “user” and “system”.

  • properties (dict[str, JSON]) – Additional descriptions for the operation.

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

Bases: azure.mgmt.sqlvirtualmachine._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.OperationListResult(**kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Result of the request to list SQL operations.

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

Variables

  • value (list[Operation]) – Array of results.

  • next_link (str) – Link to retrieve next page of results.

class azure.mgmt.sqlvirtualmachine.models.OperationOrigin(value)[source]

Bases: str, enum.Enum

The intended executor of the operation.

SYSTEM = 'system'
USER = 'user'
class azure.mgmt.sqlvirtualmachine.models.PrivateIPAddress(*, ip_address: Optional[str] = None, subnet_resource_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

A private IP address bound to the availability group listener.

Variables

  • ip_address (str) – Private IP address bound to the availability group listener.

  • subnet_resource_id (str) – Subnet used to include private IP.

Keyword Arguments

  • 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.ReadableSecondary(value)[source]

Bases: str, enum.Enum

Replica readable secondary mode in availability group.

ALL = 'ALL'
NO = 'NO'
READ_ONLY = 'READ_ONLY'
class azure.mgmt.sqlvirtualmachine.models.Resource(**kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._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: Optional[Union[str, _models.IdentityType]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._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.

  • 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. Known values are: “None” and “SystemAssigned”.

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

Keyword Arguments

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. Known values are: “None” and “SystemAssigned”.

class azure.mgmt.sqlvirtualmachine.models.Role(value)[source]

Bases: str, enum.Enum

Replica Role in availability group.

PRIMARY = 'PRIMARY'
SECONDARY = 'SECONDARY'
class azure.mgmt.sqlvirtualmachine.models.SQLInstanceSettings(*, collation: Optional[str] = None, max_dop: Optional[int] = None, is_optimize_for_ad_hoc_workloads_enabled: Optional[bool] = None, min_server_memory_mb: Optional[int] = None, max_server_memory_mb: Optional[int] = None, is_lpim_enabled: Optional[bool] = None, is_ifi_enabled: Optional[bool] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Set the server/instance-level settings for SQL Server.

Variables

  • collation (str) – SQL Server Collation.

  • max_dop (int) – SQL Server MAXDOP.

  • is_optimize_for_ad_hoc_workloads_enabled (bool) – SQL Server Optimize for Adhoc workloads.

  • min_server_memory_mb (int) – SQL Server minimum memory.

  • max_server_memory_mb (int) – SQL Server maximum memory.

  • is_lpim_enabled (bool) – SQL Server LPIM.

  • is_ifi_enabled (bool) – SQL Server IFI.

Keyword Arguments

  • collation (str) – SQL Server Collation.

  • max_dop (int) – SQL Server MAXDOP.

  • is_optimize_for_ad_hoc_workloads_enabled (bool) – SQL Server Optimize for Adhoc workloads.

  • min_server_memory_mb (int) – SQL Server minimum memory.

  • max_server_memory_mb (int) – SQL Server maximum memory.

  • is_lpim_enabled (bool) – SQL Server LPIM.

  • is_ifi_enabled (bool) – SQL Server IFI.

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

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Set disk storage settings for SQL Server.

Variables

  • luns (list[int]) – Logical Unit Numbers for the disks.

  • default_file_path (str) – SQL Server default file path.

Keyword Arguments

  • luns (list[int]) – Logical Unit Numbers for the disks.

  • default_file_path (str) – SQL Server default file path.

class azure.mgmt.sqlvirtualmachine.models.SQLTempDbSettings(*, data_file_size: Optional[int] = None, data_growth: Optional[int] = None, log_file_size: Optional[int] = None, log_growth: Optional[int] = None, data_file_count: Optional[int] = None, persist_folder: Optional[bool] = None, persist_folder_path: Optional[str] = None, luns: Optional[List[int]] = None, default_file_path: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Set tempDb storage settings for SQL Server.

Variables

  • data_file_size (int) – SQL Server tempdb data file size.

  • data_growth (int) – SQL Server tempdb data file autoGrowth size.

  • log_file_size (int) – SQL Server tempdb log file size.

  • log_growth (int) – SQL Server tempdb log file autoGrowth size.

  • data_file_count (int) – SQL Server tempdb data file count.

  • persist_folder (bool) – SQL Server tempdb persist folder choice.

  • persist_folder_path (str) – SQL Server tempdb persist folder location.

  • luns (list[int]) – Logical Unit Numbers for the disks.

  • default_file_path (str) – SQL Server default file path.

Keyword Arguments

  • data_file_size (int) – SQL Server tempdb data file size.

  • data_growth (int) – SQL Server tempdb data file autoGrowth size.

  • log_file_size (int) – SQL Server tempdb log file size.

  • log_growth (int) – SQL Server tempdb log file autoGrowth size.

  • data_file_count (int) – SQL Server tempdb data file count.

  • persist_folder (bool) – SQL Server tempdb persist folder choice.

  • persist_folder_path (str) – SQL Server tempdb persist folder location.

  • luns (list[int]) – Logical Unit Numbers for the disks.

  • default_file_path (str) – SQL Server default file path.

class azure.mgmt.sqlvirtualmachine.models.ScaleType(value)[source]

Bases: str, enum.Enum

Scale type.

HA = 'HA'
class azure.mgmt.sqlvirtualmachine.models.Schedule(*, enable: Optional[bool] = None, weekly_interval: Optional[int] = None, monthly_occurrence: Optional[int] = None, day_of_week: Optional[Union[str, _models.AssessmentDayOfWeek]] = None, start_time: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Set assessment schedule for SQL Server.

Variables

  • enable (bool) – Enable or disable assessment schedule on SQL virtual machine.

  • weekly_interval (int) – Number of weeks to schedule between 2 assessment runs. Takes value from 1-6.

  • monthly_occurrence (int) – Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month.

  • day_of_week (str or AssessmentDayOfWeek) – Day of the week to run assessment. Known values are: “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

  • start_time (str) – Time of the day in HH:mm format. Eg. 17:30.

Keyword Arguments

  • enable (bool) – Enable or disable assessment schedule on SQL virtual machine.

  • weekly_interval (int) – Number of weeks to schedule between 2 assessment runs. Takes value from 1-6.

  • monthly_occurrence (int) – Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month.

  • day_of_week (str or AssessmentDayOfWeek) – Day of the week to run assessment. Known values are: “Monday”, “Tuesday”, “Wednesday”, “Thursday”, “Friday”, “Saturday”, and “Sunday”.

  • start_time (str) – Time of the day in HH:mm format. Eg. 17:30.

class azure.mgmt.sqlvirtualmachine.models.ServerConfigurationsManagementSettings(*, sql_connectivity_update_settings: Optional[_models.SqlConnectivityUpdateSettings] = None, sql_workload_type_update_settings: Optional[_models.SqlWorkloadTypeUpdateSettings] = None, sql_storage_update_settings: Optional[_models.SqlStorageUpdateSettings] = None, additional_features_server_configurations: Optional[_models.AdditionalFeaturesServerConfigurations] = None, sql_instance_settings: Optional[_models.SQLInstanceSettings] = None, azure_ad_authentication_settings: Optional[_models.AADAuthenticationSettings] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Set the connectivity, storage and workload settings.

Variables
Keyword Arguments
class azure.mgmt.sqlvirtualmachine.models.SqlConnectivityUpdateSettings(*, connectivity_type: Optional[Union[str, _models.ConnectivityType]] = None, port: Optional[int] = None, sql_auth_update_user_name: Optional[str] = None, sql_auth_update_password: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

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

Variables

  • connectivity_type (str or ConnectivityType) – SQL Server connectivity option. Known values are: “LOCAL”, “PRIVATE”, and “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.

Keyword Arguments

  • connectivity_type (str or ConnectivityType) – SQL Server connectivity option. Known values are: “LOCAL”, “PRIVATE”, and “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.SqlImageSku(value)[source]

Bases: str, enum.Enum

SQL Server edition type.

DEVELOPER = 'Developer'
ENTERPRISE = 'Enterprise'
EXPRESS = 'Express'
STANDARD = 'Standard'
WEB = 'Web'
class azure.mgmt.sqlvirtualmachine.models.SqlManagementMode(value)[source]

Bases: str, enum.Enum

SQL Server Management type.

FULL = 'Full'
LIGHT_WEIGHT = 'LightWeight'
NO_AGENT = 'NoAgent'
class azure.mgmt.sqlvirtualmachine.models.SqlServerLicenseType(value)[source]

Bases: str, enum.Enum

SQL Server license type.

AHUB = 'AHUB'
DR = 'DR'
PAYG = 'PAYG'
class azure.mgmt.sqlvirtualmachine.models.SqlStorageUpdateSettings(*, disk_count: Optional[int] = None, starting_device_id: Optional[int] = None, disk_configuration_type: Optional[Union[str, _models.DiskConfigurationType]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Set disk storage settings for SQL Server.

Variables

  • 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. Known values are: “NEW”, “EXTEND”, and “ADD”.

Keyword Arguments

  • 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. Known values are: “NEW”, “EXTEND”, and “ADD”.

class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachine(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.ResourceIdentity] = None, virtual_machine_resource_id: Optional[str] = None, sql_image_offer: Optional[str] = None, sql_server_license_type: Optional[Union[str, _models.SqlServerLicenseType]] = None, sql_management: Optional[Union[str, _models.SqlManagementMode]] = None, least_privilege_mode: Union[str, _models.LeastPrivilegeMode] = 'NotSet', sql_image_sku: Optional[Union[str, _models.SqlImageSku]] = None, sql_virtual_machine_group_resource_id: Optional[str] = None, wsfc_domain_credentials: Optional[_models.WsfcDomainCredentials] = None, wsfc_static_ip: Optional[str] = None, auto_patching_settings: Optional[_models.AutoPatchingSettings] = None, auto_backup_settings: Optional[_models.AutoBackupSettings] = None, key_vault_credential_settings: Optional[_models.KeyVaultCredentialSettings] = None, server_configurations_management_settings: Optional[_models.ServerConfigurationsManagementSettings] = None, storage_configuration_settings: Optional[_models.StorageConfigurationSettings] = None, assessment_settings: Optional[_models.AssessmentSettings] = None, enable_automatic_upgrade: bool = False, **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.

  • location (str) – Resource location. Required.

  • tags (dict[str, str]) – Resource tags.

  • identity (ResourceIdentity) – Azure Active Directory identity of the server.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

  • virtual_machine_resource_id (str) – ARM Resource id of underlying virtual machine created from SQL marketplace image.

  • provisioning_state (str) – Provisioning state to track the async operation status.

  • sql_image_offer (str) – SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.

  • sql_server_license_type (str or SqlServerLicenseType) – SQL Server license type. Known values are: “PAYG”, “AHUB”, and “DR”.

  • sql_management (str or SqlManagementMode) – SQL Server Management type. Known values are: “Full”, “LightWeight”, and “NoAgent”.

  • least_privilege_mode (str or LeastPrivilegeMode) – SQL IaaS Agent least privilege mode. Known values are: “Enabled” and “NotSet”.

  • sql_image_sku (str or SqlImageSku) – SQL Server edition type. Known values are: “Developer”, “Express”, “Standard”, “Enterprise”, and “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.

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

  • troubleshooting_status (TroubleshootingStatus) – Troubleshooting status.

  • assessment_settings (AssessmentSettings) – SQL best practices Assessment Settings.

  • enable_automatic_upgrade (bool) – Enable automatic upgrade of Sql IaaS extension Agent.

Keyword Arguments

  • location (str) – Resource location. Required.

  • 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. Known values are: “PAYG”, “AHUB”, and “DR”.

  • sql_management (str or SqlManagementMode) – SQL Server Management type. Known values are: “Full”, “LightWeight”, and “NoAgent”.

  • least_privilege_mode (str or LeastPrivilegeMode) – SQL IaaS Agent least privilege mode. Known values are: “Enabled” and “NotSet”.

  • sql_image_sku (str or SqlImageSku) – SQL Server edition type. Known values are: “Developer”, “Express”, “Standard”, “Enterprise”, and “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.

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

  • assessment_settings (AssessmentSettings) – SQL best practices Assessment Settings.

  • enable_automatic_upgrade (bool) – Enable automatic upgrade of Sql IaaS extension Agent.

class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachineGroup(*, location: str, tags: Optional[Dict[str, str]] = None, sql_image_offer: Optional[str] = None, sql_image_sku: Optional[Union[str, _models.SqlVmGroupImageSku]] = None, wsfc_domain_profile: Optional[_models.WsfcDomainProfile] = 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.

  • location (str) – Resource location. Required.

  • tags (dict[str, str]) – Resource tags.

  • system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.

  • provisioning_state (str) – Provisioning state to track the async operation status.

  • sql_image_offer (str) – SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.

  • sql_image_sku (str or SqlVmGroupImageSku) – SQL image sku. Known values are: “Developer” and “Enterprise”.

  • scale_type (str or ScaleType) – Scale type. “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. “WSFC”

  • cluster_configuration (str or ClusterConfiguration) – Cluster type. “Domainful”

  • wsfc_domain_profile (WsfcDomainProfile) – Cluster Active Directory domain profile.

Keyword Arguments

  • location (str) – Resource location. Required.

  • 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. Known values are: “Developer” and “Enterprise”.

  • wsfc_domain_profile (WsfcDomainProfile) – Cluster Active Directory domain profile.

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

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

A list of SQL virtual machine groups.

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

Variables
class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachineGroupUpdate(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

An update to a SQL virtual machine group.

Variables

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

Keyword Arguments

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

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

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

A list of SQL virtual machines.

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

Variables
class azure.mgmt.sqlvirtualmachine.models.SqlVirtualMachineUpdate(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

An update to a SQL virtual machine.

Variables

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

Keyword Arguments

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

class azure.mgmt.sqlvirtualmachine.models.SqlVmGroupImageSku(value)[source]

Bases: str, enum.Enum

SQL image sku.

DEVELOPER = 'Developer'
ENTERPRISE = 'Enterprise'
class azure.mgmt.sqlvirtualmachine.models.SqlVmTroubleshooting(*, start_time_utc: Optional[datetime.datetime] = None, end_time_utc: Optional[datetime.datetime] = None, troubleshooting_scenario: Optional[Union[str, _models.TroubleshootingScenario]] = None, properties: Optional[_models.TroubleshootingAdditionalProperties] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Details required for SQL VM troubleshooting.

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

Variables
Keyword Arguments
class azure.mgmt.sqlvirtualmachine.models.SqlWorkloadType(value)[source]

Bases: str, enum.Enum

SQL Server workload type.

DW = 'DW'
GENERAL = 'GENERAL'
OLTP = 'OLTP'
class azure.mgmt.sqlvirtualmachine.models.SqlWorkloadTypeUpdateSettings(*, sql_workload_type: Optional[Union[str, _models.SqlWorkloadType]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Set workload type to optimize storage for SQL Server.

Variables

sql_workload_type (str or SqlWorkloadType) – SQL Server workload type. Known values are: “GENERAL”, “OLTP”, and “DW”.

Keyword Arguments

sql_workload_type (str or SqlWorkloadType) – SQL Server workload type. Known values are: “GENERAL”, “OLTP”, and “DW”.

class azure.mgmt.sqlvirtualmachine.models.StorageConfigurationSettings(*, sql_data_settings: Optional[_models.SQLStorageSettings] = None, sql_log_settings: Optional[_models.SQLStorageSettings] = None, sql_temp_db_settings: Optional[_models.SQLTempDbSettings] = None, sql_system_db_on_data_disk: Optional[bool] = None, disk_configuration_type: Optional[Union[str, _models.DiskConfigurationType]] = None, storage_workload_type: Optional[Union[str, _models.StorageWorkloadType]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Storage Configurations for SQL Data, Log and TempDb.

Variables

  • sql_data_settings (SQLStorageSettings) – SQL Server Data Storage Settings.

  • sql_log_settings (SQLStorageSettings) – SQL Server Log Storage Settings.

  • sql_temp_db_settings (SQLTempDbSettings) – SQL Server TempDb Storage Settings.

  • sql_system_db_on_data_disk (bool) – SQL Server SystemDb Storage on DataPool if true.

  • disk_configuration_type (str or DiskConfigurationType) – Disk configuration to apply to SQL Server. Known values are: “NEW”, “EXTEND”, and “ADD”.

  • storage_workload_type (str or StorageWorkloadType) – Storage workload type. Known values are: “GENERAL”, “OLTP”, and “DW”.

Keyword Arguments

  • sql_data_settings (SQLStorageSettings) – SQL Server Data Storage Settings.

  • sql_log_settings (SQLStorageSettings) – SQL Server Log Storage Settings.

  • sql_temp_db_settings (SQLTempDbSettings) – SQL Server TempDb Storage Settings.

  • sql_system_db_on_data_disk (bool) – SQL Server SystemDb Storage on DataPool if true.

  • disk_configuration_type (str or DiskConfigurationType) – Disk configuration to apply to SQL Server. Known values are: “NEW”, “EXTEND”, and “ADD”.

  • storage_workload_type (str or StorageWorkloadType) – Storage workload type. Known values are: “GENERAL”, “OLTP”, and “DW”.

class azure.mgmt.sqlvirtualmachine.models.StorageWorkloadType(value)[source]

Bases: str, enum.Enum

Storage workload type.

DW = 'DW'
GENERAL = 'GENERAL'
OLTP = 'OLTP'
class azure.mgmt.sqlvirtualmachine.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.sqlvirtualmachine.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = 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.

  • location (str) – Resource location. Required.

  • tags (dict[str, str]) – Resource tags.

Keyword Arguments

  • location (str) – Resource location. Required.

  • tags (dict[str, str]) – Resource tags.

class azure.mgmt.sqlvirtualmachine.models.TroubleshootingAdditionalProperties(*, unhealthy_replica_info: Optional[_models.UnhealthyReplicaInfo] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

SQL VM Troubleshooting additional properties.

Variables

unhealthy_replica_info (UnhealthyReplicaInfo) – The unhealthy replica information.

Keyword Arguments

unhealthy_replica_info (UnhealthyReplicaInfo) – The unhealthy replica information.

class azure.mgmt.sqlvirtualmachine.models.TroubleshootingScenario(value)[source]

Bases: str, enum.Enum

SQL VM troubleshooting scenario.

UNHEALTHY_REPLICA = 'UnhealthyReplica'
class azure.mgmt.sqlvirtualmachine.models.TroubleshootingStatus(**kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Status of last troubleshooting operation on this SQL VM.

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

Variables

  • root_cause (str) – Root cause of the issue.

  • last_trigger_time_utc (datetime) – Last troubleshooting trigger time in UTC timezone.

  • start_time_utc (datetime) – Start time in UTC timezone.

  • end_time_utc (datetime) – End time in UTC timezone.

  • troubleshooting_scenario (str or TroubleshootingScenario) – SQL VM troubleshooting scenario. “UnhealthyReplica”

  • properties (TroubleshootingAdditionalProperties) – Troubleshooting properties.

class azure.mgmt.sqlvirtualmachine.models.UnhealthyReplicaInfo(*, availability_group_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

SQL VM Troubleshoot UnhealthyReplica scenario information.

Variables

availability_group_name (str) – The name of the availability group.

Keyword Arguments

availability_group_name (str) – The name of the availability group.

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

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

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

Variables

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

Keyword Arguments

  • 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: Optional[str] = None, ou_path: Optional[str] = None, cluster_bootstrap_account: Optional[str] = None, cluster_operator_account: Optional[str] = None, sql_service_account: Optional[str] = None, file_share_witness_path: Optional[str] = None, storage_account_url: Optional[str] = None, storage_account_primary_key: Optional[str] = None, cluster_subnet_type: Optional[Union[str, _models.ClusterSubnetType]] = None, **kwargs)[source]

Bases: azure.mgmt.sqlvirtualmachine._serialization.Model

Active Directory account details to operate Windows Server Failover Cluster.

Variables

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

  • cluster_subnet_type (str or ClusterSubnetType) – Cluster subnet type. Known values are: “SingleSubnet” and “MultiSubnet”.

Keyword Arguments

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

  • cluster_subnet_type (str or ClusterSubnetType) – Cluster subnet type. Known values are: “SingleSubnet” and “MultiSubnet”.