Puppet Task: servicefabric_azure_get_sub_name_info_list

Defined in:: tasks/servicefabric_azure_get_sub_name_info_list.json,
tasks/servicefabric_azure_get_sub_name_info_list.rb

Overview

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.

Supports noop? false

Parameters

api_version (Optional[String[1]]) — 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.
name_id (Optional[String[1]]) — The Service Fabric name, without the 'fabric:' URI scheme.
recursive (Optional[String[1]]) — Allows specifying that the search performed should be recursive.
continuationtoken (Optional[String[1]]) — The continuation token parameter is used to obtain next set of results. The continuation token 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 is not included in the response.
timeout (Optional[String[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.
isconsistent (Optional[String[1]]) — Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false.
subnames (Optional[String[1]]) — List of the child names.