Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.14.0 published on Thursday, Jul 28, 2022 by Pulumi

Certificate

Manages an IotHub Certificate.

Example Usage

using System;
using System.IO;
using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
	private static string ReadFileBase64(string path) {
		return Convert.ToBase64String(Encoding.UTF8.GetBytes(File.ReadAllText(path)))
	}

    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleIoTHub = new Azure.Iot.IoTHub("exampleIoTHub", new Azure.Iot.IoTHubArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            Sku = new Azure.Iot.Inputs.IoTHubSkuArgs
            {
                Name = "B1",
                Capacity = 1,
            },
        });
        var exampleCertificate = new Azure.Iot.Certificate("exampleCertificate", new Azure.Iot.CertificateArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            IothubName = exampleIoTHub.Name,
            IsVerified = true,
            CertificateContent = ReadFileBase64("example.cer"),
        });
    }

}
package main

import (
	"encoding/base64"
	"io/ioutil"

	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/iot"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func filebase64OrPanic(path string) pulumi.StringPtrInput {
	if fileData, err := ioutil.ReadFile(path); err == nil {
		return pulumi.String(base64.StdEncoding.EncodeToString(fileData[:]))
	} else {
		panic(err.Error())
	}
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleIoTHub, err := iot.NewIoTHub(ctx, "exampleIoTHub", &iot.IoTHubArgs{
			ResourceGroupName: exampleResourceGroup.Name,
			Location:          exampleResourceGroup.Location,
			Sku: &iot.IoTHubSkuArgs{
				Name:     pulumi.String("B1"),
				Capacity: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		_, err = iot.NewCertificate(ctx, "exampleCertificate", &iot.CertificateArgs{
			ResourceGroupName:  exampleResourceGroup.Name,
			IothubName:         exampleIoTHub.Name,
			IsVerified:         pulumi.Bool(true),
			CertificateContent: filebase64OrPanic("example.cer"),
		})
		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.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.iot.IoTHub;
import com.pulumi.azure.iot.IoTHubArgs;
import com.pulumi.azure.iot.inputs.IoTHubSkuArgs;
import com.pulumi.azure.iot.Certificate;
import com.pulumi.azure.iot.CertificateArgs;
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 Europe")
            .build());

        var exampleIoTHub = new IoTHub("exampleIoTHub", IoTHubArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .sku(IoTHubSkuArgs.builder()
                .name("B1")
                .capacity("1")
                .build())
            .build());

        var exampleCertificate = new Certificate("exampleCertificate", CertificateArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .iothubName(exampleIoTHub.name())
            .isVerified(true)
            .certificateContent(Base64.getEncoder().encodeToString(Files.readAllBytes(Paths.get("example.cer"))))
            .build());

    }
}
import pulumi
import base64
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_io_t_hub = azure.iot.IoTHub("exampleIoTHub",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    sku=azure.iot.IoTHubSkuArgs(
        name="B1",
        capacity=1,
    ))
example_certificate = azure.iot.Certificate("exampleCertificate",
    resource_group_name=example_resource_group.name,
    iothub_name=example_io_t_hub.name,
    is_verified=True,
    certificate_content=(lambda path: base64.b64encode(open(path).read().encode()).decode())("example.cer"))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as fs from "fs";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleIoTHub = new azure.iot.IoTHub("exampleIoTHub", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    sku: {
        name: "B1",
        capacity: 1,
    },
});
const exampleCertificate = new azure.iot.Certificate("exampleCertificate", {
    resourceGroupName: exampleResourceGroup.name,
    iothubName: exampleIoTHub.name,
    isVerified: true,
    certificateContent: Buffer.from(fs.readFileSync("example.cer"), 'binary').toString('base64'),
});

Coming soon!

Create a Certificate Resource

new Certificate(name: string, args: CertificateArgs, opts?: CustomResourceOptions);
@overload
def Certificate(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                certificate_content: Optional[str] = None,
                iothub_name: Optional[str] = None,
                is_verified: Optional[bool] = None,
                name: Optional[str] = None,
                resource_group_name: Optional[str] = None)
@overload
def Certificate(resource_name: str,
                args: CertificateArgs,
                opts: Optional[ResourceOptions] = None)
func NewCertificate(ctx *Context, name string, args CertificateArgs, opts ...ResourceOption) (*Certificate, error)
public Certificate(string name, CertificateArgs args, CustomResourceOptions? opts = null)
public Certificate(String name, CertificateArgs args)
public Certificate(String name, CertificateArgs args, CustomResourceOptions options)
type: azure:iot:Certificate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CertificateArgs
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 CertificateArgs
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 CertificateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CertificateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CertificateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Certificate 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 Certificate resource accepts the following input properties:

CertificateContent string

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

IothubName string

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

IsVerified bool

Is the certificate verified? Defaults to false.

Name string

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

CertificateContent string

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

IothubName string

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

IsVerified bool

Is the certificate verified? Defaults to false.

Name string

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

certificateContent String

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iothubName String

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

isVerified Boolean

Is the certificate verified? Defaults to false.

name String

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

certificateContent string

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iothubName string

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

isVerified boolean

Is the certificate verified? Defaults to false.

name string

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

certificate_content str

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iothub_name str

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

resource_group_name str

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

is_verified bool

Is the certificate verified? Defaults to false.

name str

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

certificateContent String

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iothubName String

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

isVerified Boolean

Is the certificate verified? Defaults to false.

name String

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the Certificate 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 an Existing Certificate Resource

Get an existing Certificate 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?: CertificateState, opts?: CustomResourceOptions): Certificate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_content: Optional[str] = None,
        iothub_name: Optional[str] = None,
        is_verified: Optional[bool] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None) -> Certificate
func GetCertificate(ctx *Context, name string, id IDInput, state *CertificateState, opts ...ResourceOption) (*Certificate, error)
public static Certificate Get(string name, Input<string> id, CertificateState? state, CustomResourceOptions? opts = null)
public static Certificate get(String name, Output<String> id, CertificateState 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.
The following state arguments are supported:
CertificateContent string

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

IothubName string

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

IsVerified bool

Is the certificate verified? Defaults to false.

Name string

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

CertificateContent string

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

IothubName string

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

IsVerified bool

Is the certificate verified? Defaults to false.

Name string

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

ResourceGroupName string

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

certificateContent String

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iothubName String

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

isVerified Boolean

Is the certificate verified? Defaults to false.

name String

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

certificateContent string

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iothubName string

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

isVerified boolean

Is the certificate verified? Defaults to false.

name string

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

resourceGroupName string

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

certificate_content str

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iothub_name str

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

is_verified bool

Is the certificate verified? Defaults to false.

name str

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

resource_group_name str

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

certificateContent String

The Base-64 representation of the X509 leaf certificate .cer file or just a .pem file content.

iothubName String

The name of the IoTHub that this certificate will be attached to. Changing this forces a new resource to be created.

isVerified Boolean

Is the certificate verified? Defaults to false.

name String

Specifies the name of the IotHub Certificate resource. Changing this forces a new resource to be created.

resourceGroupName String

The name of the resource group under which the IotHub Certificate resource has to be created. Changing this forces a new resource to be created.

Import

IoTHub Certificates can be imported using the resource id, e.g.

 $ pulumi import azure:iot/certificate:Certificate example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Devices/IotHubs/example/Certificates/example

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.