azure logo
Azure Classic v5.38.0, Mar 21 23

azure.signalr.getService

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

Example Usage

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

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

});
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/signalr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

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

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.signalr.SignalrFunctions;
import com.pulumi.azure.signalr.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 = SignalrFunctions.getService(GetServiceArgs.builder()
            .name("test-signalr")
            .resourceGroupName("signalr-resource-group")
            .build());

    }
}
import pulumi
import pulumi_azure as azure

example = azure.signalr.get_service(name="test-signalr",
    resource_group_name="signalr-resource-group")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.signalr.getService({
    name: "test-signalr",
    resourceGroupName: "signalr-resource-group",
});
variables:
  example:
    fn::invoke:
      Function: azure:signalr:getService
      Arguments:
        name: test-signalr
        resourceGroupName: signalr-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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure:signalr/getService:getService
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

Specifies the name of the SignalR service.

ResourceGroupName string

Specifies the name of the resource group the SignalR service is located in.

Name string

Specifies the name of the SignalR service.

ResourceGroupName string

Specifies the name of the resource group the SignalR service is located in.

name String

Specifies the name of the SignalR service.

resourceGroupName String

Specifies the name of the resource group the SignalR service is located in.

name string

Specifies the name of the SignalR service.

resourceGroupName string

Specifies the name of the resource group the SignalR service is located in.

name str

Specifies the name of the SignalR service.

resource_group_name str

Specifies the name of the resource group the SignalR service is located in.

name String

Specifies the name of the SignalR service.

resourceGroupName String

Specifies the name of the resource group the SignalR service is located in.

getService Result

The following output properties are available:

Hostname string

The FQDN of the SignalR service.

Id string

The provider-assigned unique ID for this managed resource.

IpAddress string

The publicly accessible IP of the SignalR service.

Location string

Specifies the supported Azure location where the SignalR service exists.

Name string
PrimaryAccessKey string

The primary access key of the SignalR service.

PrimaryConnectionString string

The primary connection string of the SignalR service.

PublicPort int

The publicly accessible port of the SignalR service which is designed for browser/client use.

ResourceGroupName string
SecondaryAccessKey string

The secondary access key of the SignalR service.

SecondaryConnectionString string

The secondary connection string of the SignalR service.

ServerPort int

The publicly accessible port of the SignalR service which is designed for customer server side use.

Tags Dictionary<string, string>
Hostname string

The FQDN of the SignalR service.

Id string

The provider-assigned unique ID for this managed resource.

IpAddress string

The publicly accessible IP of the SignalR service.

Location string

Specifies the supported Azure location where the SignalR service exists.

Name string
PrimaryAccessKey string

The primary access key of the SignalR service.

PrimaryConnectionString string

The primary connection string of the SignalR service.

PublicPort int

The publicly accessible port of the SignalR service which is designed for browser/client use.

ResourceGroupName string
SecondaryAccessKey string

The secondary access key of the SignalR service.

SecondaryConnectionString string

The secondary connection string of the SignalR service.

ServerPort int

The publicly accessible port of the SignalR service which is designed for customer server side use.

Tags map[string]string
hostname String

The FQDN of the SignalR service.

id String

The provider-assigned unique ID for this managed resource.

ipAddress String

The publicly accessible IP of the SignalR service.

location String

Specifies the supported Azure location where the SignalR service exists.

name String
primaryAccessKey String

The primary access key of the SignalR service.

primaryConnectionString String

The primary connection string of the SignalR service.

publicPort Integer

The publicly accessible port of the SignalR service which is designed for browser/client use.

resourceGroupName String
secondaryAccessKey String

The secondary access key of the SignalR service.

secondaryConnectionString String

The secondary connection string of the SignalR service.

serverPort Integer

The publicly accessible port of the SignalR service which is designed for customer server side use.

tags Map<String,String>
hostname string

The FQDN of the SignalR service.

id string

The provider-assigned unique ID for this managed resource.

ipAddress string

The publicly accessible IP of the SignalR service.

location string

Specifies the supported Azure location where the SignalR service exists.

name string
primaryAccessKey string

The primary access key of the SignalR service.

primaryConnectionString string

The primary connection string of the SignalR service.

publicPort number

The publicly accessible port of the SignalR service which is designed for browser/client use.

resourceGroupName string
secondaryAccessKey string

The secondary access key of the SignalR service.

secondaryConnectionString string

The secondary connection string of the SignalR service.

serverPort number

The publicly accessible port of the SignalR service which is designed for customer server side use.

tags {[key: string]: string}
hostname str

The FQDN of the SignalR service.

id str

The provider-assigned unique ID for this managed resource.

ip_address str

The publicly accessible IP of the SignalR service.

location str

Specifies the supported Azure location where the SignalR service exists.

name str
primary_access_key str

The primary access key of the SignalR service.

primary_connection_string str

The primary connection string of the SignalR service.

public_port int

The publicly accessible port of the SignalR service which is designed for browser/client use.

resource_group_name str
secondary_access_key str

The secondary access key of the SignalR service.

secondary_connection_string str

The secondary connection string of the SignalR service.

server_port int

The publicly accessible port of the SignalR service which is designed for customer server side use.

tags Mapping[str, str]
hostname String

The FQDN of the SignalR service.

id String

The provider-assigned unique ID for this managed resource.

ipAddress String

The publicly accessible IP of the SignalR service.

location String

Specifies the supported Azure location where the SignalR service exists.

name String
primaryAccessKey String

The primary access key of the SignalR service.

primaryConnectionString String

The primary connection string of the SignalR service.

publicPort Number

The publicly accessible port of the SignalR service which is designed for browser/client use.

resourceGroupName String
secondaryAccessKey String

The secondary access key of the SignalR service.

secondaryConnectionString String

The secondary connection string of the SignalR service.

serverPort Number

The publicly accessible port of the SignalR service which is designed for customer server side use.

tags Map<String>

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.