service_replicas
Creates, updates, deletes, gets or lists a service_replicas resource.
Overview
| Name | service_replicas |
| Type | Resource |
| Id | azure.service_fabric_mesh.service_replicas |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
codePackages | array | Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). |
diagnostics | object | Reference to sinks in DiagnosticsDescription. |
networkRefs | array | The names of the private networks that this service needs to be part of. |
osType | string | The operation system required by the code in service. |
replicaName | string | Name of the replica. |
| Name | Datatype | Description |
|---|---|---|
codePackages | array | Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). |
diagnostics | object | Reference to sinks in DiagnosticsDescription. |
networkRefs | array | The names of the private networks that this service needs to be part of. |
osType | string | The operation system required by the code in service. |
replicaName | string | Name of the replica. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, applicationResourceName, serviceResourceName, replicaName | api-version | Gets the information about the service replica with the given name. The information include the description and other properties of the service replica. |
list | select | subscriptionId, resourceGroupName, applicationResourceName, serviceResourceName | api-version | Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
applicationResourceName | string | The identity of the application. |
replicaName | string | Service Fabric replica name. |
resourceGroupName | string | Azure resource group name |
serviceResourceName | string | The identity of the service. |
subscriptionId | string | The customer subscription identifier |
api-version | string | The version of the API. This parameter is required and its value must be 2018-09-01-preview. |
SELECT examples
- get
- list
Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.
SELECT
codePackages,
diagnostics,
networkRefs,
osType,
replicaName
FROM azure.service_fabric_mesh.service_replicas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND applicationResourceName = '{{ applicationResourceName }}' -- required
AND serviceResourceName = '{{ serviceResourceName }}' -- required
AND replicaName = '{{ replicaName }}' -- required
AND api-version = '{{ api-version }}'
;
Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.
SELECT
codePackages,
diagnostics,
networkRefs,
osType,
replicaName
FROM azure.service_fabric_mesh.service_replicas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND applicationResourceName = '{{ applicationResourceName }}' -- required
AND serviceResourceName = '{{ serviceResourceName }}' -- required
AND api-version = '{{ api-version }}'
;