We recommend using Azure Native.
azure.signalr.ServiceCustomDomain
Explore with Pulumi AI
Manages an Azure SignalR Custom Domain.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as std from "@pulumi/std";
const current = azure.core.getClientConfig({});
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleService = new azure.signalr.Service("example", {
name: "example-signalr",
location: testAzurermResourceGroup.location,
resourceGroupName: testAzurermResourceGroup.name,
sku: {
name: "Premium_P1",
capacity: 1,
},
identity: {
type: "SystemAssigned",
},
});
const exampleKeyVault = new azure.keyvault.KeyVault("example", {
name: "example-keyvault",
location: example.location,
resourceGroupName: example.name,
tenantId: current.then(current => current.tenantId),
skuName: "premium",
accessPolicies: [
{
tenantId: current.then(current => current.tenantId),
objectId: current.then(current => current.objectId),
certificatePermissions: [
"Create",
"Get",
"List",
],
secretPermissions: [
"Get",
"List",
],
},
{
tenantId: current.then(current => current.tenantId),
objectId: testAzurermSignalrService.identity[0].principalId,
certificatePermissions: [
"Create",
"Get",
"List",
],
secretPermissions: [
"Get",
"List",
],
},
],
});
const exampleCertificate = new azure.keyvault.Certificate("example", {
name: "imported-cert",
keyVaultId: exampleKeyVault.id,
certificate: {
contents: std.filebase64({
input: "certificate-to-import.pfx",
}).then(invoke => invoke.result),
password: "",
},
});
const test = new azure.signalr.ServiceCustomCertificate("test", {
name: "example-cert",
signalrServiceId: exampleService.id,
customCertificateId: exampleCertificate.id,
}, {
dependsOn: [exampleAzurermKeyVaultAccessPolicy],
});
const testServiceCustomDomain = new azure.signalr.ServiceCustomDomain("test", {
name: "example-domain",
signalrServiceId: testAzurermSignalrService.id,
domainName: "tftest.com",
signalrCustomCertificateId: test.id,
});
import pulumi
import pulumi_azure as azure
import pulumi_std as std
current = azure.core.get_client_config()
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_service = azure.signalr.Service("example",
name="example-signalr",
location=test_azurerm_resource_group["location"],
resource_group_name=test_azurerm_resource_group["name"],
sku=azure.signalr.ServiceSkuArgs(
name="Premium_P1",
capacity=1,
),
identity=azure.signalr.ServiceIdentityArgs(
type="SystemAssigned",
))
example_key_vault = azure.keyvault.KeyVault("example",
name="example-keyvault",
location=example.location,
resource_group_name=example.name,
tenant_id=current.tenant_id,
sku_name="premium",
access_policies=[
azure.keyvault.KeyVaultAccessPolicyArgs(
tenant_id=current.tenant_id,
object_id=current.object_id,
certificate_permissions=[
"Create",
"Get",
"List",
],
secret_permissions=[
"Get",
"List",
],
),
azure.keyvault.KeyVaultAccessPolicyArgs(
tenant_id=current.tenant_id,
object_id=test_azurerm_signalr_service["identity"][0]["principalId"],
certificate_permissions=[
"Create",
"Get",
"List",
],
secret_permissions=[
"Get",
"List",
],
),
])
example_certificate = azure.keyvault.Certificate("example",
name="imported-cert",
key_vault_id=example_key_vault.id,
certificate=azure.keyvault.CertificateCertificateArgs(
contents=std.filebase64(input="certificate-to-import.pfx").result,
password="",
))
test = azure.signalr.ServiceCustomCertificate("test",
name="example-cert",
signalr_service_id=example_service.id,
custom_certificate_id=example_certificate.id,
opts=pulumi.ResourceOptions(depends_on=[example_azurerm_key_vault_access_policy]))
test_service_custom_domain = azure.signalr.ServiceCustomDomain("test",
name="example-domain",
signalr_service_id=test_azurerm_signalr_service["id"],
domain_name="tftest.com",
signalr_custom_certificate_id=test.id)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/keyvault"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/signalr"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := core.GetClientConfig(ctx, nil, nil)
if err != nil {
return err
}
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleService, err := signalr.NewService(ctx, "example", &signalr.ServiceArgs{
Name: pulumi.String("example-signalr"),
Location: pulumi.Any(testAzurermResourceGroup.Location),
ResourceGroupName: pulumi.Any(testAzurermResourceGroup.Name),
Sku: &signalr.ServiceSkuArgs{
Name: pulumi.String("Premium_P1"),
Capacity: pulumi.Int(1),
},
Identity: &signalr.ServiceIdentityArgs{
Type: pulumi.String("SystemAssigned"),
},
})
if err != nil {
return err
}
exampleKeyVault, err := keyvault.NewKeyVault(ctx, "example", &keyvault.KeyVaultArgs{
Name: pulumi.String("example-keyvault"),
Location: example.Location,
ResourceGroupName: example.Name,
TenantId: pulumi.String(current.TenantId),
SkuName: pulumi.String("premium"),
AccessPolicies: keyvault.KeyVaultAccessPolicyArray{
&keyvault.KeyVaultAccessPolicyArgs{
TenantId: pulumi.String(current.TenantId),
ObjectId: pulumi.String(current.ObjectId),
CertificatePermissions: pulumi.StringArray{
pulumi.String("Create"),
pulumi.String("Get"),
pulumi.String("List"),
},
SecretPermissions: pulumi.StringArray{
pulumi.String("Get"),
pulumi.String("List"),
},
},
&keyvault.KeyVaultAccessPolicyArgs{
TenantId: pulumi.String(current.TenantId),
ObjectId: pulumi.Any(testAzurermSignalrService.Identity[0].PrincipalId),
CertificatePermissions: pulumi.StringArray{
pulumi.String("Create"),
pulumi.String("Get"),
pulumi.String("List"),
},
SecretPermissions: pulumi.StringArray{
pulumi.String("Get"),
pulumi.String("List"),
},
},
},
})
if err != nil {
return err
}
invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
Input: "certificate-to-import.pfx",
}, nil)
if err != nil {
return err
}
exampleCertificate, err := keyvault.NewCertificate(ctx, "example", &keyvault.CertificateArgs{
Name: pulumi.String("imported-cert"),
KeyVaultId: exampleKeyVault.ID(),
Certificate: &keyvault.CertificateCertificateArgs{
Contents: invokeFilebase64.Result,
Password: pulumi.String(""),
},
})
if err != nil {
return err
}
test, err := signalr.NewServiceCustomCertificate(ctx, "test", &signalr.ServiceCustomCertificateArgs{
Name: pulumi.String("example-cert"),
SignalrServiceId: exampleService.ID(),
CustomCertificateId: exampleCertificate.ID(),
}, pulumi.DependsOn([]pulumi.Resource{
exampleAzurermKeyVaultAccessPolicy,
}))
if err != nil {
return err
}
_, err = signalr.NewServiceCustomDomain(ctx, "test", &signalr.ServiceCustomDomainArgs{
Name: pulumi.String("example-domain"),
SignalrServiceId: pulumi.Any(testAzurermSignalrService.Id),
DomainName: pulumi.String("tftest.com"),
SignalrCustomCertificateId: test.ID(),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var current = Azure.Core.GetClientConfig.Invoke();
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleService = new Azure.SignalR.Service("example", new()
{
Name = "example-signalr",
Location = testAzurermResourceGroup.Location,
ResourceGroupName = testAzurermResourceGroup.Name,
Sku = new Azure.SignalR.Inputs.ServiceSkuArgs
{
Name = "Premium_P1",
Capacity = 1,
},
Identity = new Azure.SignalR.Inputs.ServiceIdentityArgs
{
Type = "SystemAssigned",
},
});
var exampleKeyVault = new Azure.KeyVault.KeyVault("example", new()
{
Name = "example-keyvault",
Location = example.Location,
ResourceGroupName = example.Name,
TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
SkuName = "premium",
AccessPolicies = new[]
{
new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
{
TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
ObjectId = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
CertificatePermissions = new[]
{
"Create",
"Get",
"List",
},
SecretPermissions = new[]
{
"Get",
"List",
},
},
new Azure.KeyVault.Inputs.KeyVaultAccessPolicyArgs
{
TenantId = current.Apply(getClientConfigResult => getClientConfigResult.TenantId),
ObjectId = testAzurermSignalrService.Identity[0].PrincipalId,
CertificatePermissions = new[]
{
"Create",
"Get",
"List",
},
SecretPermissions = new[]
{
"Get",
"List",
},
},
},
});
var exampleCertificate = new Azure.KeyVault.Certificate("example", new()
{
Name = "imported-cert",
KeyVaultId = exampleKeyVault.Id,
KeyVaultCertificate = new Azure.KeyVault.Inputs.CertificateCertificateArgs
{
Contents = Std.Filebase64.Invoke(new()
{
Input = "certificate-to-import.pfx",
}).Apply(invoke => invoke.Result),
Password = "",
},
});
var test = new Azure.SignalR.ServiceCustomCertificate("test", new()
{
Name = "example-cert",
SignalrServiceId = exampleService.Id,
CustomCertificateId = exampleCertificate.Id,
}, new CustomResourceOptions
{
DependsOn =
{
exampleAzurermKeyVaultAccessPolicy,
},
});
var testServiceCustomDomain = new Azure.SignalR.ServiceCustomDomain("test", new()
{
Name = "example-domain",
SignalrServiceId = testAzurermSignalrService.Id,
DomainName = "tftest.com",
SignalrCustomCertificateId = test.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
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.ServiceIdentityArgs;
import com.pulumi.azure.keyvault.KeyVault;
import com.pulumi.azure.keyvault.KeyVaultArgs;
import com.pulumi.azure.keyvault.inputs.KeyVaultAccessPolicyArgs;
import com.pulumi.azure.keyvault.Certificate;
import com.pulumi.azure.keyvault.CertificateArgs;
import com.pulumi.azure.keyvault.inputs.CertificateCertificateArgs;
import com.pulumi.azure.signalr.ServiceCustomCertificate;
import com.pulumi.azure.signalr.ServiceCustomCertificateArgs;
import com.pulumi.azure.signalr.ServiceCustomDomain;
import com.pulumi.azure.signalr.ServiceCustomDomainArgs;
import com.pulumi.resources.CustomResourceOptions;
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 current = CoreFunctions.getClientConfig();
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.name("example-signalr")
.location(testAzurermResourceGroup.location())
.resourceGroupName(testAzurermResourceGroup.name())
.sku(ServiceSkuArgs.builder()
.name("Premium_P1")
.capacity(1)
.build())
.identity(ServiceIdentityArgs.builder()
.type("SystemAssigned")
.build())
.build());
var exampleKeyVault = new KeyVault("exampleKeyVault", KeyVaultArgs.builder()
.name("example-keyvault")
.location(example.location())
.resourceGroupName(example.name())
.tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
.skuName("premium")
.accessPolicies(
KeyVaultAccessPolicyArgs.builder()
.tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
.objectId(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
.certificatePermissions(
"Create",
"Get",
"List")
.secretPermissions(
"Get",
"List")
.build(),
KeyVaultAccessPolicyArgs.builder()
.tenantId(current.applyValue(getClientConfigResult -> getClientConfigResult.tenantId()))
.objectId(testAzurermSignalrService.identity()[0].principalId())
.certificatePermissions(
"Create",
"Get",
"List")
.secretPermissions(
"Get",
"List")
.build())
.build());
var exampleCertificate = new Certificate("exampleCertificate", CertificateArgs.builder()
.name("imported-cert")
.keyVaultId(exampleKeyVault.id())
.certificate(CertificateCertificateArgs.builder()
.contents(StdFunctions.filebase64(Filebase64Args.builder()
.input("certificate-to-import.pfx")
.build()).result())
.password("")
.build())
.build());
var test = new ServiceCustomCertificate("test", ServiceCustomCertificateArgs.builder()
.name("example-cert")
.signalrServiceId(exampleService.id())
.customCertificateId(exampleCertificate.id())
.build(), CustomResourceOptions.builder()
.dependsOn(exampleAzurermKeyVaultAccessPolicy)
.build());
var testServiceCustomDomain = new ServiceCustomDomain("testServiceCustomDomain", ServiceCustomDomainArgs.builder()
.name("example-domain")
.signalrServiceId(testAzurermSignalrService.id())
.domainName("tftest.com")
.signalrCustomCertificateId(test.id())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleService:
type: azure:signalr:Service
name: example
properties:
name: example-signalr
location: ${testAzurermResourceGroup.location}
resourceGroupName: ${testAzurermResourceGroup.name}
sku:
name: Premium_P1
capacity: 1
identity:
type: SystemAssigned
exampleKeyVault:
type: azure:keyvault:KeyVault
name: example
properties:
name: example-keyvault
location: ${example.location}
resourceGroupName: ${example.name}
tenantId: ${current.tenantId}
skuName: premium
accessPolicies:
- tenantId: ${current.tenantId}
objectId: ${current.objectId}
certificatePermissions:
- Create
- Get
- List
secretPermissions:
- Get
- List
- tenantId: ${current.tenantId}
objectId: ${testAzurermSignalrService.identity[0].principalId}
certificatePermissions:
- Create
- Get
- List
secretPermissions:
- Get
- List
exampleCertificate:
type: azure:keyvault:Certificate
name: example
properties:
name: imported-cert
keyVaultId: ${exampleKeyVault.id}
certificate:
contents:
fn::invoke:
Function: std:filebase64
Arguments:
input: certificate-to-import.pfx
Return: result
password:
test:
type: azure:signalr:ServiceCustomCertificate
properties:
name: example-cert
signalrServiceId: ${exampleService.id}
customCertificateId: ${exampleCertificate.id}
options:
dependson:
- ${exampleAzurermKeyVaultAccessPolicy}
testServiceCustomDomain:
type: azure:signalr:ServiceCustomDomain
name: test
properties:
name: example-domain
signalrServiceId: ${testAzurermSignalrService.id}
domainName: tftest.com
signalrCustomCertificateId: ${test.id}
variables:
current:
fn::invoke:
Function: azure:core:getClientConfig
Arguments: {}
Create ServiceCustomDomain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ServiceCustomDomain(name: string, args: ServiceCustomDomainArgs, opts?: CustomResourceOptions);
@overload
def ServiceCustomDomain(resource_name: str,
args: ServiceCustomDomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ServiceCustomDomain(resource_name: str,
opts: Optional[ResourceOptions] = None,
domain_name: Optional[str] = None,
signalr_custom_certificate_id: Optional[str] = None,
signalr_service_id: Optional[str] = None,
name: Optional[str] = None)
func NewServiceCustomDomain(ctx *Context, name string, args ServiceCustomDomainArgs, opts ...ResourceOption) (*ServiceCustomDomain, error)
public ServiceCustomDomain(string name, ServiceCustomDomainArgs args, CustomResourceOptions? opts = null)
public ServiceCustomDomain(String name, ServiceCustomDomainArgs args)
public ServiceCustomDomain(String name, ServiceCustomDomainArgs args, CustomResourceOptions options)
type: azure:signalr:ServiceCustomDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ServiceCustomDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ServiceCustomDomainArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ServiceCustomDomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceCustomDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServiceCustomDomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var serviceCustomDomainResource = new Azure.SignalR.ServiceCustomDomain("serviceCustomDomainResource", new()
{
DomainName = "string",
SignalrCustomCertificateId = "string",
SignalrServiceId = "string",
Name = "string",
});
example, err := signalr.NewServiceCustomDomain(ctx, "serviceCustomDomainResource", &signalr.ServiceCustomDomainArgs{
DomainName: pulumi.String("string"),
SignalrCustomCertificateId: pulumi.String("string"),
SignalrServiceId: pulumi.String("string"),
Name: pulumi.String("string"),
})
var serviceCustomDomainResource = new ServiceCustomDomain("serviceCustomDomainResource", ServiceCustomDomainArgs.builder()
.domainName("string")
.signalrCustomCertificateId("string")
.signalrServiceId("string")
.name("string")
.build());
service_custom_domain_resource = azure.signalr.ServiceCustomDomain("serviceCustomDomainResource",
domain_name="string",
signalr_custom_certificate_id="string",
signalr_service_id="string",
name="string")
const serviceCustomDomainResource = new azure.signalr.ServiceCustomDomain("serviceCustomDomainResource", {
domainName: "string",
signalrCustomCertificateId: "string",
signalrServiceId: "string",
name: "string",
});
type: azure:signalr:ServiceCustomDomain
properties:
domainName: string
name: string
signalrCustomCertificateId: string
signalrServiceId: string
ServiceCustomDomain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ServiceCustomDomain resource accepts the following input properties:
- Domain
Name string Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- Signalr
Custom stringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Signalr
Service stringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Domain
Name string Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- Signalr
Custom stringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Signalr
Service stringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Name string
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- domain
Name String Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- signalr
Custom StringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Service StringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- name String
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- domain
Name string Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- signalr
Custom stringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Service stringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- name string
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- domain_
name str Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- signalr_
custom_ strcertificate_ id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr_
service_ strid - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- name str
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- domain
Name String Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- signalr
Custom StringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Service StringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- name String
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServiceCustomDomain resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ServiceCustomDomain Resource
Get an existing ServiceCustomDomain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ServiceCustomDomainState, opts?: CustomResourceOptions): ServiceCustomDomain
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
domain_name: Optional[str] = None,
name: Optional[str] = None,
signalr_custom_certificate_id: Optional[str] = None,
signalr_service_id: Optional[str] = None) -> ServiceCustomDomain
func GetServiceCustomDomain(ctx *Context, name string, id IDInput, state *ServiceCustomDomainState, opts ...ResourceOption) (*ServiceCustomDomain, error)
public static ServiceCustomDomain Get(string name, Input<string> id, ServiceCustomDomainState? state, CustomResourceOptions? opts = null)
public static ServiceCustomDomain get(String name, Output<String> id, ServiceCustomDomainState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Domain
Name string Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- Name string
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Signalr
Custom stringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Signalr
Service stringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Domain
Name string Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- Name string
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Signalr
Custom stringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- Signalr
Service stringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- domain
Name String Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- name String
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Custom StringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Service StringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- domain
Name string Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- name string
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Custom stringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Service stringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- domain_
name str Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- name str
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr_
custom_ strcertificate_ id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr_
service_ strid - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- domain
Name String Specifies the custom domain name of the SignalR Custom Domain. Changing this forces a new resource to be created.
NOTE: Please ensure the custom domain name is included in the Subject Alternative Names of the selected SignalR Custom Certificate.
- name String
- Specifies the name of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Custom StringCertificate Id - Specifies the SignalR Custom Certificate ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
- signalr
Service StringId - Specifies the SignalR ID of the SignalR Custom Domain. Changing this forces a new resource to be created.
Import
Custom Domain for a SignalR service can be imported using the resource id
, e.g.
$ pulumi import azure:signalr/serviceCustomDomain:ServiceCustomDomain example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.SignalRService/signalR/signalr1/customDomains/customDomain1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.