getServices

The consul.getServices data source returns a list of Consul services that have been registered with the Consul cluster in a given datacenter. By specifying a different datacenter in the query_options it is possible to retrieve a list of services from a different WAN-attached Consul datacenter.

This data source is different from the consul.Service (singular) data source, which provides a detailed response about a specific Consul service.

Using getServices

function getServices(args: GetServicesArgs, opts?: InvokeOptions): Promise<GetServicesResult>
def get_services(query_options: Optional[Sequence[GetServicesQueryOption]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetServicesResult
func GetServices(ctx *Context, args *GetServicesArgs, opts ...InvokeOption) (*GetServicesResult, error)

Note: This function is named GetServices in the Go SDK.

public static class GetServices {
    public static Task<GetServicesResult> InvokeAsync(GetServicesArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

getServices Result

The following output properties are available:

Datacenter string
The datacenter the keys are being read from to.
Id string
The provider-assigned unique ID for this managed resource.
Names List<string>
Services Dictionary<string, string>
QueryOptions List<GetServicesQueryOption>
Datacenter string
The datacenter the keys are being read from to.
Id string
The provider-assigned unique ID for this managed resource.
Names []string
Services map[string]string
QueryOptions []GetServicesQueryOption
datacenter string
The datacenter the keys are being read from to.
id string
The provider-assigned unique ID for this managed resource.
names string[]
services {[key: string]: string}
queryOptions GetServicesQueryOption[]
datacenter str
The datacenter the keys are being read from to.
id str
The provider-assigned unique ID for this managed resource.
names Sequence[str]
services Mapping[str, str]
query_options Sequence[GetServicesQueryOption]

Supporting Types

GetServicesQueryOption

AllowStale bool
When true, the default, allow responses from Consul servers that are followers.
Datacenter string
The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to.
Namespace string
The namespace to lookup the services.
Near string
NodeMeta Dictionary<string, string>
RequireConsistent bool
When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
Token string
Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overriden if necessary.
WaitIndex int
Index number used to enable blocking quereis.
WaitTime string
Max time the client should wait for a blocking query to return.
AllowStale bool
When true, the default, allow responses from Consul servers that are followers.
Datacenter string
The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to.
Namespace string
The namespace to lookup the services.
Near string
NodeMeta map[string]string
RequireConsistent bool
When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
Token string
Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overriden if necessary.
WaitIndex int
Index number used to enable blocking quereis.
WaitTime string
Max time the client should wait for a blocking query to return.
allowStale boolean
When true, the default, allow responses from Consul servers that are followers.
datacenter string
The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to.
namespace string
The namespace to lookup the services.
near string
nodeMeta {[key: string]: string}
requireConsistent boolean
When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
token string
Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overriden if necessary.
waitIndex number
Index number used to enable blocking quereis.
waitTime string
Max time the client should wait for a blocking query to return.
allow_stale bool
When true, the default, allow responses from Consul servers that are followers.
datacenter str
The Consul datacenter to query. Defaults to the same value found in query_options parameter specified below, or if that is empty, the datacenter value found in the Consul agent that this provider is configured to talk to.
namespace str
The namespace to lookup the services.
near str
node_meta Mapping[str, str]
require_consistent bool
When true force the client to perform a read on at least quorum servers and verify the result is the same. Defaults to false.
token str
Specify the Consul ACL token to use when performing the request. This defaults to the same API token configured by the consul provider but may be overriden if necessary.
wait_index int
Index number used to enable blocking quereis.
wait_time str
Max time the client should wait for a blocking query to return.

Package Details

Repository
https://github.com/pulumi/pulumi-consul
License
Apache-2.0
Notes
This Pulumi package is based on the consul Terraform Provider.