1. Packages
  2. Azure Native
  3. API Docs
  4. signalrservice
  5. SignalRCustomCertificate
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.signalrservice.SignalRCustomCertificate

Explore with Pulumi AI

A custom certificate.

Uses Azure REST API version 2024-03-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.

Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native signalrservice [ApiVersion]. See the version guide for details.

Example Usage

SignalRCustomCertificates_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var signalRCustomCertificate = new AzureNative.SignalRService.SignalRCustomCertificate("signalRCustomCertificate", new()
    {
        CertificateName = "myCert",
        KeyVaultBaseUri = "https://myvault.keyvault.azure.net/",
        KeyVaultSecretName = "mycert",
        KeyVaultSecretVersion = "bb6a44b2743f47f68dad0d6cc9756432",
        ResourceGroupName = "myResourceGroup",
        ResourceName = "mySignalRService",
    });

});
Copy
package main

import (
	signalrservice "github.com/pulumi/pulumi-azure-native-sdk/signalrservice/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := signalrservice.NewSignalRCustomCertificate(ctx, "signalRCustomCertificate", &signalrservice.SignalRCustomCertificateArgs{
			CertificateName:       pulumi.String("myCert"),
			KeyVaultBaseUri:       pulumi.String("https://myvault.keyvault.azure.net/"),
			KeyVaultSecretName:    pulumi.String("mycert"),
			KeyVaultSecretVersion: pulumi.String("bb6a44b2743f47f68dad0d6cc9756432"),
			ResourceGroupName:     pulumi.String("myResourceGroup"),
			ResourceName:          pulumi.String("mySignalRService"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.signalrservice.SignalRCustomCertificate;
import com.pulumi.azurenative.signalrservice.SignalRCustomCertificateArgs;
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 signalRCustomCertificate = new SignalRCustomCertificate("signalRCustomCertificate", SignalRCustomCertificateArgs.builder()
            .certificateName("myCert")
            .keyVaultBaseUri("https://myvault.keyvault.azure.net/")
            .keyVaultSecretName("mycert")
            .keyVaultSecretVersion("bb6a44b2743f47f68dad0d6cc9756432")
            .resourceGroupName("myResourceGroup")
            .resourceName("mySignalRService")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const signalRCustomCertificate = new azure_native.signalrservice.SignalRCustomCertificate("signalRCustomCertificate", {
    certificateName: "myCert",
    keyVaultBaseUri: "https://myvault.keyvault.azure.net/",
    keyVaultSecretName: "mycert",
    keyVaultSecretVersion: "bb6a44b2743f47f68dad0d6cc9756432",
    resourceGroupName: "myResourceGroup",
    resourceName: "mySignalRService",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

signal_r_custom_certificate = azure_native.signalrservice.SignalRCustomCertificate("signalRCustomCertificate",
    certificate_name="myCert",
    key_vault_base_uri="https://myvault.keyvault.azure.net/",
    key_vault_secret_name="mycert",
    key_vault_secret_version="bb6a44b2743f47f68dad0d6cc9756432",
    resource_group_name="myResourceGroup",
    resource_name_="mySignalRService")
Copy
resources:
  signalRCustomCertificate:
    type: azure-native:signalrservice:SignalRCustomCertificate
    properties:
      certificateName: myCert
      keyVaultBaseUri: https://myvault.keyvault.azure.net/
      keyVaultSecretName: mycert
      keyVaultSecretVersion: bb6a44b2743f47f68dad0d6cc9756432
      resourceGroupName: myResourceGroup
      resourceName: mySignalRService
Copy

Create SignalRCustomCertificate Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SignalRCustomCertificate(name: string, args: SignalRCustomCertificateArgs, opts?: CustomResourceOptions);
@overload
def SignalRCustomCertificate(resource_name: str,
                             args: SignalRCustomCertificateArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def SignalRCustomCertificate(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             key_vault_base_uri: Optional[str] = None,
                             key_vault_secret_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             resource_name_: Optional[str] = None,
                             certificate_name: Optional[str] = None,
                             key_vault_secret_version: Optional[str] = None)
func NewSignalRCustomCertificate(ctx *Context, name string, args SignalRCustomCertificateArgs, opts ...ResourceOption) (*SignalRCustomCertificate, error)
public SignalRCustomCertificate(string name, SignalRCustomCertificateArgs args, CustomResourceOptions? opts = null)
public SignalRCustomCertificate(String name, SignalRCustomCertificateArgs args)
public SignalRCustomCertificate(String name, SignalRCustomCertificateArgs args, CustomResourceOptions options)
type: azure-native:signalrservice:SignalRCustomCertificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SignalRCustomCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SignalRCustomCertificateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SignalRCustomCertificateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SignalRCustomCertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SignalRCustomCertificateArgs
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 signalRCustomCertificateResource = new AzureNative.SignalRService.SignalRCustomCertificate("signalRCustomCertificateResource", new()
{
    KeyVaultBaseUri = "string",
    KeyVaultSecretName = "string",
    ResourceGroupName = "string",
    ResourceName = "string",
    CertificateName = "string",
    KeyVaultSecretVersion = "string",
});
Copy
example, err := signalrservice.NewSignalRCustomCertificate(ctx, "signalRCustomCertificateResource", &signalrservice.SignalRCustomCertificateArgs{
	KeyVaultBaseUri:       pulumi.String("string"),
	KeyVaultSecretName:    pulumi.String("string"),
	ResourceGroupName:     pulumi.String("string"),
	ResourceName:          pulumi.String("string"),
	CertificateName:       pulumi.String("string"),
	KeyVaultSecretVersion: pulumi.String("string"),
})
Copy
var signalRCustomCertificateResource = new SignalRCustomCertificate("signalRCustomCertificateResource", SignalRCustomCertificateArgs.builder()
    .keyVaultBaseUri("string")
    .keyVaultSecretName("string")
    .resourceGroupName("string")
    .resourceName("string")
    .certificateName("string")
    .keyVaultSecretVersion("string")
    .build());
Copy
signal_r_custom_certificate_resource = azure_native.signalrservice.SignalRCustomCertificate("signalRCustomCertificateResource",
    key_vault_base_uri="string",
    key_vault_secret_name="string",
    resource_group_name="string",
    resource_name_="string",
    certificate_name="string",
    key_vault_secret_version="string")
Copy
const signalRCustomCertificateResource = new azure_native.signalrservice.SignalRCustomCertificate("signalRCustomCertificateResource", {
    keyVaultBaseUri: "string",
    keyVaultSecretName: "string",
    resourceGroupName: "string",
    resourceName: "string",
    certificateName: "string",
    keyVaultSecretVersion: "string",
});
Copy
type: azure-native:signalrservice:SignalRCustomCertificate
properties:
    certificateName: string
    keyVaultBaseUri: string
    keyVaultSecretName: string
    keyVaultSecretVersion: string
    resourceGroupName: string
    resourceName: string
Copy

SignalRCustomCertificate Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SignalRCustomCertificate resource accepts the following input properties:

KeyVaultBaseUri
This property is required.
Changes to this property will trigger replacement.
string
Base uri of the KeyVault that stores certificate.
KeyVaultSecretName
This property is required.
Changes to this property will trigger replacement.
string
Certificate secret name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
CertificateName Changes to this property will trigger replacement. string
Custom certificate name
KeyVaultSecretVersion Changes to this property will trigger replacement. string
Certificate secret version.
KeyVaultBaseUri
This property is required.
Changes to this property will trigger replacement.
string
Base uri of the KeyVault that stores certificate.
KeyVaultSecretName
This property is required.
Changes to this property will trigger replacement.
string
Certificate secret name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
CertificateName Changes to this property will trigger replacement. string
Custom certificate name
KeyVaultSecretVersion Changes to this property will trigger replacement. string
Certificate secret version.
keyVaultBaseUri
This property is required.
Changes to this property will trigger replacement.
String
Base uri of the KeyVault that stores certificate.
keyVaultSecretName
This property is required.
Changes to this property will trigger replacement.
String
Certificate secret name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
certificateName Changes to this property will trigger replacement. String
Custom certificate name
keyVaultSecretVersion Changes to this property will trigger replacement. String
Certificate secret version.
keyVaultBaseUri
This property is required.
Changes to this property will trigger replacement.
string
Base uri of the KeyVault that stores certificate.
keyVaultSecretName
This property is required.
Changes to this property will trigger replacement.
string
Certificate secret name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
certificateName Changes to this property will trigger replacement. string
Custom certificate name
keyVaultSecretVersion Changes to this property will trigger replacement. string
Certificate secret version.
key_vault_base_uri
This property is required.
Changes to this property will trigger replacement.
str
Base uri of the KeyVault that stores certificate.
key_vault_secret_name
This property is required.
Changes to this property will trigger replacement.
str
Certificate secret name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource.
certificate_name Changes to this property will trigger replacement. str
Custom certificate name
key_vault_secret_version Changes to this property will trigger replacement. str
Certificate secret version.
keyVaultBaseUri
This property is required.
Changes to this property will trigger replacement.
String
Base uri of the KeyVault that stores certificate.
keyVaultSecretName
This property is required.
Changes to this property will trigger replacement.
String
Certificate secret name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
certificateName Changes to this property will trigger replacement. String
Custom certificate name
keyVaultSecretVersion Changes to this property will trigger replacement. String
Certificate secret version.

Outputs

All input properties are implicitly available as output properties. Additionally, the SignalRCustomCertificate resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the resource.
SystemData Pulumi.AzureNative.SignalRService.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
Provisioning state of the resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Provisioning state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
Provisioning state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
Provisioning state of the resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
Provisioning state of the resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:signalrservice:SignalRCustomCertificate myCert /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0