pulumi-azure-kotlin/com.pulumi.azure.signalr.kotlin/Service

Service

class Service : KotlinCustomResource

Manages an Azure SignalR service.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.signalr.Service;
import com.pulumi.azure.signalr.ServiceArgs;
import com.pulumi.azure.signalr.inputs.ServiceSkuArgs;
import com.pulumi.azure.signalr.inputs.ServiceCorArgs;
import com.pulumi.azure.signalr.inputs.ServiceUpstreamEndpointArgs;
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) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West US")
            .build());
        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .sku(ServiceSkuArgs.builder()
                .name("Free_F1")
                .capacity(1)
                .build())
            .cors(ServiceCorArgs.builder()
                .allowedOrigins("http://www.example.com")
                .build())
            .publicNetworkAccessEnabled(false)
            .connectivityLogsEnabled(true)
            .messagingLogsEnabled(true)
            .serviceMode("Default")
            .upstreamEndpoints(ServiceUpstreamEndpointArgs.builder()
                .categoryPatterns(
                    "connections",
                    "messages")
                .eventPatterns("*")
                .hubPatterns("hub1")
                .urlTemplate("http://foo.com")
                .build())
            .build());
    }
}

Import

SignalR services can be imported using the resource id, e.g.

$ pulumi import azure:signalr/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/terraform-signalr/providers/Microsoft.SignalRService/signalR/tfex-signalr

Properties

val aadAuthEnabled: Output<Boolean>?

Whether to enable AAD auth? Defaults to true.

connectivityLogsEnabled

val connectivityLogsEnabled: Output<Boolean>?

Specifies if Connectivity Logs are enabled or not. Defaults to false.

val cors: Output<List<ServiceCor>>

A cors block as documented below.

val hostname: Output<String>

The FQDN of the SignalR service.

httpRequestLogsEnabled

val httpRequestLogsEnabled: Output<Boolean>?

Specifies if Http Request Logs are enabled or not. Defaults to false.

val id: Output<String>

val identity: Output<ServiceIdentity>?

An identity block as defined below.

val ipAddress: Output<String>

The publicly accessible IP of the SignalR service.

val liveTrace: Output<ServiceLiveTrace>?

A live_trace block as defined below.

liveTraceEnabled

val ~~liveTraceEnabled~~: Output<Boolean>?

Specifies if Live Trace is enabled or not. Defaults to false.

localAuthEnabled

val localAuthEnabled: Output<Boolean>?

Whether to enable local auth? Defaults to true.

val location: Output<String>

Specifies the supported Azure location where the SignalR service exists. Changing this forces a new resource to be created.

messagingLogsEnabled

val messagingLogsEnabled: Output<Boolean>?

Specifies if Messaging Logs are enabled or not. Defaults to false.

val name: Output<String>

The name of the SignalR service. Changing this forces a new resource to be created.

primaryAccessKey

val primaryAccessKey: Output<String>

The primary access key for the SignalR service.

primaryConnectionString

val primaryConnectionString: Output<String>

The primary connection string for the SignalR service.

publicNetworkAccessEnabled

val publicNetworkAccessEnabled: Output<Boolean>?

Whether to enable public network access? Defaults to true.

val publicPort: Output<Int>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

resourceGroupName

val resourceGroupName: Output<String>

The name of the resource group in which to create the SignalR service. Changing this forces a new resource to be created.

secondaryAccessKey

val secondaryAccessKey: Output<String>

The secondary access key for the SignalR service.

secondaryConnectionString

val secondaryConnectionString: Output<String>

The secondary connection string for the SignalR service.

serverlessConnectionTimeoutInSeconds

val serverlessConnectionTimeoutInSeconds: Output<Int>?

Specifies the client connection timeout. Defaults to 30.

val serverPort: Output<Int>

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

val serviceMode: Output<String>?

Specifies the service mode. Possible values are Classic, Default and Serverless. Defaults to Default.

val sku: Output<ServiceSku>

A sku block as documented below.

val tags: Output<Map<String, String>>?

A mapping of tags to assign to the resource.

tlsClientCertEnabled

val tlsClientCertEnabled: Output<Boolean>?

Whether to request client certificate during TLS handshake? Defaults to false.

upstreamEndpoints

val upstreamEndpoints: Output<List<ServiceUpstreamEndpoint>>?

An upstream_endpoint block as documented below. Using this block requires the SignalR service to be Serverless. When creating multiple blocks they will be processed in the order they are defined in.

val urn: Output<String>