Delete Property
Deletes the specified Service Fabric property.
Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.
Request
| Method | Request URI |
|---|---|
| DELETE | /Names/{nameId}/$/GetProperty?api-version=6.0&PropertyName={PropertyName}&timeout={timeout} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
nameId |
string | Yes | Path |
api-version |
string | Yes | Query |
PropertyName |
string | Yes | Query |
timeout |
integer (int64) | No | Query |
nameId
Type: string
Required: Yes
The Service Fabric name, without the 'fabric:' URI scheme.
api-version
Type: string
Required: Yes
Default: 6.0
The version of the API. This parameter is required and its value must be '6.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 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 accept 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, but if the runtime is 6.1, in order to make it easier to write the clients, 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.
PropertyName
Type: string
Required: Yes
Specifies the name of the property to get.
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.
Responses
| HTTP Status Code | Description | Response Schema |
|---|---|---|
| 200 (OK) | A successful response means that the property has been deleted. |
|
| All other status codes | The detailed error response. |
FabricError |