Docs Packages
  1. Packages
  2. HashiCorp Consul
  3. API Docs
  4. getCatalogService
Consul v3.8.0 published on Friday, Mar 3, 2023 by Pulumi
pulumi/pulumi-consul

consul.getCatalogService

Explore with Pulumi AI

consul logo
Consul v3.8.0 published on Friday, Mar 3, 2023 by Pulumi
pulumi/pulumi-consul

    Using getCatalogService

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCatalogService(args: GetCatalogServiceArgs, opts?: InvokeOptions): Promise<GetCatalogServiceResult>
function getCatalogServiceOutput(args: GetCatalogServiceOutputArgs, opts?: InvokeOptions): Output<GetCatalogServiceResult>
    def get_catalog_service(datacenter: Optional[str] = None,
                        filter: Optional[str] = None,
                        name: Optional[str] = None,
                        query_options: Optional[Sequence[GetCatalogServiceQueryOption]] = None,
                        tag: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCatalogServiceResult
def get_catalog_service_output(datacenter: Optional[pulumi.Input[str]] = None,
                        filter: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        query_options: Optional[pulumi.Input[Sequence[pulumi.Input[GetCatalogServiceQueryOptionArgs]]]] = None,
                        tag: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetCatalogServiceResult]
    func GetCatalogService(ctx *Context, args *GetCatalogServiceArgs, opts ...InvokeOption) (*GetCatalogServiceResult, error)
func GetCatalogServiceOutput(ctx *Context, args *GetCatalogServiceOutputArgs, opts ...InvokeOption) GetCatalogServiceResultOutput

    > Note: This function is named GetCatalogService in the Go SDK.

    public static class GetCatalogService 
{
    public static Task<GetCatalogServiceResult> InvokeAsync(GetCatalogServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogServiceResult> Invoke(GetCatalogServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCatalogServiceResult> getCatalogService(GetCatalogServiceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: consul:index/getCatalogService:getCatalogService
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getCatalogService Result

    The following output properties are available:

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string
    Services List<GetCatalogServiceService>
    Datacenter string
    Filter string
    QueryOptions List<GetCatalogServiceQueryOption>
    Tag string
    Id string

    The provider-assigned unique ID for this managed resource.

    Name string
    Services []GetCatalogServiceService
    Datacenter string
    Filter string
    QueryOptions []GetCatalogServiceQueryOption
    Tag string
    id String

    The provider-assigned unique ID for this managed resource.

    name String
    services List<GetCatalogServiceService>
    datacenter String
    filter String
    queryOptions List<GetCatalogServiceQueryOption>
    tag String
    id string

    The provider-assigned unique ID for this managed resource.

    name string
    services GetCatalogServiceService[]
    datacenter string
    filter string
    queryOptions GetCatalogServiceQueryOption[]
    tag string
    id str

    The provider-assigned unique ID for this managed resource.

    name str
    services Sequence[GetCatalogServiceService]
    datacenter str
    filter str
    query_options Sequence[GetCatalogServiceQueryOption]
    tag str
    id String

    The provider-assigned unique ID for this managed resource.

    name String
    services List<Property Map>
    datacenter String
    filter String
    queryOptions List<Property Map>
    tag String

    Supporting Types

    GetCatalogServiceQueryOption

    AllowStale bool
    Datacenter string
    Namespace string
    Near string
    NodeMeta Dictionary<string, string>
    Partition string
    RequireConsistent bool
    Token string
    WaitIndex int
    WaitTime string
    AllowStale bool
    Datacenter string
    Namespace string
    Near string
    NodeMeta map[string]string
    Partition string
    RequireConsistent bool
    Token string
    WaitIndex int
    WaitTime string
    allowStale Boolean
    datacenter String
    namespace String
    near String
    nodeMeta Map<String,String>
    partition String
    requireConsistent Boolean
    token String
    waitIndex Integer
    waitTime String
    allowStale boolean
    datacenter string
    namespace string
    near string
    nodeMeta {[key: string]: string}
    partition string
    requireConsistent boolean
    token string
    waitIndex number
    waitTime string
    allowStale Boolean
    datacenter String
    namespace String
    near String
    nodeMeta Map<String>
    partition String
    requireConsistent Boolean
    token String
    waitIndex Number
    waitTime String

    GetCatalogServiceService

    Address string
    CreateIndex string
    EnableTagOverride string
    Id string
    Meta Dictionary<string, string>
    ModifyIndex string
    Name string
    NodeAddress string
    NodeId string
    NodeMeta Dictionary<string, string>
    NodeName string
    Port string
    TaggedAddresses Dictionary<string, string>
    Tags List<string>
    Address string
    CreateIndex string
    EnableTagOverride string
    Id string
    Meta map[string]string
    ModifyIndex string
    Name string
    NodeAddress string
    NodeId string
    NodeMeta map[string]string
    NodeName string
    Port string
    TaggedAddresses map[string]string
    Tags []string
    address String
    createIndex String
    enableTagOverride String
    id String
    meta Map<String,String>
    modifyIndex String
    name String
    nodeAddress String
    nodeId String
    nodeMeta Map<String,String>
    nodeName String
    port String
    taggedAddresses Map<String,String>
    tags List<String>
    address string
    createIndex string
    enableTagOverride string
    id string
    meta {[key: string]: string}
    modifyIndex string
    name string
    nodeAddress string
    nodeId string
    nodeMeta {[key: string]: string}
    nodeName string
    port string
    taggedAddresses {[key: string]: string}
    tags string[]
    address str
    create_index str
    enable_tag_override str
    id str
    meta Mapping[str, str]
    modify_index str
    name str
    node_address str
    node_id str
    node_meta Mapping[str, str]
    node_name str
    port str
    tagged_addresses Mapping[str, str]
    tags Sequence[str]
    address String
    createIndex String
    enableTagOverride String
    id String
    meta Map<String>
    modifyIndex String
    name String
    nodeAddress String
    nodeId String
    nodeMeta Map<String>
    nodeName String
    port String
    taggedAddresses Map<String>
    tags List<String>

    Package Details

    Repository
    HashiCorp Consul pulumi/pulumi-consul
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the consul Terraform Provider.

    consul logo
    Consul v3.8.0 published on Friday, Mar 3, 2023 by Pulumi
    pulumi/pulumi-consul