Update Service Arm Metadata
Updates the Arm Metadata for a specific service.
Updates the Arm Metadata for a specific service.
Request
| Method | Request URI |
|---|---|
| POST | /Services/{serviceId}/$/UpdateArmMetadata?api-version=9.0&timeout={timeout}&Force={Force} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
serviceId |
string | Yes | Path |
api-version |
string | Yes | Query |
timeout |
integer (int64) | No | Query |
Force |
boolean | No | Query |
ServiceArmMetadataUpdateDescription |
ArmMetadata | Yes | Body |
serviceId
Type: string
Required: Yes
The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.
Starting from version 6.0, hierarchical names are delimited with the "~" character.
For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
api-version
Type: string
Required: Yes
Default: 9.0
The version of the API. This parameter is required and its value must be '9.0'.
Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.
Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.
timeout
Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
Force
Type: boolean
Required: No
Force parameter used to prevent accidental Arm metadata update.
ServiceArmMetadataUpdateDescription
Type: ArmMetadata
Required: Yes
The Arm metadata to be assocated with a specific service
Responses
| HTTP Status Code | Description | Response Schema |
|---|---|---|
| 200 (OK) | A successful update will return 200 status code. |
|
| All other status codes | The detailed error response. |
FabricError |