@azure/arm-sqlvirtualmachine package

Classes

SqlVirtualMachineManagementClient

Interfaces

AADAuthenticationSettings	Enable AAD authentication for SQL VM.
AdditionalFeaturesServerConfigurations	Additional SQL Server feature settings.
AgConfiguration	Availability group configuration.
AgReplica	Availability group replica configuration.
AssessmentSettings	Configure SQL best practices Assessment for databases in your SQL virtual machine.
AutoBackupSettings	Configure backups for databases in your SQL virtual machine.
AutoPatchingSettings	Set a patching window during which Windows and SQL patches will be applied.
AvailabilityGroupListener	A SQL Server availability group listener.
AvailabilityGroupListenerListResult	A list of availability group listeners.
AvailabilityGroupListeners	Interface representing a AvailabilityGroupListeners.
AvailabilityGroupListenersCreateOrUpdateOptionalParams	Optional parameters.
AvailabilityGroupListenersDeleteHeaders	Defines headers for AvailabilityGroupListeners_delete operation.
AvailabilityGroupListenersDeleteOptionalParams	Optional parameters.
AvailabilityGroupListenersGetOptionalParams	Optional parameters.
AvailabilityGroupListenersListByGroupNextOptionalParams	Optional parameters.
AvailabilityGroupListenersListByGroupOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
KeyVaultCredentialSettings	Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.
LoadBalancerConfiguration	A load balancer configuration for an availability group listener.
MultiSubnetIpConfiguration	Multi subnet ip configuration for an availability group listener.
Operation	SQL REST API operation definition.
OperationDisplay	Display metadata associated with the operation.
OperationListResult	Result of the request to list SQL operations.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PrivateIPAddress	A private IP address bound to the availability group listener.
ProxyResource	ARM proxy resource.
Resource	ARM resource.
ResourceIdentity	Azure Active Directory identity configuration for a resource.
SQLInstanceSettings	Set the server/instance-level settings for SQL Server.
SQLStorageSettings	Set disk storage settings for SQL Server.
SQLTempDbSettings	Set tempDb storage settings for SQL Server.
Schedule	Set assessment schedule for SQL Server.
ServerConfigurationsManagementSettings	Set the connectivity, storage and workload settings.
SqlConnectivityUpdateSettings	Set the access level and network port settings for SQL Server.
SqlStorageUpdateSettings	Set disk storage settings for SQL Server.
SqlVirtualMachine	A SQL virtual machine.
SqlVirtualMachineGroup	A SQL virtual machine group.
SqlVirtualMachineGroupListResult	A list of SQL virtual machine groups.
SqlVirtualMachineGroupUpdate	An update to a SQL virtual machine group.
SqlVirtualMachineGroups	Interface representing a SqlVirtualMachineGroups.
SqlVirtualMachineGroupsCreateOrUpdateOptionalParams	Optional parameters.
SqlVirtualMachineGroupsDeleteHeaders	Defines headers for SqlVirtualMachineGroups_delete operation.
SqlVirtualMachineGroupsDeleteOptionalParams	Optional parameters.
SqlVirtualMachineGroupsGetOptionalParams	Optional parameters.
SqlVirtualMachineGroupsListByResourceGroupNextOptionalParams	Optional parameters.
SqlVirtualMachineGroupsListByResourceGroupOptionalParams	Optional parameters.
SqlVirtualMachineGroupsListNextOptionalParams	Optional parameters.
SqlVirtualMachineGroupsListOptionalParams	Optional parameters.
SqlVirtualMachineGroupsUpdateOptionalParams	Optional parameters.
SqlVirtualMachineListResult	A list of SQL virtual machines.
SqlVirtualMachineManagementClientOptionalParams	Optional parameters.
SqlVirtualMachineTroubleshoot	Interface representing a SqlVirtualMachineTroubleshoot.
SqlVirtualMachineTroubleshootTroubleshootHeaders	Defines headers for SqlVirtualMachineTroubleshoot_troubleshoot operation.
SqlVirtualMachineTroubleshootTroubleshootOptionalParams	Optional parameters.
SqlVirtualMachineUpdate	An update to a SQL virtual machine.
SqlVirtualMachines	Interface representing a SqlVirtualMachines.
SqlVirtualMachinesCreateOrUpdateOptionalParams	Optional parameters.
SqlVirtualMachinesDeleteHeaders	Defines headers for SqlVirtualMachines_delete operation.
SqlVirtualMachinesDeleteOptionalParams	Optional parameters.
SqlVirtualMachinesGetOptionalParams	Optional parameters.
SqlVirtualMachinesListByResourceGroupNextOptionalParams	Optional parameters.
SqlVirtualMachinesListByResourceGroupOptionalParams	Optional parameters.
SqlVirtualMachinesListBySqlVmGroupNextOptionalParams	Optional parameters.
SqlVirtualMachinesListBySqlVmGroupOptionalParams	Optional parameters.
SqlVirtualMachinesListNextOptionalParams	Optional parameters.
SqlVirtualMachinesListOptionalParams	Optional parameters.
SqlVirtualMachinesRedeployHeaders	Defines headers for SqlVirtualMachines_redeploy operation.
SqlVirtualMachinesRedeployOptionalParams	Optional parameters.
SqlVirtualMachinesStartAssessmentHeaders	Defines headers for SqlVirtualMachines_startAssessment operation.
SqlVirtualMachinesStartAssessmentOptionalParams	Optional parameters.
SqlVirtualMachinesUpdateOptionalParams	Optional parameters.
SqlVmTroubleshooting	Details required for SQL VM troubleshooting
SqlWorkloadTypeUpdateSettings	Set workload type to optimize storage for SQL Server.
StorageConfigurationSettings	Storage Configurations for SQL Data, Log and TempDb.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	ARM tracked top level resource.
TroubleshootingAdditionalProperties	SQL VM Troubleshooting additional properties.
TroubleshootingStatus	Status of last troubleshooting operation on this SQL VM
UnhealthyReplicaInfo	SQL VM Troubleshoot UnhealthyReplica scenario information.
WsfcDomainCredentials	Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.
WsfcDomainProfile	Active Directory account details to operate Windows Server Failover Cluster.

Type Aliases

AssessmentDayOfWeek	Defines values for AssessmentDayOfWeek.
AutoBackupDaysOfWeek	Defines values for AutoBackupDaysOfWeek. KnownAutoBackupDaysOfWeek can be used interchangeably with AutoBackupDaysOfWeek, this enum contains the known values that the service supports. Known values supported by the service Monday Tuesday Wednesday Thursday Friday Saturday Sunday
AvailabilityGroupListenersCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
AvailabilityGroupListenersGetResponse	Contains response data for the get operation.
AvailabilityGroupListenersListByGroupNextResponse	Contains response data for the listByGroupNext operation.
AvailabilityGroupListenersListByGroupResponse	Contains response data for the listByGroup operation.
BackupScheduleType	Defines values for BackupScheduleType. KnownBackupScheduleType can be used interchangeably with BackupScheduleType, this enum contains the known values that the service supports. Known values supported by the service Manual Automated
ClusterConfiguration	Defines values for ClusterConfiguration. KnownClusterConfiguration can be used interchangeably with ClusterConfiguration, this enum contains the known values that the service supports. Known values supported by the service Domainful
ClusterManagerType	Defines values for ClusterManagerType. KnownClusterManagerType can be used interchangeably with ClusterManagerType, this enum contains the known values that the service supports. Known values supported by the service WSFC
ClusterSubnetType	Defines values for ClusterSubnetType. KnownClusterSubnetType can be used interchangeably with ClusterSubnetType, this enum contains the known values that the service supports. Known values supported by the service SingleSubnet MultiSubnet
Commit	Defines values for Commit. KnownCommit can be used interchangeably with Commit, this enum contains the known values that the service supports. Known values supported by the service SYNCHRONOUS_COMMIT ASYNCHRONOUS_COMMIT
ConnectivityType	Defines values for ConnectivityType. KnownConnectivityType can be used interchangeably with ConnectivityType, this enum contains the known values that the service supports. Known values supported by the service LOCAL PRIVATE PUBLIC
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DayOfWeek	Defines values for DayOfWeek.
DiskConfigurationType	Defines values for DiskConfigurationType. KnownDiskConfigurationType can be used interchangeably with DiskConfigurationType, this enum contains the known values that the service supports. Known values supported by the service NEW EXTEND ADD
Failover	Defines values for Failover. KnownFailover can be used interchangeably with Failover, this enum contains the known values that the service supports. Known values supported by the service AUTOMATIC MANUAL
FullBackupFrequencyType	Defines values for FullBackupFrequencyType. KnownFullBackupFrequencyType can be used interchangeably with FullBackupFrequencyType, this enum contains the known values that the service supports. Known values supported by the service Daily Weekly
IdentityType	Defines values for IdentityType. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned
LeastPrivilegeMode	Defines values for LeastPrivilegeMode. KnownLeastPrivilegeMode can be used interchangeably with LeastPrivilegeMode, this enum contains the known values that the service supports. Known values supported by the service Enabled NotSet
OperationOrigin	Defines values for OperationOrigin. KnownOperationOrigin can be used interchangeably with OperationOrigin, this enum contains the known values that the service supports. Known values supported by the service user system
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
ReadableSecondary	Defines values for ReadableSecondary. KnownReadableSecondary can be used interchangeably with ReadableSecondary, this enum contains the known values that the service supports. Known values supported by the service NO ALL READ_ONLY
Role	Defines values for Role. KnownRole can be used interchangeably with Role, this enum contains the known values that the service supports. Known values supported by the service PRIMARY SECONDARY
ScaleType	Defines values for ScaleType. KnownScaleType can be used interchangeably with ScaleType, this enum contains the known values that the service supports. Known values supported by the service HA
SqlImageSku	Defines values for SqlImageSku. KnownSqlImageSku can be used interchangeably with SqlImageSku, this enum contains the known values that the service supports. Known values supported by the service Developer Express Standard Enterprise Web
SqlManagementMode	Defines values for SqlManagementMode. KnownSqlManagementMode can be used interchangeably with SqlManagementMode, this enum contains the known values that the service supports. Known values supported by the service Full LightWeight NoAgent
SqlServerLicenseType	Defines values for SqlServerLicenseType. KnownSqlServerLicenseType can be used interchangeably with SqlServerLicenseType, this enum contains the known values that the service supports. Known values supported by the service PAYG AHUB DR
SqlVirtualMachineGroupsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SqlVirtualMachineGroupsGetResponse	Contains response data for the get operation.
SqlVirtualMachineGroupsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
SqlVirtualMachineGroupsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
SqlVirtualMachineGroupsListNextResponse	Contains response data for the listNext operation.
SqlVirtualMachineGroupsListResponse	Contains response data for the list operation.
SqlVirtualMachineGroupsUpdateResponse	Contains response data for the update operation.
SqlVirtualMachineTroubleshootTroubleshootResponse	Contains response data for the troubleshoot operation.
SqlVirtualMachinesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SqlVirtualMachinesGetResponse	Contains response data for the get operation.
SqlVirtualMachinesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
SqlVirtualMachinesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
SqlVirtualMachinesListBySqlVmGroupNextResponse	Contains response data for the listBySqlVmGroupNext operation.
SqlVirtualMachinesListBySqlVmGroupResponse	Contains response data for the listBySqlVmGroup operation.
SqlVirtualMachinesListNextResponse	Contains response data for the listNext operation.
SqlVirtualMachinesListResponse	Contains response data for the list operation.
SqlVirtualMachinesUpdateResponse	Contains response data for the update operation.
SqlVmGroupImageSku	Defines values for SqlVmGroupImageSku. KnownSqlVmGroupImageSku can be used interchangeably with SqlVmGroupImageSku, this enum contains the known values that the service supports. Known values supported by the service Developer Enterprise
SqlWorkloadType	Defines values for SqlWorkloadType. KnownSqlWorkloadType can be used interchangeably with SqlWorkloadType, this enum contains the known values that the service supports. Known values supported by the service GENERAL OLTP DW
StorageWorkloadType	Defines values for StorageWorkloadType. KnownStorageWorkloadType can be used interchangeably with StorageWorkloadType, this enum contains the known values that the service supports. Known values supported by the service GENERAL OLTP DW
TroubleshootingScenario	Defines values for TroubleshootingScenario. KnownTroubleshootingScenario can be used interchangeably with TroubleshootingScenario, this enum contains the known values that the service supports. Known values supported by the service UnhealthyReplica

Enums

KnownAutoBackupDaysOfWeek	Known values of AutoBackupDaysOfWeek that the service accepts.
KnownBackupScheduleType	Known values of BackupScheduleType that the service accepts.
KnownClusterConfiguration	Known values of ClusterConfiguration that the service accepts.
KnownClusterManagerType	Known values of ClusterManagerType that the service accepts.
KnownClusterSubnetType	Known values of ClusterSubnetType that the service accepts.
KnownCommit	Known values of Commit that the service accepts.
KnownConnectivityType	Known values of ConnectivityType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDiskConfigurationType	Known values of DiskConfigurationType that the service accepts.
KnownFailover	Known values of Failover that the service accepts.
KnownFullBackupFrequencyType	Known values of FullBackupFrequencyType that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownLeastPrivilegeMode	Known values of LeastPrivilegeMode that the service accepts.
KnownOperationOrigin	Known values of OperationOrigin that the service accepts.
KnownReadableSecondary	Known values of ReadableSecondary that the service accepts.
KnownRole	Known values of Role that the service accepts.
KnownScaleType	Known values of ScaleType that the service accepts.
KnownSqlImageSku	Known values of SqlImageSku that the service accepts.
KnownSqlManagementMode	Known values of SqlManagementMode that the service accepts.
KnownSqlServerLicenseType	Known values of SqlServerLicenseType that the service accepts.
KnownSqlVmGroupImageSku	Known values of SqlVmGroupImageSku that the service accepts.
KnownSqlWorkloadType	Known values of SqlWorkloadType that the service accepts.
KnownStorageWorkloadType	Known values of StorageWorkloadType that the service accepts.
KnownTroubleshootingScenario	Known values of TroubleshootingScenario that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.