Puppet Task: servicefabric_azure_get_service_info
- Defined in:
-
tasks/servicefabric_azure_get_service_info.json,
tasks/servicefabric_azure_get_service_info.rb
Overview
Returns the information about the specified service belonging to the specified Service Fabric application.
Supports noop? false
Parameters
- isservicegroup (Optional[String[1]]) — Whether the service is in a service group.
- id (Optional[String[1]]) — The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.Starting in 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.
- servicekind (Optional[String[1]]) — The kind of service (Stateless or Stateful).
- manifestversion (Optional[String[1]]) — The version of the service manifest.
- servicestatus (Optional[String[1]]) — The status of the application.
- 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.
- 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.
- name (Optional[String[1]]) — The full name of the service with 'fabric:' URI scheme.
- typename (Optional[String[1]]) — Name of the service type as specified in the service manifest.
- healthstate (Optional[String[1]]) — The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
- application_id (Optional[String[1]]) — The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.Starting from version 6.0, hierarchical names are delimited with the '~' character.For example, if the application name is 'fabric:/myapp/app1', the application identity would be 'myapp~app1' in 6.0+ and 'myapp/app1' in previous versions.
- 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.