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

Applications - Get

获取 Service Fabric 应用程序资源。
获取在 Service Fabric 群集资源中创建或正在创建过程中的 Service Fabric 应用程序资源。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}/applications/{applicationName}?api-version=2019-11-01-preview

URI 参数

Name In Required Type Description
applicationName
path True
  • string

应用程序资源的名称。

clusterName
path True
  • string

群集资源的名称。

resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

客户订阅标识符。

api-version
query True
  • string

Service Fabric 资源提供程序 API 的版本。 这是一个必需的参数,对于此规范,该值必须为“2019-11-01-preview”。

响应

Name Type Description
200 OK

操作已成功完成。

Other Status Codes

详细的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get an application

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp?api-version=2019-11-01-preview

Sample Response

{
  "type": "applications",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp",
  "name": "myCluster",
  "tags": {},
  "etag": "W/\"636462502180261859\"",
  "properties": {
    "provisioningState": "Updating",
    "typeName": "myAppType",
    "typeVersion": "1.0",
    "parameters": {
      "param1": "value1"
    },
    "upgradePolicy": {
      "upgradeMode": "Monitored",
      "applicationHealthPolicy": {
        "considerWarningAsError": true,
        "maxPercentUnhealthyDeployedApplications": 0,
        "defaultServiceTypeHealthPolicy": {
          "maxPercentUnhealthyServices": 0,
          "maxPercentUnhealthyPartitionsPerService": 0,
          "maxPercentUnhealthyReplicasPerPartition": 0
        }
      },
      "rollingUpgradeMonitoringPolicy": {
        "failureAction": "Rollback",
        "healthCheckRetryTimeout": "00:10:00",
        "healthCheckWaitDuration": "00:02:00",
        "healthCheckStableDuration": "00:05:00",
        "upgradeDomainTimeout": "1.06:00:00",
        "upgradeTimeout": "01:00:00"
      },
      "upgradeReplicaSetCheckTimeout": "01:00:00",
      "forceRestart": false
    },
    "maximumNodes": 3,
    "minimumNodes": 1,
    "removeApplicationCapacity": false,
    "metrics": [
      {
        "name": "metric1",
        "reservationCapacity": 1,
        "maximumCapacity": 3,
        "totalApplicationCapacity": 5
      }
    ]
  }
}

定义

ApplicationMetricDescription

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

ApplicationResource

应用程序资源。

ApplicationUpgradePolicy

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

ApplicationUserAssignedIdentity
ArmApplicationHealthPolicy

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

ArmRollingUpgradeMonitoringPolicy

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

ArmServiceTypeHealthPolicy

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

ArmUpgradeFailureAction

服务包的激活模式

ErrorModel

错误的结构。

ErrorModelError

错误详细信息。

ManagedIdentity

描述 Azure 资源的托管标识。

ManagedIdentityType

资源的托管标识的类型。

RollingUpgradeMode

在滚动升级期间用于监视运行状况的模式。 这些值为 UnmonitoredAuto、UnmonitoredManual 和 Monitored。

UserAssignedIdentity

ApplicationMetricDescription

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

Name Type Description
maximumCapacity
  • integer

Service Fabric 应用程序的最大节点容量。 这是单个节点上此应用程序的实例的最大负载。 即使节点容量大于此值,Service Fabric 也会将应用程序内服务的总负载限制为此值。 如果设置为零,则每个节点上此指标的容量不受限制。 使用定义应用程序容量的新应用程序时,MaximumNodes 的乘积必须始终小于或等于 TotalApplicationCapacity。 使用应用程序容量更新现有应用程序时,MaximumNodes 和此值必须始终小于或等于 TotalApplicationCapacity。

name
  • string

指标的名称。

reservationCapacity
  • integer

Service Fabric 应用程序的节点预留容量。 这是在具有此应用程序的实例的节点上保留的负载量。 如果指定 MinimumNodes,则这些值的乘积将为应用程序在群集中保留的容量。 如果设置为零,则不保留此指标的容量。 设置应用程序容量或更新应用程序容量时;此值必须小于或等于每个指标的 MaximumCapacity。

totalApplicationCapacity
  • integer

Service Fabric 应用程序的总指标容量。 这是群集中此应用程序的总指标容量。 Service Fabric 将尝试将应用程序中的服务负载之和限制为此值。 使用定义应用程序容量的新应用程序时,MaximumNodes 和 MaximumCapacity 的产品必须始终小于或等于此值。

ApplicationResource

应用程序资源。

Name Type Default Value Description
etag
  • string

Azure 资源 etag。

id
  • string

Azure 资源标识符。

identity

描述 Azure 资源的托管标识。

location
  • string

它将弃用在新 API 中,资源位置取决于父资源。

name
  • string

Azure 资源名称。

properties.managedIdentities

应用程序的用户分配标识列表,每个标识都映射到友好名称。

properties.maximumNodes
  • integer
0

Service Fabric 为此应用程序保留的容量的最大节点数。 请注意,这并不表示此应用程序的服务放置在所有这些节点上。 默认情况下,此属性的值为零,这意味着服务可以放置在任何节点上。

properties.metrics

应用程序容量指标说明的列表。

properties.minimumNodes
  • integer

Service Fabric 为此应用程序保留的容量的最小节点数。 请注意,这并不表示此应用程序的服务放置在所有这些节点上。 如果此属性设置为零,则不会保留容量。 此属性的值不能超过 MaximumNodes 属性的值。

properties.parameters
  • object

应用程序参数列表,其中包含应用程序清单中指定的默认值中的重写值。

properties.provisioningState
  • string

当前部署或预配状态,仅在响应中显示

properties.removeApplicationCapacity
  • boolean

删除当前应用程序容量设置。

properties.typeName
  • string

应用程序清单中定义的应用程序类型名称。

properties.typeVersion
  • string

应用程序清单中定义的应用程序类型的版本。

properties.upgradePolicy

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

tags
  • object

Azure 资源标记。

type
  • string

Azure 资源类型。

ApplicationUpgradePolicy

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

Name Type Default Value Description
applicationHealthPolicy

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

forceRestart
  • boolean
False

如果为 true,则在升级期间会强制重启进程,即使代码版本未更改, (升级只会更改配置或数据) 。

recreateApplication
  • boolean

确定是否应在更新时重新创建应用程序。 如果 value=true,则不允许其余升级策略参数,这将导致可用性丢失。

rollingUpgradeMonitoringPolicy

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

upgradeMode Monitored

在滚动升级期间用于监视运行状况的模式。 这些值为 UnmonitoredAuto、UnmonitoredManual 和 Monitored。

upgradeReplicaSetCheckTimeout
  • string

出现意外问题时,阻止处理升级域并防止可用性丢失的最大时长。 当此超时到期时,无论是否存在可用性丢失问题,都将继续处理升级域。 每个升级域启动时重置超时。 有效值介于 0 和 42949672925(含)之间。 (无符号 32 位整数) 。

ApplicationUserAssignedIdentity

Name Type Description
name
  • string

用户分配标识的友好名称。

principalId
  • string

用户分配标识的主体 ID。

ArmApplicationHealthPolicy

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

Name Type Default Value Description
considerWarningAsError
  • boolean
False

指示是否将警告的严重性视为与错误相同。

defaultServiceTypeHealthPolicy

默认情况下用于评估服务类型的运行状况的运行状况策略。

maxPercentUnhealthyDeployedApplications
  • integer
0

允许的已部署的不正常应用程序的最大百分比。 允许的值是字节值,从零到 100。 该百分比表示在应用程序被视为错误之前可以运行不正常的已部署应用程序的最大容忍百分比。 这是通过将不正常部署的应用程序数除以群集中当前部署应用程序的节点数来计算的。 计算结果调高为整数,以便容忍少量节点上出现一次失败。 默认百分比为零。

serviceTypeHealthPolicyMap

每个服务类型名称具有服务类型运行状况策略的映射。 映射默认为空。

ArmRollingUpgradeMonitoringPolicy

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

Name Type Default Value Description
failureAction

服务包的激活模式

healthCheckRetryTimeout
  • string
PT0H10M0S

执行 FailureAction 前,当应用程序或群集不正常时,重试运行状况评估所需的时间。 首先,会将其解释为表示 ISO 8601 持续时间的一个字符串。 如果那失败,则会将其解释为表示总毫秒数的一个数字。

healthCheckStableDuration
  • string
PT0H2M0S

升级继续到下一升级域之前,应用程序或群集必须保持正常的时长。 首先,会将其解释为表示 ISO 8601 持续时间的一个字符串。 如果那失败,则会将其解释为表示总毫秒数的一个数字。

healthCheckWaitDuration
  • string
0

应用运行状况策略之前,完成升级域后等待的时间长度。 首先,会将其解释为表示 ISO 8601 持续时间的一个字符串。 如果那失败,则会将其解释为表示总毫秒数的一个数字。

upgradeDomainTimeout
  • string
P10675199DT02H48M05.4775807S

执行 FailureAction 前,每个升级域需等待的时长。 首先,会将其解释为表示 ISO 8601 持续时间的一个字符串。 如果那失败,则会将其解释为表示总毫秒数的一个数字。

upgradeTimeout
  • string
P10675199DT02H48M05.4775807S

执行 FailureAction 前,完成整个升级需等待的时长。 首先,会将其解释为表示 ISO 8601 持续时间的一个字符串。 如果那失败,则会将其解释为表示总毫秒数的一个数字。

ArmServiceTypeHealthPolicy

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

Name Type Default Value Description
maxPercentUnhealthyPartitionsPerService
  • integer
0

在应用程序被视为错误之前,每个服务允许运行不正常的分区的最大百分比。

maxPercentUnhealthyReplicasPerPartition
  • integer
0

在应用程序被视为错误之前,每个分区允许运行不正常的副本的最大百分比。

maxPercentUnhealthyServices
  • integer
0

在应用程序被视为错误之前允许运行不正常的服务的最大百分比。

ArmUpgradeFailureAction

服务包的激活模式

Name Type Description
Manual
  • string

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

Rollback
  • string

指示升级失败时,Service Fabric 将执行升级回滚。

ErrorModel

错误的结构。

Name Type Description
error

错误详细信息。

ErrorModelError

错误详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息。

ManagedIdentity

描述 Azure 资源的托管标识。

Name Type Description
principalId
  • string

托管标识的主体 ID。 此属性仅适用于系统分配的标识。

tenantId
  • string

托管标识的租户 ID。 此属性仅适用于系统分配的标识。

type

资源的托管标识的类型。

userAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

ManagedIdentityType

资源的托管标识的类型。

Name Type Description
None
  • string

指示没有与资源关联的标识。

SystemAssigned
  • string

指示系统分配的标识与资源相关联。

SystemAssigned, UserAssigned
  • string

指示系统分配标识和用户分配标识都与资源相关联。

UserAssigned
  • string

指示用户分配的标识与资源相关联。

RollingUpgradeMode

在滚动升级期间用于监视运行状况的模式。 这些值为 UnmonitoredAuto、UnmonitoredManual 和 Monitored。

Name Type Description
Invalid
  • string

指示升级模式无效。 所有 Service Fabric 枚举都具有无效的类型。 值为 0。

Monitored
  • string

升级将在完成每个升级域后停止,并在继续之前自动监视运行状况。 值为 3

UnmonitoredAuto
  • string

升级将自动进行,而无需执行任何运行状况监视。 值为 1

UnmonitoredManual
  • string

升级将在完成每个升级域后停止,从而有机会在继续之前手动监视运行状况。 值为 2

UserAssignedIdentity

Name Type Description
clientId
  • string

用户分配标识的客户端 ID。

principalId
  • string

用户分配标识的主体 ID。