sub_name_info_lists
Creates, updates, deletes, gets or lists a sub_name_info_lists resource.
Overview
| Name | sub_name_info_lists |
| Type | Resource |
| Id | azure.service_fabric_dataplane.sub_name_info_lists |
Fields
The following fields are returned by SELECT queries:
- get_sub_name_info_list
| Name | Datatype | Description |
|---|---|---|
ContinuationToken | string | |
IsConsistent | boolean | |
SubNames | array |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_sub_name_info_list | select | name_id, endpoint | Recursive, ContinuationToken, timeout | Enumerates all the Service Fabric names under a given name. Enumerates all the Service Fabric names under a given name. If the subnames 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. Querying a name that doesn't exist will fail. |
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: ) |
name_id | string | The Service Fabric name, without the 'fabric:' URI scheme. |
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. |
Recursive | boolean | Allows specifying that the search performed should be recursive. |
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_sub_name_info_list
Enumerates all the Service Fabric names under a given name. Enumerates all the Service Fabric names under a given name. If the subnames 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. Querying a name that doesn't exist will fail.
SELECT
ContinuationToken,
IsConsistent,
SubNames
FROM azure.service_fabric_dataplane.sub_name_info_lists
WHERE name_id = '{{ name_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND Recursive = '{{ Recursive }}'
AND ContinuationToken = '{{ ContinuationToken }}'
AND timeout = '{{ timeout }}'
;