Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. webpubsub
  5. getService

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.webpubsub.getService

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Use this data source to access information about an existing Azure Web Pubsub service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.webpubsub.getService({
    name: "test-webpubsub",
    resourceGroupName: "wps-resource-group",
});

    import pulumi
import pulumi_azure as azure

example = azure.webpubsub.get_service(name="test-webpubsub",
    resource_group_name="wps-resource-group")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/webpubsub"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := webpubsub.LookupService(ctx, &webpubsub.LookupServiceArgs{
			Name:              "test-webpubsub",
			ResourceGroupName: "wps-resource-group",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.WebPubSub.GetService.Invoke(new()
    {
        Name = "test-webpubsub",
        ResourceGroupName = "wps-resource-group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.webpubsub.WebpubsubFunctions;
import com.pulumi.azure.webpubsub.inputs.GetServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = WebpubsubFunctions.getService(GetServiceArgs.builder()
            .name("test-webpubsub")
            .resourceGroupName("wps-resource-group")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: azure:webpubsub:getService
      arguments:
        name: test-webpubsub
        resourceGroupName: wps-resource-group

    Using getService

    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 getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
    def get_service(name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
    func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

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

    public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure:webpubsub/getService:getService
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Specifies the name of the Web Pubsub service.
    ResourceGroupName string
    Specifies the name of the resource group the Web Pubsub service is located in.
    Name string
    Specifies the name of the Web Pubsub service.
    ResourceGroupName string
    Specifies the name of the resource group the Web Pubsub service is located in.
    name String
    Specifies the name of the Web Pubsub service.
    resourceGroupName String
    Specifies the name of the resource group the Web Pubsub service is located in.
    name string
    Specifies the name of the Web Pubsub service.
    resourceGroupName string
    Specifies the name of the resource group the Web Pubsub service is located in.
    name str
    Specifies the name of the Web Pubsub service.
    resource_group_name str
    Specifies the name of the resource group the Web Pubsub service is located in.
    name String
    Specifies the name of the Web Pubsub service.
    resourceGroupName String
    Specifies the name of the resource group the Web Pubsub service is located in.

    getService Result

    The following output properties are available:

    AadAuthEnabled bool
    Capacity int
    ExternalIp string
    Hostname string
    The FQDN of the Web Pubsub service.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalAuthEnabled bool
    Location string
    The Azure location where the Web Pubsub service exists.
    Name string
    PrimaryAccessKey string
    The primary access key of the Web Pubsub service.
    PrimaryConnectionString string
    The primary connection string of the Web Pubsub service.
    PublicNetworkAccessEnabled bool
    PublicPort int
    The publicly accessible port of the Web Pubsub service which is designed for browser/client use.
    ResourceGroupName string
    SecondaryAccessKey string
    The secondary access key of the Web Pubsub service.
    SecondaryConnectionString string
    The secondary connection string of the Web Pubsub service.
    ServerPort int
    The publicly accessible port of the Web Pubsub service which is designed for customer server side use.
    Sku string
    Tags Dictionary<string, string>
    TlsClientCertEnabled bool
    Version string
    AadAuthEnabled bool
    Capacity int
    ExternalIp string
    Hostname string
    The FQDN of the Web Pubsub service.
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalAuthEnabled bool
    Location string
    The Azure location where the Web Pubsub service exists.
    Name string
    PrimaryAccessKey string
    The primary access key of the Web Pubsub service.
    PrimaryConnectionString string
    The primary connection string of the Web Pubsub service.
    PublicNetworkAccessEnabled bool
    PublicPort int
    The publicly accessible port of the Web Pubsub service which is designed for browser/client use.
    ResourceGroupName string
    SecondaryAccessKey string
    The secondary access key of the Web Pubsub service.
    SecondaryConnectionString string
    The secondary connection string of the Web Pubsub service.
    ServerPort int
    The publicly accessible port of the Web Pubsub service which is designed for customer server side use.
    Sku string
    Tags map[string]string
    TlsClientCertEnabled bool
    Version string
    aadAuthEnabled Boolean
    capacity Integer
    externalIp String
    hostname String
    The FQDN of the Web Pubsub service.
    id String
    The provider-assigned unique ID for this managed resource.
    localAuthEnabled Boolean
    location String
    The Azure location where the Web Pubsub service exists.
    name String
    primaryAccessKey String
    The primary access key of the Web Pubsub service.
    primaryConnectionString String
    The primary connection string of the Web Pubsub service.
    publicNetworkAccessEnabled Boolean
    publicPort Integer
    The publicly accessible port of the Web Pubsub service which is designed for browser/client use.
    resourceGroupName String
    secondaryAccessKey String
    The secondary access key of the Web Pubsub service.
    secondaryConnectionString String
    The secondary connection string of the Web Pubsub service.
    serverPort Integer
    The publicly accessible port of the Web Pubsub service which is designed for customer server side use.
    sku String
    tags Map<String,String>
    tlsClientCertEnabled Boolean
    version String
    aadAuthEnabled boolean
    capacity number
    externalIp string
    hostname string
    The FQDN of the Web Pubsub service.
    id string
    The provider-assigned unique ID for this managed resource.
    localAuthEnabled boolean
    location string
    The Azure location where the Web Pubsub service exists.
    name string
    primaryAccessKey string
    The primary access key of the Web Pubsub service.
    primaryConnectionString string
    The primary connection string of the Web Pubsub service.
    publicNetworkAccessEnabled boolean
    publicPort number
    The publicly accessible port of the Web Pubsub service which is designed for browser/client use.
    resourceGroupName string
    secondaryAccessKey string
    The secondary access key of the Web Pubsub service.
    secondaryConnectionString string
    The secondary connection string of the Web Pubsub service.
    serverPort number
    The publicly accessible port of the Web Pubsub service which is designed for customer server side use.
    sku string
    tags {[key: string]: string}
    tlsClientCertEnabled boolean
    version string
    aad_auth_enabled bool
    capacity int
    external_ip str
    hostname str
    The FQDN of the Web Pubsub service.
    id str
    The provider-assigned unique ID for this managed resource.
    local_auth_enabled bool
    location str
    The Azure location where the Web Pubsub service exists.
    name str
    primary_access_key str
    The primary access key of the Web Pubsub service.
    primary_connection_string str
    The primary connection string of the Web Pubsub service.
    public_network_access_enabled bool
    public_port int
    The publicly accessible port of the Web Pubsub service which is designed for browser/client use.
    resource_group_name str
    secondary_access_key str
    The secondary access key of the Web Pubsub service.
    secondary_connection_string str
    The secondary connection string of the Web Pubsub service.
    server_port int
    The publicly accessible port of the Web Pubsub service which is designed for customer server side use.
    sku str
    tags Mapping[str, str]
    tls_client_cert_enabled bool
    version str
    aadAuthEnabled Boolean
    capacity Number
    externalIp String
    hostname String
    The FQDN of the Web Pubsub service.
    id String
    The provider-assigned unique ID for this managed resource.
    localAuthEnabled Boolean
    location String
    The Azure location where the Web Pubsub service exists.
    name String
    primaryAccessKey String
    The primary access key of the Web Pubsub service.
    primaryConnectionString String
    The primary connection string of the Web Pubsub service.
    publicNetworkAccessEnabled Boolean
    publicPort Number
    The publicly accessible port of the Web Pubsub service which is designed for browser/client use.
    resourceGroupName String
    secondaryAccessKey String
    The secondary access key of the Web Pubsub service.
    secondaryConnectionString String
    The secondary connection string of the Web Pubsub service.
    serverPort Number
    The publicly accessible port of the Web Pubsub service which is designed for customer server side use.
    sku String
    tags Map<String>
    tlsClientCertEnabled Boolean
    version String

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure