Puppet Task: servicefabric_azure_get_service_description

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

Overview

Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.

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.
service_id (Optional[String[1]]) — The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.Starting from version 6.0, hierarchical names are delimited with the '~' character.For example, if the service name is 'fabric:/myapp/app1/svc1', the service identity would be 'myapp~app1~svc1' in 6.0+ and 'myapp/app1/svc1' in previous versions.
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.
error (Optional[String[1]]) — Error object containing error code and error message.