@azure/arm-sqlvirtualmachine package
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. |
| AvailabilityGroupListenerProperties |
The properties of an availability group listener. |
| AvailabilityGroupListenersCreateOrUpdateOptionalParams |
Optional parameters. |
| AvailabilityGroupListenersDeleteOptionalParams |
Optional parameters. |
| AvailabilityGroupListenersGetOptionalParams |
Optional parameters. |
| AvailabilityGroupListenersListByGroupOptionalParams |
Optional parameters. |
| AvailabilityGroupListenersOperations |
Interface representing a AvailabilityGroupListeners operations. |
| DiskConfigAssessmentRequest |
Configure disk config assessment for databases in your SQL virtual machine. |
| 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. |
| 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 |
Result of the request to list SQL operations. |
| OperationDisplay |
Display metadata associated with the operation. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| PrivateIPAddress |
A private IP address bound to the availability group listener. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceIdentity |
Azure Active Directory identity configuration for a resource. |
| RestorePollerOptions | |
| 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. |
| SimplePollerLike |
A simple poller that can be used to poll a long running operation. |
| 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. |
| SqlVirtualMachineGroupProperties |
The properties of a SQL virtual machine group. |
| SqlVirtualMachineGroupUpdate |
An update to a SQL virtual machine group. |
| SqlVirtualMachineGroupsCreateOrUpdateOptionalParams |
Optional parameters. |
| SqlVirtualMachineGroupsDeleteOptionalParams |
Optional parameters. |
| SqlVirtualMachineGroupsGetOptionalParams |
Optional parameters. |
| SqlVirtualMachineGroupsListByResourceGroupOptionalParams |
Optional parameters. |
| SqlVirtualMachineGroupsListOptionalParams |
Optional parameters. |
| SqlVirtualMachineGroupsOperations |
Interface representing a SqlVirtualMachineGroups operations. |
| SqlVirtualMachineGroupsUpdateOptionalParams |
Optional parameters. |
| SqlVirtualMachineManagementClientOptionalParams |
Optional parameters for the client. |
| SqlVirtualMachineProperties |
The SQL virtual machine properties. |
| SqlVirtualMachineTroubleshootOperations |
Interface representing a SqlVirtualMachineTroubleshoot operations. |
| SqlVirtualMachineTroubleshootTroubleshootOptionalParams |
Optional parameters. |
| SqlVirtualMachineUpdate |
An update to a SQL virtual machine. |
| SqlVirtualMachinesCreateOrUpdateOptionalParams |
Optional parameters. |
| SqlVirtualMachinesDeleteOptionalParams |
Optional parameters. |
| SqlVirtualMachinesFetchDCAssessmentOptionalParams |
Optional parameters. |
| SqlVirtualMachinesGetOptionalParams |
Optional parameters. |
| SqlVirtualMachinesListByResourceGroupOptionalParams |
Optional parameters. |
| SqlVirtualMachinesListBySqlVmGroupOptionalParams |
Optional parameters. |
| SqlVirtualMachinesListOptionalParams |
Optional parameters. |
| SqlVirtualMachinesOperations |
Interface representing a SqlVirtualMachines operations. |
| SqlVirtualMachinesRedeployOptionalParams |
Optional parameters. |
| 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 |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| TroubleshootingAdditionalProperties |
SQL VM Troubleshooting additional properties. |
| TroubleshootingStatus |
Status of last troubleshooting operation on this SQL VM |
| UnhealthyReplicaInfo |
SQL VM Troubleshoot UnhealthyReplica scenario information. |
| VirtualMachineIdentity |
Virtual Machine Identity details used for Sql IaaS extension configurations. |
| 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
| AdditionalOsPatch |
Additional VM Patching solution enabled on the Virtual Machine Known values supported by the serviceWU |
| AdditionalVmPatch |
Additional Patch to be enable or enabled on the SQL Virtual Machine. Known values supported by the serviceNotSet |
| AssessmentDayOfWeek |
Day of the week to run assessment. |
| AutoBackupDaysOfWeek |
Type of AutoBackupDaysOfWeek |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| BackupScheduleType |
Backup schedule type. Known values supported by the serviceManual |
| ClusterConfiguration |
Cluster type. Known values supported by the serviceDomainful |
| ClusterManagerType |
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. Known values supported by the serviceWSFC |
| ClusterSubnetType |
Cluster subnet type. Known values supported by the serviceSingleSubnet |
| Commit |
Replica commit mode in availability group. Known values supported by the serviceSynchronous_Commit |
| ConnectivityType |
SQL Server connectivity option. Known values supported by the serviceLOCAL |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DayOfWeek |
Day of week to apply the patch on. |
| DiskConfigurationType |
Disk configuration to apply to SQL Server. Known values supported by the serviceNEW |
| Failover |
Replica failover mode in availability group. Known values supported by the serviceAutomatic |
| FullBackupFrequencyType |
Frequency of full backups. In both cases, full backups begin during the next scheduled time window. Known values supported by the serviceDaily |
| 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 supported by the serviceNone |
| LeastPrivilegeMode |
SQL IaaS Agent least privilege mode. Known values supported by the serviceEnabled |
| OperationOrigin |
The intended executor of the operation. Known values supported by the serviceuser |
| OsType |
Operating System of the current SQL Virtual Machine. |
| ReadableSecondary |
Replica readable secondary mode in availability group. Known values supported by the serviceNo |
| Role |
Replica Role in availability group. Known values supported by the servicePrimary |
| ScaleType |
Scale type. Known values supported by the serviceHA |
| SqlImageSku |
SQL Server edition type. Known values supported by the serviceDeveloper |
| SqlManagementMode |
SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. Known values supported by the serviceFull |
| SqlServerLicenseType |
SQL Server license type. Known values supported by the servicePAYG |
| SqlVmGroupImageSku |
SQL image sku. Known values supported by the serviceDeveloper |
| SqlWorkloadType |
SQL Server workload type. Known values supported by the serviceGENERAL |
| StorageWorkloadType |
Storage workload type. Known values supported by the serviceGENERAL |
| TroubleshootingScenario |
SQL VM troubleshooting scenario. Known values supported by the serviceUnhealthyReplica |
| VmIdentityType |
Identity type of the virtual machine. Specify None to opt-out of Managed Identities. Known values supported by the serviceNone |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownAdditionalOsPatch |
Additional VM Patching solution enabled on the Virtual Machine |
| KnownAdditionalVmPatch |
Additional Patch to be enable or enabled on the SQL Virtual Machine. |
| KnownAutoBackupDaysOfWeek |
Known values of AutoBackupDaysOfWeek that the service accepts. |
| KnownBackupScheduleType |
Backup schedule type. |
| KnownClusterConfiguration |
Cluster type. |
| KnownClusterManagerType |
Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type. |
| KnownClusterSubnetType |
Cluster subnet type. |
| KnownCommit |
Replica commit mode in availability group. |
| KnownConnectivityType |
SQL Server connectivity option. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDiskConfigurationType |
Disk configuration to apply to SQL Server. |
| KnownFailover |
Replica failover mode in availability group. |
| KnownFullBackupFrequencyType |
Frequency of full backups. In both cases, full backups begin during the next scheduled time window. |
| KnownIdentityType |
The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. |
| KnownLeastPrivilegeMode |
SQL IaaS Agent least privilege mode. |
| KnownOperationOrigin |
The intended executor of the operation. |
| KnownReadableSecondary |
Replica readable secondary mode in availability group. |
| KnownRole |
Replica Role in availability group. |
| KnownScaleType |
Scale type. |
| KnownSqlImageSku |
SQL Server edition type. |
| KnownSqlManagementMode |
SQL Server Management type. NOTE: This parameter is not used anymore. API will automatically detect the Sql Management, refrain from using it. |
| KnownSqlServerLicenseType |
SQL Server license type. |
| KnownSqlVmGroupImageSku |
SQL image sku. |
| KnownSqlWorkloadType |
SQL Server workload type. |
| KnownStorageWorkloadType |
Storage workload type. |
| KnownTroubleshootingScenario |
SQL VM troubleshooting scenario. |
| KnownVersions |
The available API versions. |
| KnownVmIdentityType |
Identity type of the virtual machine. Specify None to opt-out of Managed Identities. |
Functions
| is |
Typeguard for RestError |
| restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
restorePoller<TResponse, TResult>(SqlVirtualMachineManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: SqlVirtualMachineManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor