你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

@azure/arm-sqlvirtualmachine package

接口

AADAuthenticationSettings

为 SQL VM 启用 AAD 身份验证。

AdditionalFeaturesServerConfigurations

其他 SQL Server 功能设置。

AgConfiguration

可用性组配置。

AgReplica

可用性组副本配置。

AssessmentSettings

为 SQL 虚拟机中的数据库配置 SQL 最佳做法评估。

AutoBackupSettings

为 SQL 虚拟机中的数据库配置备份。

AutoPatchingSettings

设置一个修补窗口,在此期间将应用 Windows 和 SQL 修补程序。

AvailabilityGroupListener

SQL Server 可用性组侦听器。

AvailabilityGroupListenerProperties

可用性组监听器的属性。

AvailabilityGroupListenersCreateOrUpdateOptionalParams

可选参数。

AvailabilityGroupListenersDeleteOptionalParams

可选参数。

AvailabilityGroupListenersGetOptionalParams

可选参数。

AvailabilityGroupListenersListByGroupOptionalParams

可选参数。

AvailabilityGroupListenersOperations

表示可用性组监听操作的接口。

DiskConfigAssessmentRequest

在你的SQL虚拟机中配置数据库的磁盘配置评估。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。

KeyVaultCredentialSettings

将 SQL 虚拟机配置为能够连接到 Azure 密钥保管库 服务。

LoadBalancerConfiguration

可用性组侦听器的负载均衡器配置。

MultiSubnetIpConfiguration

可用性组侦听器的多子网 IP 配置。

Operation

列出 SQL作的请求的结果。

OperationDisplay

显示与作关联的元数据。

OperationsListOptionalParams

可选参数。

OperationsOperations

表示作作的接口。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

PrivateIPAddress

绑定到可用性组侦听器的专用 IP 地址。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

ResourceIdentity

资源的 Azure Active Directory 标识配置。

RestorePollerOptions
SQLInstanceSettings

设置 SQL Server 的服务器/实例级设置。

SQLStorageSettings

设置 SQL Server 的磁盘存储设置。

SQLTempDbSettings

设置 SQL Server 的 tempDb 存储设置。

Schedule

设置 SQL Server 的评估计划。

ServerConfigurationsManagementSettings

设置连接、存储和工作负荷设置。

SimplePollerLike

可用于轮询长时间运行的操作的简单轮询程序。

SqlConnectivityUpdateSettings

设置 SQL Server 的访问级别和网络端口设置。

SqlStorageUpdateSettings

设置 SQL Server 的磁盘存储设置。

SqlVirtualMachine

SQL 虚拟机。

SqlVirtualMachineGroup

SQL 虚拟机组。

SqlVirtualMachineGroupProperties

SQL虚拟机组的属性。

SqlVirtualMachineGroupUpdate

对 SQL 虚拟机组的更新。

SqlVirtualMachineGroupsCreateOrUpdateOptionalParams

可选参数。

SqlVirtualMachineGroupsDeleteOptionalParams

可选参数。

SqlVirtualMachineGroupsGetOptionalParams

可选参数。

SqlVirtualMachineGroupsListByResourceGroupOptionalParams

可选参数。

SqlVirtualMachineGroupsListOptionalParams

可选参数。

SqlVirtualMachineGroupsOperations

表示 SqlVirtualMachineGroups 操作的接口。

SqlVirtualMachineGroupsUpdateOptionalParams

可选参数。

SqlVirtualMachineManagementClientOptionalParams

客户端的可选参数。

SqlVirtualMachineProperties

SQL 虚拟机属性。

SqlVirtualMachineTroubleshootOperations

表示 SqlVirtualMachineTroubleshoot 操作的接口。

SqlVirtualMachineTroubleshootTroubleshootOptionalParams

可选参数。

SqlVirtualMachineUpdate

对 SQL 虚拟机的更新。

SqlVirtualMachinesCreateOrUpdateOptionalParams

可选参数。

SqlVirtualMachinesDeleteOptionalParams

可选参数。

SqlVirtualMachinesFetchDCAssessmentOptionalParams

可选参数。

SqlVirtualMachinesGetOptionalParams

可选参数。

SqlVirtualMachinesListByResourceGroupOptionalParams

可选参数。

SqlVirtualMachinesListBySqlVmGroupOptionalParams

可选参数。

SqlVirtualMachinesListOptionalParams

可选参数。

SqlVirtualMachinesOperations

表示 SqlVirtualMachines 操作的接口。

SqlVirtualMachinesRedeployOptionalParams

可选参数。

SqlVirtualMachinesStartAssessmentOptionalParams

可选参数。

SqlVirtualMachinesUpdateOptionalParams

可选参数。

SqlVmTroubleshooting

SQL VM 故障排除所需的详细信息

SqlWorkloadTypeUpdateSettings

设置工作负荷类型以优化 SQL Server 的存储。

StorageConfigurationSettings

SQL 数据、日志和 TempDb 的存储配置。

SystemData

与创建和上次修改资源相关的元数据。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

TroubleshootingAdditionalProperties

SQL VM 排查其他属性问题。

TroubleshootingStatus

此 SQL VM 上最后一次故障排除作的状态

UnhealthyReplicaInfo

SQL VM 排查 UnhealthyReplica 方案信息。

VirtualMachineIdentity

用于 Sql IaaS 扩展配置的虚拟机标识详细信息。

WsfcDomainCredentials

用于为 SQL 可用性组设置 Windows Server 故障转移群集的域凭据。

WsfcDomainProfile

用于作 Windows Server 故障转移群集的 Active Directory 帐户详细信息。

类型别名

AdditionalOsPatch

虚拟机上启用了额外的虚拟机补丁解决方案
KnownAdditionalOsPatch 可以与 AdditionalOsPatch 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值


乌姆
WSUS

AdditionalVmPatch

要在 SQL 虚拟机上启用或启用的其他修补程序。
KnownAdditionalVmPatch 可以与 AdditionalVmPatch 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

NotSet
微软更新

AssessmentDayOfWeek

运行评估的一周中的一天。

AutoBackupDaysOfWeek

自动备份的类型:星期几

AzureSupportedClouds

云设置为字符串文字类型的支持值

BackupScheduleType

备份计划类型。
KnownBackupScheduleType 可以与 BackupScheduleType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

手动
自动

ClusterConfiguration

群集类型。
KnownClusterConfiguration 可以与 ClusterConfiguration 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

域名

ClusterManagerType

集群管理器类型:Windows Server故障转移集群(WSFC),由组的规模类型和操作系统类型所暗示。
KnownClusterManagerType 可以与 ClusterManagerType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

WSFC

ClusterSubnetType

群集子网类型。
KnownClusterSubnetType 可以与 ClusterSubnetType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

单子网
多子网

Commit

可用性组中的副本提交模式。
KnownCommit 可以与 Commit 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Synchronous_Commit
Asynchronous_Commit

ConnectivityType

SQL Server 连接选项。
KnownConnectivityType 可以与 ConnectivityType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

LOCAL
专用
PUBLIC

ContinuablePage

描述结果页的接口。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体是由用户创建的。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体是由托管标识创建的。
密钥:实体是由密钥创建的。

DayOfWeek

应用修补程序的一周中的一天。

DiskConfigurationType

要应用于 SQL Server 的磁盘配置。
KnownDiskConfigurationType 可以与 DiskConfigurationType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

新增功能
EXTEND
ADD

Failover

可用性组中的副本故障转移模式。
KnownFailover 可以与 Failover 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

自动
手动

FullBackupFrequencyType

完整备份的频率。 上述两种情况下,均在下一个计划的时间段内开始完整备份。
KnownFullBackupFrequencyType 可以与 FullBackupFrequencyType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

日常
周刊

IdentityType

标识类型。 将此设置为“SystemAssigned”,以便自动创建并分配该资源的 Azure Active Directory 主体。
KnownIdentityType 可与 IdentityType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

没有
SystemAssigned
UserAssigned
SystemAssigned、UserAssigned

LeastPrivilegeMode

SQL IaaS 代理最低特权模式。
KnownLeastPrivilegeMode 可以与 LeastPrivilegeMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

已启用
NotSet

OperationOrigin

操作的预期执行程序。
KnownOperationOrigin 可与 OperationOrigin 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

user
系统

OsType

当前SQL虚拟机的操作系统。

ReadableSecondary

可用性组中的副本可读辅助模式。
KnownReadableSecondary 可以与 ReadableSecondary 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值


全部
Read_Only

Role

可用性组中的副本角色。
KnownRole 可与 Role 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

主服务器
次级

ScaleType

比例。
KnownScaleType 可与 ScaleType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

医 管 局

SqlImageSku

SQL Server 版本类型。
KnownSqlImageSku 可以与 SqlImageSku 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

开发人员
Express
标准
企业
网络

SqlManagementMode

SQL Server 管理类型。 注意:不再使用此参数。 API 会自动检测 Sql 管理,避免使用它。
KnownSqlManagementMode 可以与 SqlManagementMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

完整

无代理

SqlServerLicenseType

SQL Server 许可证类型。
KnownSqlServerLicenseType 可与 SqlServerLicenseType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

PAYG
AHUB
博士

SqlVmGroupImageSku

SQL 映像 SKU。
KnownSqlVmGroupImageSku 可以与 SqlVmGroupImageSku 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

开发人员
企业

SqlWorkloadType

SQL Server 工作负荷类型。
KnownSqlWorkloadType 可以与 SqlWorkloadType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

常规
OLTP
德国之声

StorageWorkloadType

存储工作负荷类型。
KnownStorageWorkloadType 可以与 StorageWorkloadType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

常规
OLTP
德国之声

TroubleshootingScenario

SQL VM 故障排除方案。
KnownTroubleshootingScenario 可以与 TroubleshootingScenario 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

不正常的副本

VmIdentityType

虚拟机的标识类型。 指定“无”以选择退出托管标识。
KnownVmIdentityType 可以与 VmIdentityType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

没有
SystemAssigned
UserAssigned

枚举

AzureClouds

一个用来描述Azure云环境的enum。

KnownAdditionalOsPatch

虚拟机上启用了额外的虚拟机补丁解决方案

KnownAdditionalVmPatch

要在 SQL 虚拟机上启用或启用的其他修补程序。

KnownAutoBackupDaysOfWeek

服务接受的 AutoBackupDaysOfWeek 的已知值。

KnownBackupScheduleType

备份计划类型。

KnownClusterConfiguration

群集类型。

KnownClusterManagerType

集群管理器类型:Windows Server故障转移集群(WSFC),由组的规模类型和操作系统类型所暗示。

KnownClusterSubnetType

群集子网类型。

KnownCommit

可用性组中的副本提交模式。

KnownConnectivityType

SQL Server 连接选项。

KnownCreatedByType

创建资源的实体类型。

KnownDiskConfigurationType

要应用于 SQL Server 的磁盘配置。

KnownFailover

可用性组中的副本故障转移模式。

KnownFullBackupFrequencyType

完整备份的频率。 上述两种情况下,均在下一个计划的时间段内开始完整备份。

KnownIdentityType

标识类型。 将此设置为“SystemAssigned”,以便自动创建并分配该资源的 Azure Active Directory 主体。

KnownLeastPrivilegeMode

SQL IaaS 代理最低特权模式。

KnownOperationOrigin

操作的预期执行程序。

KnownReadableSecondary

可用性组中的副本可读辅助模式。

KnownRole

可用性组中的副本角色。

KnownScaleType

比例。

KnownSqlImageSku

SQL Server 版本类型。

KnownSqlManagementMode

SQL Server 管理类型。 注意:不再使用此参数。 API 会自动检测 Sql 管理,避免使用它。

KnownSqlServerLicenseType

SQL Server 许可证类型。

KnownSqlVmGroupImageSku

SQL 映像 SKU。

KnownSqlWorkloadType

SQL Server 工作负荷类型。

KnownStorageWorkloadType

存储工作负荷类型。

KnownTroubleshootingScenario

SQL VM 故障排除方案。

KnownVersions

可用的 API 版本。

KnownVmIdentityType

虚拟机的标识类型。 指定“无”以选择退出托管标识。

函数

isRestError(unknown)

RestError 的 Typeguard

restorePoller<TResponse, TResult>(SqlVirtualMachineManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

变量

RestError

失败管道请求的自定义错误类型。

函数详细信息

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

restorePoller<TResponse, TResult>(SqlVirtualMachineManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

function restorePoller<TResponse, TResult>(client: SqlVirtualMachineManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

参数

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

返回

PollerLike<OperationState<TResult>, TResult>

变量详细信息

RestError

失败管道请求的自定义错误类型。

RestError: RestErrorConstructor

类型