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

Services - Update

参考

Service:: Service Fabric

API Version:: 2023-11-01-preview

汇报 Service Fabric 服务资源。
使用指定的名称更新 Service Fabric 服务资源。

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

URI 参数

名称	在	必需	类型	说明
applicationName	path	True	string	应用程序资源的名称。
clusterName	path	True	string	群集资源的名称。
resourceGroupName	path	True	string	资源组的名称。
serviceName	path	True	string	采用 {applicationName}~{serviceName} 格式的服务资源的名称。
subscriptionId	path	True	string	客户订阅标识符。
api-version	query	True	string	Service Fabric 资源提供程序 API 的版本。这是一个必需参数，对于此规范，其值必须为“2023-11-01-preview”。

请求正文

名称	必需	类型	说明
properties.serviceKind	True	ServiceKind	(无状态或有状态) 的服务类型。
location		string	它将在新 API 中弃用，资源位置取决于父资源。
properties.correlationScheme		ServiceCorrelationDescription[]	描述服务与其他服务的相关性的列表。
properties.defaultMoveCost		MoveCost	指定服务的移动成本。
properties.placementConstraints		string	字符串形式的放置约束。放置约束是节点属性中的布尔表达式，用于根据服务要求将服务限制到特定的节点。例如，若要在 NodeType 为蓝色的节点上放置服务，请指定以下内容：“NodeColor == blue) ”。
properties.serviceLoadMetrics		ServiceLoadMetricDescription[]	服务负载指标作为 ServiceLoadMetricDescription 对象的数组提供。
properties.servicePlacementPolicies		ServicePlacementPolicyDescription[]	描述服务与其他服务的相关性的列表。
tags		object	Azure 资源标记。

响应

名称	类型	说明
202 Accepted	ServiceResource	请求已接受，操作将以异步方式完成。
Other Status Codes	ErrorModel	详细的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Patch a service

Sample Request

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

{
  "tags": {},
  "properties": {
    "serviceKind": "Stateless",
    "serviceLoadMetrics": [
      {
        "name": "metric1",
        "weight": "Low"
      }
    ]
  }
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicefabric import ServiceFabricManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicefabric
# USAGE
    python service_patch_operation_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceFabricManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.services.begin_update(
        resource_group_name="resRg",
        cluster_name="myCluster",
        application_name="myApp",
        service_name="myService",
        parameters={
            "properties": {"serviceKind": "Stateless", "serviceLoadMetrics": [{"name": "metric1", "weight": "Low"}]},
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ServicePatchOperation_example.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ServiceFabric;
using Azure.ResourceManager.ServiceFabric.Models;

// Generated from example definition: specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2023-11-01-preview/examples/ServicePatchOperation_example.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceFabricServiceResource created on azure
// for more information of creating ServiceFabricServiceResource, please refer to the document of ServiceFabricServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "resRg";
string clusterName = "myCluster";
string applicationName = "myApp";
string serviceName = "myService";
ResourceIdentifier serviceFabricServiceResourceId = ServiceFabricServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName, applicationName, serviceName);
ServiceFabricServiceResource serviceFabricService = client.GetServiceFabricServiceResource(serviceFabricServiceResourceId);

// invoke the operation
ServiceFabricServicePatch patch = new ServiceFabricServicePatch(new AzureLocation("placeholder"))
{
    ServiceLoadMetrics =
    {
    new ServiceLoadMetricDescription("metric1")
    {
    Weight = ServiceLoadMetricWeight.Low,
    }
    },
    Tags =
    {
    },
};
ArmOperation<ServiceFabricServiceResource> lro = await serviceFabricService.UpdateAsync(WaitUntil.Completed, patch);
ServiceFabricServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ServiceFabricServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 202

Retry-After: 10
Location: http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/4dde8d8b-b6b2-4c56-99c6-9b83932bb09a?api-version=2023-11-01-preview

Response Body

{
  "type": "services",
  "location": "eastus",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApp/services/myService",
  "name": "myCluster",
  "tags": {},
  "etag": "W/\"636462502183671257\"",
  "properties": {
    "provisioningState": "Updating",
    "serviceKind": "Stateless",
    "serviceTypeName": "myServiceType",
    "partitionDescription": {
      "partitionScheme": "Singleton"
    },
    "serviceLoadMetrics": [
      {
        "name": "metric1",
        "weight": "Low"
      }
    ],
    "instanceCount": 1,
    "servicePackageActivationMode": "SharedProcess"
  }
}

定义

名称	说明
ArmServicePackageActivationMode	服务包的激活模式
ErrorModel	错误的结构。
ErrorModelError	错误详细信息。
MoveCost	指定服务的移动成本。
NamedPartitionSchemeDescription	描述服务的命名分区方案。
PartitionScheme	枚举服务的分区方式。
ServiceCorrelationDescription	在服务之间创建特定的关联。
ServiceCorrelationScheme	服务关联方案。
ServiceKind	(无状态或有状态) 的服务类型。
ServiceLoadMetricDescription	指定在运行时对服务进行负载均衡的指标。
ServiceLoadMetricWeight	确定相对于为此服务配置的其他指标的指标权重。在运行时，如果两个指标最终冲突，则群集资源管理器优先选择权重较高的指标。
ServiceResource	服务资源。
ServiceResourceUpdate	用于修补操作的服务资源。
SingletonPartitionSchemeDescription	描述单一实例分区或非分区服务的分区方案。
SystemData	与资源的创建和上次修改相关的元数据。
UniformInt64RangePartitionSchemeDescription	描述一种分区方案，其中整数范围在多个分区之间均匀分配。

ArmServicePackageActivationMode

服务包的激活模式

名称	类型	说明
ExclusiveProcess	string	指示应用程序包激活模式将使用独占进程。
SharedProcess	string	指示应用程序包激活模式将使用共享进程。

ErrorModel

错误的结构。

名称	类型	说明
error	ErrorModelError	错误详细信息。

ErrorModelError

错误详细信息。

名称	类型	说明
code	string	错误代码。
message	string	错误消息。

MoveCost

指定服务的移动成本。

名称	类型	说明
High	string	将服务的移动成本指定为“高”。值为 3。
Low	string	将服务的移动成本指定为“低”。值为 1。
Medium	string	将服务的移动成本指定为“中等”。值为 2。
Zero	string	零移动成本。此值为零。

NamedPartitionSchemeDescription

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

名称	类型	说明
count	integer	分区数。
names	string[]	由分区名称的“count”参数指定的大小数组。
partitionScheme	string: Named	指定服务的分区方式。

PartitionScheme

枚举服务的分区方式。

名称	类型	说明
Invalid	string	指示分区类型无效。所有 Service Fabric 枚举的类型无效。值为 0。
Named	string	指示分区基于字符串名称，并且是 NamedPartitionSchemeDescription 对象。值为 3
Singleton	string	指示分区基于字符串名称，并且是 SingletonPartitionSchemeDescription 对象，值为 1。
UniformInt64Range	string	指示分区基于 Int64 键范围，并且是 UniformInt64RangePartitionSchemeDescription 对象。值为 2。

ServiceCorrelationDescription

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

名称	类型	说明
scheme	ServiceCorrelationScheme	ServiceCorrelationScheme，描述此服务与通过 ServiceName 指定的服务之间的关系。
serviceName	string	与之建立关联关系的服务的名称。

ServiceCorrelationScheme

服务关联方案。

名称	类型	说明
Affinity	string	指示此服务与其他服务具有相关性关系。为向后兼容而提供，请考虑首选 Aligned 或 NonAlignedAffinity 选项。值为 1。
AlignedAffinity	string	对齐的相关性可确保地缘服务分区的主要并置在同一节点上。这是默认值，与选择相关性方案相同。值为 2。
Invalid	string	无效的相关方案。不能使用。值为 0。
NonAlignedAffinity	string	不一致相关性保证每个服务的所有副本都将放在相同的节点上。与对齐相关性不同，这不能保证特定角色的副本将并置。值为 3。

ServiceKind

(无状态或有状态) 的服务类型。

名称	类型	说明
Invalid	string	指示服务类型无效。所有 Service Fabric 枚举的类型都无效。值为 0。
Stateful	string	使用 Service Fabric 使其状态或状态的一部分高度可用且可靠。值为 2。
Stateless	string	不使用 Service Fabric 使其状态高度可用或可靠。值为 1。

ServiceLoadMetricDescription

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

名称	类型	说明
defaultLoad	integer	仅用于无状态服务。此服务为此指标创建的默认负载量（数字）。
name	string	指标的名称。如果服务选择在运行时报告负载，则负载指标名称应与 Name 中指定的名称完全匹配。请注意，度量值名称区分大小写。
primaryDefaultLoad	integer	仅用于有状态服务。当此服务为主副本时为此度量值创建的默认负载量，以数字形式提供。
secondaryDefaultLoad	integer	仅用于有状态服务。当此服务为辅助副本时为此度量值创建的默认负载量，以数字形式提供。
weight	ServiceLoadMetricWeight	服务负载度量值的相对权重（相对于为此服务配置的其他度量值），以数字形式提供。

ServiceLoadMetricWeight

确定相对于为此服务配置的其他指标的指标权重。在运行时，如果两个指标最终冲突，则群集资源管理器优先选择权重较高的指标。

名称	类型	说明
High	string	将服务负载的指标权重指定为“高”。值为 3。
Low	string	将服务负载的指标权重指定为“低”。值为 1。
Medium	string	将服务负载的指标权重指定为“中等”。值为 2。
Zero	string	禁用此指标的资源均衡。此值为零。

ServiceResource

服务资源。

名称	类型	说明
etag	string	Azure 资源 etag。
id	string	Azure 资源标识符。
location	string	它将在新 API 中弃用，资源位置取决于父资源。
name	string	Azure 资源名称。
properties.correlationScheme	ServiceCorrelationDescription[]	描述服务与其他服务的相关性的列表。
properties.defaultMoveCost	MoveCost	指定服务的移动成本。
properties.partitionDescription	PartitionSchemeDescription: NamedPartitionSchemeDescription SingletonPartitionSchemeDescription UniformInt64RangePartitionSchemeDescription	描述服务的分区方式。
properties.placementConstraints	string	字符串形式的放置约束。放置约束是节点属性中的布尔表达式，用于根据服务要求将服务限制到特定的节点。例如，若要在 NodeType 为蓝色的节点上放置服务，请指定以下内容：“NodeColor == blue) ”。
properties.provisioningState	string	当前部署或预配状态，仅显示在响应中
properties.serviceDnsName	string	用于服务的 Dns 名称。如果指定了这一点，则 DNS 名称可用于返回应用程序层协议的服务终结点的 IP 地址 (例如 HTTP) 。更新 serviceDnsName 时，旧名称可能暂时可解析。但是，依赖于新名称。删除 serviceDnsName 时，删除的名称可能暂时可解析。不要依赖于无法解析的名称。
properties.serviceKind	ServiceKind	(无状态或有状态) 的服务类型。
properties.serviceLoadMetrics	ServiceLoadMetricDescription[]	服务负载指标以 ServiceLoadMetricDescription 对象的数组的形式提供。
properties.servicePackageActivationMode	ArmServicePackageActivationMode	服务包的激活模式
properties.servicePlacementPolicies	ServicePlacementPolicyDescription[]	描述服务与其他服务的相关性的列表。
properties.serviceTypeName	string	服务类型的名称
systemData	SystemData	与资源的创建和上次修改相关的元数据。
tags	object	Azure 资源标记。
type	string	Azure 资源类型。

ServiceResourceUpdate

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

名称	类型	说明
etag	string	Azure 资源 etag。
id	string	Azure 资源标识符。
location	string	它将在新 API 中弃用，资源位置取决于父资源。
name	string	Azure 资源名称。
properties.correlationScheme	ServiceCorrelationDescription[]	描述服务与其他服务的相关性的列表。
properties.defaultMoveCost	MoveCost	指定服务的移动成本。
properties.placementConstraints	string	字符串形式的放置约束。放置约束是节点属性中的布尔表达式，用于根据服务要求将服务限制到特定的节点。例如，若要在 NodeType 为蓝色的节点上放置服务，请指定以下内容：“NodeColor == blue) ”。
properties.serviceKind	ServiceKind	(无状态或有状态) 的服务类型。
properties.serviceLoadMetrics	ServiceLoadMetricDescription[]	服务负载指标以 ServiceLoadMetricDescription 对象的数组的形式提供。
properties.servicePlacementPolicies	ServicePlacementPolicyDescription[]	描述服务与其他服务的相关性的列表。
systemData	SystemData	与资源的创建和上次修改相关的元数据。
tags	object	Azure 资源标记。
type	string	Azure 资源类型。

SingletonPartitionSchemeDescription

描述单一实例分区或非分区服务的分区方案。

名称	类型	说明
partitionScheme	string: Singleton	指定服务的分区方式。

SystemData

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

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	string	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC) 。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	string	上次修改资源的标识类型。

UniformInt64RangePartitionSchemeDescription

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

名称	类型	说明
count	integer	分区数。
highKey	string	指示应在分区“count”之间拆分的分区键范围的上限的字符串
lowKey	string	指示应在分区“count”之间拆分的分区键范围的下限的字符串
partitionScheme	string: UniformInt64Range	指定服务的分区方式。