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

@azure/arm-servicefabric package

ServiceFabricManagementClient

接口

ApplicationDeltaHealthPolicy

定义一个增量运行状况策略,用于在升级群集时评估应用程序或其子实体的运行状况。

ApplicationHealthPolicy

定义用于评估应用程序或其子实体之一运行状况的运行状况策略。

ApplicationMetricDescription

描述自定义资源均衡指标的容量信息。 这可用于限制此应用程序的服务对此指标的总消耗量。

ApplicationResource

应用程序资源。

ApplicationResourceList

应用程序资源的列表。

ApplicationResourceProperties

应用程序资源属性。

ApplicationResourceUpdate

用于修补操作的应用程序资源。

ApplicationResourceUpdateProperties

修补操作的应用程序资源属性。

ApplicationTypeResource

应用程序类型名称资源

ApplicationTypeResourceList

应用程序类型名称的列表。

ApplicationTypeVersionResource

指定应用程序类型名称资源的应用程序类型版本资源。

ApplicationTypeVersionResourceList

指定应用程序类型名称资源的应用程序类型版本资源列表。

ApplicationTypeVersions

表示 ApplicationTypeVersions 的接口。

ApplicationTypeVersionsCleanupPolicy
ApplicationTypeVersionsCreateOrUpdateOptionalParams

可选参数。

ApplicationTypeVersionsDeleteOptionalParams

可选参数。

ApplicationTypeVersionsGetOptionalParams

可选参数。

ApplicationTypeVersionsListNextOptionalParams

可选参数。

ApplicationTypeVersionsListOptionalParams

可选参数。

ApplicationTypes

表示 ApplicationTypes 的接口。

ApplicationTypesCreateOrUpdateOptionalParams

可选参数。

ApplicationTypesDeleteOptionalParams

可选参数。

ApplicationTypesGetOptionalParams

可选参数。

ApplicationTypesListNextOptionalParams

可选参数。

ApplicationTypesListOptionalParams

可选参数。

ApplicationUpgradePolicy

描述受监视的应用程序升级的策略。

ApplicationUserAssignedIdentity
Applications

表示应用程序的接口。

ApplicationsCreateOrUpdateOptionalParams

可选参数。

ApplicationsDeleteOptionalParams

可选参数。

ApplicationsGetOptionalParams

可选参数。

ApplicationsListNextOptionalParams

可选参数。

ApplicationsListOptionalParams

可选参数。

ApplicationsUpdateOptionalParams

可选参数。

ArmApplicationHealthPolicy

定义用于评估应用程序或其子实体之一运行状况的运行状况策略。

ArmRollingUpgradeMonitoringPolicy

用于监视应用程序升级的策略

ArmServiceTypeHealthPolicy

代表的运行状况策略用于评估属于某个服务类型的服务的运行状况。

AvailableOperationDisplay

Service Fabric 资源提供程序支持的操作

AzureActiveDirectory

用于在群集上启用 AAD 身份验证的设置。

CertificateDescription

描述证书详细信息。

ClientCertificateCommonName

使用公用名描述客户端证书详细信息。

ClientCertificateThumbprint

使用指纹描述客户端证书详细信息。

Cluster

群集资源

ClusterCodeVersionsListResult

Service Fabric 运行时版本的列表结果。

ClusterCodeVersionsResult

Service Fabric 运行时版本的结果

ClusterHealthPolicy

定义用于评估群集或群集节点的运行状况的运行状况策略。

ClusterListResult

群集列表结果

ClusterUpdateParameters

群集更新请求

ClusterUpgradeDeltaHealthPolicy

介绍群集升级的增量运行状况策略。

ClusterUpgradePolicy

描述升级群集时使用的策略。

ClusterVersionDetails

Service Fabric 运行时版本结果的详细信息

ClusterVersions

表示 ClusterVersions 的接口。

ClusterVersionsGetByEnvironmentOptionalParams

可选参数。

ClusterVersionsGetOptionalParams

可选参数。

ClusterVersionsListByEnvironmentOptionalParams

可选参数。

ClusterVersionsListOptionalParams

可选参数。

Clusters

表示群集的接口。

ClustersCreateOrUpdateOptionalParams

可选参数。

ClustersDeleteOptionalParams

可选参数。

ClustersGetOptionalParams

可选参数。

ClustersListByResourceGroupNextOptionalParams

可选参数。

ClustersListByResourceGroupOptionalParams

可选参数。

ClustersListNextOptionalParams

可选参数。

ClustersListOptionalParams

可选参数。

ClustersListUpgradableVersionsOptionalParams

可选参数。

ClustersUpdateOptionalParams

可选参数。

DiagnosticsStorageAccountConfig

用于存储 Service Fabric 诊断日志的存储帐户信息。

EndpointRangeDescription

端口范围详细信息

ErrorModel

错误的结构。

ErrorModelError

错误详细信息。

ManagedIdentity

介绍 Azure 资源的托管标识。

NamedPartitionSchemeDescription

描述服务的命名分区方案。

NodeTypeDescription

描述群集中的节点类型,每个节点类型表示群集中的子节点集。

Notification

描述群集事件的通知通道。

NotificationTarget

描述通知目标属性。

OperationListResult

描述列出 Service Fabric 资源提供程序操作的请求的结果。

OperationResult

可用操作列表结果

Operations

表示操作的接口。

OperationsListNextOptionalParams

可选参数。

OperationsListOptionalParams

可选参数。

PartitionSchemeDescription

描述服务的分区方式。

ProxyResource

仅限代理的资源的资源模型定义。

Resource

资源模型定义。

ServerCertificateCommonName

使用公用名描述服务器证书详细信息。

ServerCertificateCommonNames

描述用于保护群集的公用名称引用的服务器证书的列表。

ServiceCorrelationDescription

在服务之间创建特定的关联。

ServiceFabricManagementClientOptionalParams

可选参数。

ServiceLoadMetricDescription

指定在运行时对服务进行负载均衡的指标。

ServicePlacementPolicyDescription

描述用于放置 Service Fabric 服务的策略。

ServiceResource

服务资源。

ServiceResourceList

服务资源的列表。

ServiceResourceProperties

服务资源属性。

ServiceResourcePropertiesBase

常见服务资源属性。

ServiceResourceUpdate

用于修补操作的服务资源。

ServiceResourceUpdateProperties

修补程序操作的服务资源属性。

ServiceTypeDeltaHealthPolicy

表示用于在升级群集时评估属于某个服务类型的服务的运行状况的增量运行状况策略。

ServiceTypeHealthPolicy

代表的运行状况策略用于评估属于某个服务类型的服务的运行状况。

Services

表示服务的接口。

ServicesCreateOrUpdateOptionalParams

可选参数。

ServicesDeleteOptionalParams

可选参数。

ServicesGetOptionalParams

可选参数。

ServicesListNextOptionalParams

可选参数。

ServicesListOptionalParams

可选参数。

ServicesUpdateOptionalParams

可选参数。

SettingsParameterDescription

描述群集结构设置中的参数。

SettingsSectionDescription

介绍群集的结构设置中的一节。

SingletonPartitionSchemeDescription

SingletonPartitionSchemeDescription

StatefulServiceProperties

有状态服务资源的属性。

StatefulServiceUpdateProperties

修补程序操作的有状态服务资源的属性。

StatelessServiceProperties

无状态服务资源的属性。

StatelessServiceUpdateProperties

用于修补操作的无状态服务资源的属性。

SystemData

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

UniformInt64RangePartitionSchemeDescription

描述一种分区方案,其中整数范围在多个分区中均匀分配。

UpgradableVersionPathResult

升级或降级的中间群集代码版本列表。 如果未指定目标,则为最小和最大可升级版本

UpgradableVersionsDescription
UserAssignedIdentity

类型别名

AddOnFeatures

定义 AddOnFeatures 的值。
KnownAddOnFeatures 可与 AddOnFeatures 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

RepairManager
DnsService
BackupRestoreService
ResourceMonitorService

ApplicationTypeVersionsCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

ApplicationTypeVersionsGetResponse

包含获取操作的响应数据。

ApplicationTypeVersionsListNextResponse

包含 listNext 操作的响应数据。

ApplicationTypeVersionsListResponse

包含列表操作的响应数据。

ApplicationTypesCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

ApplicationTypesGetResponse

包含获取操作的响应数据。

ApplicationTypesListNextResponse

包含 listNext 操作的响应数据。

ApplicationTypesListResponse

包含列表操作的响应数据。

ApplicationsCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

ApplicationsGetResponse

包含获取操作的响应数据。

ApplicationsListNextResponse

包含 listNext 操作的响应数据。

ApplicationsListResponse

包含列表操作的响应数据。

ApplicationsUpdateResponse

包含更新操作的响应数据。

ArmServicePackageActivationMode

定义 ArmServicePackageActivationMode 的值。
KnownArmServicePackageActivationMode 可与 ArmServicePackageActivationMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

SharedProcess:指示应用程序包激活模式将使用共享进程。
ExclusiveProcess:指示应用程序包激活模式将使用独占进程。

ArmUpgradeFailureAction

定义 ArmUpgradeFailureAction 的值。
KnownArmUpgradeFailureAction 可与 ArmUpgradeFailureAction 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

回滚:指示如果升级失败,Service Fabric 将执行升级回滚。
手动:指示如果升级失败,管理员需要执行手动修复。 Service Fabric 不会自动转到下一个升级域。

ClusterEnvironment

定义 ClusterEnvironment 的值。
KnownClusterEnvironment 可与 ClusterEnvironment 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Windows
Linux

ClusterState

定义 ClusterState 的值。
KnownClusterState 可与 ClusterState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

WaitingForNodes
正在部署
BaselineUpgrade
UpdateingUserConfiguration
UpdateingUserCertificate
UpdateingInfrastructure
强制实施ClusterVersion
UpgradeServiceUnreachable
自动缩放
就绪

ClusterUpgradeCadence

定义 ClusterUpgradeCadence 的值。
KnownClusterUpgradeCadence 可与 ClusterUpgradeCadence 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Wave0:推出新版本后,群集升级会立即启动。建议用于测试/开发群集。
Wave1:推出新版本后 7 天开始群集升级。建议用于预生产群集。
Wave2:推出新版本后 14 天开始群集升级。建议用于生产群集。

ClusterVersionsEnvironment

定义 ClusterVersionsEnvironment 的值。
KnownClusterVersionsEnvironment 可与 ClusterVersionsEnvironment 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Windows
Linux

ClusterVersionsGetByEnvironmentResponse

包含 getByEnvironment 操作的响应数据。

ClusterVersionsGetResponse

包含获取操作的响应数据。

ClusterVersionsListByEnvironmentResponse

包含 listByEnvironment 操作的响应数据。

ClusterVersionsListResponse

包含列表操作的响应数据。

ClustersCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

ClustersGetResponse

包含获取操作的响应数据。

ClustersListByResourceGroupNextResponse

包含 listByResourceGroupNext 操作的响应数据。

ClustersListByResourceGroupResponse

包含 listByResourceGroup 操作的响应数据。

ClustersListNextResponse

包含 listNext 操作的响应数据。

ClustersListResponse

包含列表操作的响应数据。

ClustersListUpgradableVersionsResponse

包含 listUpgradableVersions 操作的响应数据。

ClustersUpdateResponse

包含更新操作的响应数据。

DurabilityLevel

定义 DurabilityLevel 的值。
KnownDurabilityLevel 可与 DurabilityLevel 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Bronze
Silver
Gold

ManagedIdentityType

定义 ManagedIdentityType 的值。

MoveCost

定义 MoveCost 的值。
KnownMoveCost 可与 MoveCost 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

:零移动成本。 此值为零。
:将服务的移动成本指定为“低”。 值为 1。
中等:将服务的移动成本指定为“中等”。 值为 2。
:将服务的移动成本指定为“高”。 值为 3。

NotificationCategory

定义 NotificationCategory 的值。
KnownNotificationCategory 可与 NotificationCategory 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

WaveProgress:通知将涉及波形进度。

NotificationChannel

定义 NotificationChannel 的值。
KnownNotificationChannel 可与 NotificationChannel 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

EmailUser:电子邮件用户接收方。 在这种情况下,参数接收方应该是将接收通知的电子邮件地址的列表。
EmailSubscription:适用于订阅接收方。 在这种情况下,参数接收器应该是群集 (订阅的角色列表。将接收通知的所有者、AccountAdmin 等) 。

NotificationLevel

定义 NotificationLevel 的值。
KnownNotificationLevel 可与 NotificationLevel 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

严重:仅接收关键通知。
全部:接收所有通知。

OperationsListNextResponse

包含 listNext 操作的响应数据。

OperationsListResponse

包含列表操作的响应数据。

PartitionScheme

定义 PartitionScheme 的值。
KnownPartitionScheme 可与 PartitionScheme 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效:指示分区类型无效。 所有 Service Fabric 枚举的类型无效。 值为 0。
单一实例:指示分区基于字符串名称,并且是 SingletonPartitionSchemeDescription 对象,值为 1。
UniformInt64Range:指示分区基于 Int64 键范围,并且是 UniformInt64RangePartitionSchemeDescription 对象。 值为 2。
命名:指示分区基于字符串名称,是一个 NamedPartitionSchemeDescription 对象。 值为 3

PartitionSchemeDescriptionUnion
ProvisioningState

定义 ProvisioningState 的值。
KnownProvisioningState 可与 ProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

更新
成功
已失败
已取消

ReliabilityLevel

定义 ReliabilityLevel 的值。
KnownReliabilityLevel 可与 ReliabilityLevel 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值


Bronze
Silver
Gold
Platinum

RollingUpgradeMode

定义 RollingUpgradeMode 的值。
KnownRollingUpgradeMode 可与 RollingUpgradeMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效:指示升级模式无效。 所有 Service Fabric 枚举的类型无效。 值为 0。
UnmonitoredAuto:升级将自动继续进行,无需执行任何运行状况监视。 值为 1
UnmonitoredManual:升级将在完成每个升级域后停止,从而有机会在继续之前手动监视运行状况。 值为 2
受监视:升级将在完成每个升级域后停止,并在继续之前自动监视运行状况。 值为 3

ServiceCorrelationScheme

定义 ServiceCorrelationScheme 的值。
KnownServiceCorrelationScheme 可与 ServiceCorrelationScheme 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效:关联方案无效。 不能使用。 值为 0。
相关性:指示此服务与另一个服务具有相关性关系。 为向后兼容而提供,请考虑首选 Aligned 或 NonAlignedAffinity 选项。 值为 1。
AlignedAffinity:对齐的相关性可确保关联服务的主要分区并置在同一节点上。 这是默认设置,与选择相关性方案相同。 值为 2。
NonAlignedAffinity:不对齐相关性保证每个服务的所有副本将放置在相同的节点上。 与对齐相关性不同,这并不能保证将并置特定角色的副本。 值为 3。

ServiceKind

定义 ServiceKind 的值。
KnownServiceKind 可与 ServiceKind 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效:指示服务类型无效。 所有 Service Fabric 枚举的类型无效。 值为 0。
无状态:不使用 Service Fabric 使其状态高度可用或可靠。 值为 1。
有状态:使用 Service Fabric 使其状态或部分状态高度可用且可靠。 值为 2。

ServiceLoadMetricWeight

定义 ServiceLoadMetricWeight 的值。
KnownServiceLoadMetricWeight 可与 ServiceLoadMetricWeight 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

:禁用此指标的资源均衡。 此值为零。
:将服务负载的指标权重指定为低。 值为 1。
:将服务负载的指标权重指定为“中等”。 值为 2。
:将服务负载的指标权重指定为“高”。 值为 3。

ServicePlacementPolicyType

定义 ServicePlacementPolicyType 的值。
KnownServicePlacementPolicyType 可与 ServicePlacementPolicyType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

无效:指示放置策略的类型无效。 所有 Service Fabric 枚举的类型都无效。 值为 0。
InvalidDomain:指示 ServicePlacementPolicyDescription 的类型为 ServicePlacementInvalidDomainPolicyDescription,指示特定容错域或升级域不能用于放置此服务。 值为 1。
RequiredDomain:指示 ServicePlacementPolicyDescription 的类型为 ServicePlacementRequireDomainDistributionPolicyDescription,指示服务的副本必须放置在特定的域中。 值为 2。
PreferredPrimaryDomain:指示 ServicePlacementPolicyDescription 的类型为 ServicePlacementPreferPrimaryDomainPolicyDescription,指示服务分区的主副本 (replica) 应尽可能作为优化位于特定域中。 值为 3。
RequiredDomainDistribution:指示 ServicePlacementPolicyDescription 的类型为 ServicePlacementRequireDomainDistributionPolicyDescription,指示系统将禁止在任何时间在同一个域中的同一分区中放置任何两个副本。 值为 4。
NonPartiallyPlaceService:指示 ServicePlacementPolicyDescription 的类型为 ServicePlacementNonPartiallyPlaceServicePolicyDescription,指示如果可能,服务的特定分区的所有副本都应以原子方式放置。 值为 5。

ServiceResourcePropertiesUnion
ServiceResourceUpdatePropertiesUnion
ServicesCreateOrUpdateResponse

包含 createOrUpdate 操作的响应数据。

ServicesGetResponse

包含获取操作的响应数据。

ServicesListNextResponse

包含 listNext 操作的响应数据。

ServicesListResponse

包含列表操作的响应数据。

ServicesUpdateResponse

包含更新操作的响应数据。

SfZonalUpgradeMode

定义 SfZonalUpgradeMode 的值。
KnownSfZonalUpgradeMode 可与 SfZonalUpgradeMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

并行:节点类型下的 VM 分组到 UD 中,并忽略五个 UD 中的区域信息。 此设置会导致所有区域中的 UD 同时升级。 此部署模式用于升级速度会更快,但不建议使用,因为它违反了 SDP 准则,该准则规定一次只能对一个区域应用更新。
分层:如果省略此值或设置为“分层”,则会对 VM 进行分组,以反映最多 15 个 UD 中的区域分布。 三个区域各有五个 UD。 这样可以确保一次更新一个区域,仅在第一个区域内完成五个 UD 之后才移动到下一个区域。 此更新过程对于群集和用户应用程序更安全。

StoreName

定义 StoreName 的值。
KnownStoreName 可与 StoreName 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

通讯簿
AuthRoot
CertificateAuthority
禁止

Root
TrustedPeople
TrustedPublisher

UpgradeMode

定义 UpgradeMode 的值。
KnownUpgradeMode 可与 UpgradeMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

自动:群集将自动升级到最新的 Service Fabric 运行时版本, upgradeWave 将在新版本可用后确定升级何时开始。
手动:群集不会自动升级到最新的 Service Fabric 运行时版本。 通过在群集资源中设置 clusterCodeVersion 属性来升级群集。

VmssZonalUpgradeMode

定义 VmssZonalUpgradeMode 的值。
KnownVmssZonalUpgradeMode 可与 VmssZonalUpgradeMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

并行:对于虚拟机规模集,所有可用性区域中都会同时发生汇报。
分层:VM 分组以反映最多 15 个 UD 中的区域分布。 三个区域各有五个 UD。 这样可以确保一次更新一个区域,仅在第一个区域内完成五个 UD 之后才移动到下一个区域。

枚举

KnownAddOnFeatures

服务接受的 AddOnFeatures 的已知值。

KnownArmServicePackageActivationMode

服务接受的 ArmServicePackageActivationMode 的已知值。

KnownArmUpgradeFailureAction

服务接受的 ArmUpgradeFailureAction 的已知值。

KnownClusterEnvironment

服务接受的 ClusterEnvironment 的已知值。

KnownClusterState

服务接受的 ClusterState 的已知值。

KnownClusterUpgradeCadence

服务接受的 ClusterUpgradeCadence 的已知值。

KnownClusterVersionsEnvironment

服务接受的 ClusterVersionsEnvironment 的已知值。

KnownDurabilityLevel

服务接受的 DurabilityLevel 的已知值。

KnownMoveCost

服务接受的 MoveCost 的已知值。

KnownNotificationCategory

服务接受的 NotificationCategory 的已知值。

KnownNotificationChannel

服务接受的 NotificationChannel 的已知值。

KnownNotificationLevel

服务接受的 NotificationLevel 的已知值。

KnownPartitionScheme

服务接受的 PartitionScheme 的已知值。

KnownProvisioningState

服务接受的 ProvisioningState 的已知值。

KnownReliabilityLevel

服务接受的 ReliabilityLevel 的已知值。

KnownRollingUpgradeMode

服务接受的 RollingUpgradeMode 的 已知值。

KnownServiceCorrelationScheme

服务接受的 ServiceCorrelationScheme 的已知值。

KnownServiceKind

服务接受的 ServiceKind 的已知值。

KnownServiceLoadMetricWeight

服务接受的 ServiceLoadMetricWeight 的已知值。

KnownServicePlacementPolicyType

服务接受的 ServicePlacementPolicyType 的已知值。

KnownSfZonalUpgradeMode

服务接受的 SfZonalUpgradeMode 的已知值。

KnownStoreName

服务接受的 StoreName 的已知值。

KnownUpgradeMode

服务接受的 UpgradeMode 的已知值。

KnownVmssZonalUpgradeMode

服务接受的 VmssZonalUpgradeMode 的已知值。

函数

getContinuationToken(unknown)

给定迭代器生成的byPage最后.value一个,将返回一个可用于稍后从该点开始分页的延续标记。

函数详细信息

getContinuationToken(unknown)

给定迭代器生成的byPage最后.value一个,将返回一个可用于稍后从该点开始分页的延续标记。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

从迭代器访问 value IteratorResult byPage 的对象。

返回

string | undefined

在将来调用期间可以传递到 byPage () 的延续标记。