compose_deployment_status_lists
Creates, updates, deletes, gets or lists a compose_deployment_status_lists resource.
Overview
| Name | compose_deployment_status_lists |
| Type | Resource |
| Id | azure.service_fabric_dataplane.compose_deployment_status_lists |
Fields
The following fields are returned by SELECT queries:
- get_compose_deployment_status_list
| Name | Datatype | Description |
|---|---|---|
ContinuationToken | string | |
Items | array |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_compose_deployment_status_list | select | endpoint | ContinuationToken, MaxResults, timeout | Gets the list of compose deployments created in the Service Fabric cluster. Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. |
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 |
|---|---|---|
endpoint | string | The service endpoint host (no scheme). (default: ) |
ContinuationToken | string | The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded. |
MaxResults | integer (int64) | The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. |
timeout | integer (int64) | 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. |
SELECT examples
- get_compose_deployment_status_list
Gets the list of compose deployments created in the Service Fabric cluster. Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page.
SELECT
ContinuationToken,
Items
FROM azure.service_fabric_dataplane.compose_deployment_status_lists
WHERE endpoint = '{{ endpoint }}' -- required
AND ContinuationToken = '{{ ContinuationToken }}'
AND MaxResults = '{{ MaxResults }}'
AND timeout = '{{ timeout }}'
;