1. Packages
  2. Azure Classic
  3. API Docs
  4. batch
  5. Certificate

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Manages a certificate in an Azure Batch account.

    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 exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                Location = exampleResourceGroup.Location,
                AccountTier = "Standard",
                AccountReplicationType = "LRS",
            });
            var exampleBatch_accountAccount = new Azure.Batch.Account("exampleBatch/accountAccount", new Azure.Batch.AccountArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                Location = exampleResourceGroup.Location,
                PoolAllocationMode = "BatchService",
                StorageAccountId = exampleAccount.Id,
                Tags = 
                {
                    { "env", "test" },
                },
            });
            var exampleCertificate = new Azure.Batch.Certificate("exampleCertificate", new Azure.Batch.CertificateArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                AccountName = exampleBatch / accountAccount.Name,
                Certificate = ReadFileBase64("certificate.pfx"),
                Format = "Pfx",
                Password = "password",
                Thumbprint = "42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
                ThumbprintAlgorithm = "SHA1",
            });
        }
    
    }
    
    package main
    
    import (
    	"encoding/base64"
    	"io/ioutil"
    
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/batch"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
    	"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
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
    			ResourceGroupName:      exampleResourceGroup.Name,
    			Location:               exampleResourceGroup.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = batch.NewAccount(ctx, "exampleBatch/accountAccount", &batch.AccountArgs{
    			ResourceGroupName:  exampleResourceGroup.Name,
    			Location:           exampleResourceGroup.Location,
    			PoolAllocationMode: pulumi.String("BatchService"),
    			StorageAccountId:   exampleAccount.ID(),
    			Tags: pulumi.StringMap{
    				"env": pulumi.String("test"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = batch.NewCertificate(ctx, "exampleCertificate", &batch.CertificateArgs{
    			ResourceGroupName:   exampleResourceGroup.Name,
    			AccountName:         exampleBatch / accountAccount.Name,
    			Certificate:         filebase64OrPanic("certificate.pfx"),
    			Format:              pulumi.String("Pfx"),
    			Password:            pulumi.String("password"),
    			Thumbprint:          pulumi.String("42C107874FD0E4A9583292A2F1098E8FE4B2EDDA"),
    			ThumbprintAlgorithm: pulumi.String("SHA1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    import * from "fs";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleAccount = new azure.storage.Account("exampleAccount", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
    });
    const exampleBatch_accountAccount = new azure.batch.Account("exampleBatch/accountAccount", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.location,
        poolAllocationMode: "BatchService",
        storageAccountId: exampleAccount.id,
        tags: {
            env: "test",
        },
    });
    const exampleCertificate = new azure.batch.Certificate("exampleCertificate", {
        resourceGroupName: exampleResourceGroup.name,
        accountName: exampleBatch / accountAccount.name,
        certificate: Buffer.from(fs.readFileSync("certificate.pfx"), 'binary').toString('base64'),
        format: "Pfx",
        password: "password",
        thumbprint: "42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
        thumbprintAlgorithm: "SHA1",
    });
    
    import pulumi
    import base64
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_account = azure.storage.Account("exampleAccount",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        account_tier="Standard",
        account_replication_type="LRS")
    example_batch_account_account = azure.batch.Account("exampleBatch/accountAccount",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.location,
        pool_allocation_mode="BatchService",
        storage_account_id=example_account.id,
        tags={
            "env": "test",
        })
    example_certificate = azure.batch.Certificate("exampleCertificate",
        resource_group_name=example_resource_group.name,
        account_name=example_batch / account_account["name"],
        certificate=(lambda path: base64.b64encode(open(path).read().encode()).decode())("certificate.pfx"),
        format="Pfx",
        password="password",
        thumbprint="42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
        thumbprint_algorithm="SHA1")
    

    Example coming soon!

    Create Certificate Resource

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

    Constructor syntax

    new Certificate(name: string, args: CertificateArgs, opts?: CustomResourceOptions);
    @overload
    def Certificate(resource_name: str,
                    args: CertificateArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Certificate(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    account_name: Optional[str] = None,
                    certificate: Optional[str] = None,
                    format: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    thumbprint: Optional[str] = None,
                    thumbprint_algorithm: Optional[str] = None,
                    password: Optional[str] = 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:batch:Certificate
    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 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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var examplecertificateResourceResourceFromBatchcertificate = new Azure.Batch.Certificate("examplecertificateResourceResourceFromBatchcertificate", new()
    {
        AccountName = "string",
        BatchCertificate = "string",
        Format = "string",
        ResourceGroupName = "string",
        Thumbprint = "string",
        ThumbprintAlgorithm = "string",
        Password = "string",
    });
    
    example, err := batch.NewCertificate(ctx, "examplecertificateResourceResourceFromBatchcertificate", &batch.CertificateArgs{
    	AccountName:         pulumi.String("string"),
    	Certificate:         pulumi.String("string"),
    	Format:              pulumi.String("string"),
    	ResourceGroupName:   pulumi.String("string"),
    	Thumbprint:          pulumi.String("string"),
    	ThumbprintAlgorithm: pulumi.String("string"),
    	Password:            pulumi.String("string"),
    })
    
    var examplecertificateResourceResourceFromBatchcertificate = new com.pulumi.azure.batch.Certificate("examplecertificateResourceResourceFromBatchcertificate", com.pulumi.azure.batch.CertificateArgs.builder()
        .accountName("string")
        .certificate("string")
        .format("string")
        .resourceGroupName("string")
        .thumbprint("string")
        .thumbprintAlgorithm("string")
        .password("string")
        .build());
    
    examplecertificate_resource_resource_from_batchcertificate = azure.batch.Certificate("examplecertificateResourceResourceFromBatchcertificate",
        account_name="string",
        certificate="string",
        format="string",
        resource_group_name="string",
        thumbprint="string",
        thumbprint_algorithm="string",
        password="string")
    
    const examplecertificateResourceResourceFromBatchcertificate = new azure.batch.Certificate("examplecertificateResourceResourceFromBatchcertificate", {
        accountName: "string",
        certificate: "string",
        format: "string",
        resourceGroupName: "string",
        thumbprint: "string",
        thumbprintAlgorithm: "string",
        password: "string",
    });
    
    type: azure:batch:Certificate
    properties:
        accountName: string
        certificate: string
        format: string
        password: string
        resourceGroupName: string
        thumbprint: string
        thumbprintAlgorithm: string
    

    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

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

    The Certificate resource accepts the following input properties:

    AccountName string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    BatchCertificate string
    The base64-encoded contents of the certificate.
    Format string
    The format of the certificate. Possible values are Cer or Pfx.
    ResourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    Thumbprint string
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    ThumbprintAlgorithm string
    Password string
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    AccountName string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    Certificate string
    The base64-encoded contents of the certificate.
    Format string
    The format of the certificate. Possible values are Cer or Pfx.
    ResourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    Thumbprint string
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    ThumbprintAlgorithm string
    Password string
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    accountName String
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    certificate String
    The base64-encoded contents of the certificate.
    format String
    The format of the certificate. Possible values are Cer or Pfx.
    resourceGroupName String
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    thumbprint String
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    thumbprintAlgorithm String
    password String
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    accountName string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    certificate string
    The base64-encoded contents of the certificate.
    format string
    The format of the certificate. Possible values are Cer or Pfx.
    resourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    thumbprint string
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    thumbprintAlgorithm string
    password string
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    account_name str
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    certificate str
    The base64-encoded contents of the certificate.
    format str
    The format of the certificate. Possible values are Cer or Pfx.
    resource_group_name str
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    thumbprint str
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    thumbprint_algorithm str
    password str
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    accountName String
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    certificate String
    The base64-encoded contents of the certificate.
    format String
    The format of the certificate. Possible values are Cer or Pfx.
    resourceGroupName String
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    thumbprint String
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    thumbprintAlgorithm String
    password String
    The password to access the certificate's private key. This can only be specified when format is Pfx.

    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.
    Name string
    The generated name of the certificate.
    PublicData string
    The public key of the certificate.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The generated name of the certificate.
    PublicData string
    The public key of the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The generated name of the certificate.
    publicData String
    The public key of the certificate.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The generated name of the certificate.
    publicData string
    The public key of the certificate.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The generated name of the certificate.
    public_data str
    The public key of the certificate.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The generated name of the certificate.
    publicData String
    The public key of the certificate.

    Look up 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,
            account_name: Optional[str] = None,
            certificate: Optional[str] = None,
            format: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            public_data: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            thumbprint: Optional[str] = None,
            thumbprint_algorithm: 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)
    resources:  _:    type: azure:batch:Certificate    get:      id: ${id}
    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:
    AccountName string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    BatchCertificate string
    The base64-encoded contents of the certificate.
    Format string
    The format of the certificate. Possible values are Cer or Pfx.
    Name string
    The generated name of the certificate.
    Password string
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    PublicData string
    The public key of the certificate.
    ResourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    Thumbprint string
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    ThumbprintAlgorithm string
    AccountName string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    Certificate string
    The base64-encoded contents of the certificate.
    Format string
    The format of the certificate. Possible values are Cer or Pfx.
    Name string
    The generated name of the certificate.
    Password string
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    PublicData string
    The public key of the certificate.
    ResourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    Thumbprint string
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    ThumbprintAlgorithm string
    accountName String
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    certificate String
    The base64-encoded contents of the certificate.
    format String
    The format of the certificate. Possible values are Cer or Pfx.
    name String
    The generated name of the certificate.
    password String
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    publicData String
    The public key of the certificate.
    resourceGroupName String
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    thumbprint String
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    thumbprintAlgorithm String
    accountName string
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    certificate string
    The base64-encoded contents of the certificate.
    format string
    The format of the certificate. Possible values are Cer or Pfx.
    name string
    The generated name of the certificate.
    password string
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    publicData string
    The public key of the certificate.
    resourceGroupName string
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    thumbprint string
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    thumbprintAlgorithm string
    account_name str
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    certificate str
    The base64-encoded contents of the certificate.
    format str
    The format of the certificate. Possible values are Cer or Pfx.
    name str
    The generated name of the certificate.
    password str
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    public_data str
    The public key of the certificate.
    resource_group_name str
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    thumbprint str
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    thumbprint_algorithm str
    accountName String
    Specifies the name of the Batch account. Changing this forces a new resource to be created.
    certificate String
    The base64-encoded contents of the certificate.
    format String
    The format of the certificate. Possible values are Cer or Pfx.
    name String
    The generated name of the certificate.
    password String
    The password to access the certificate's private key. This can only be specified when format is Pfx.
    publicData String
    The public key of the certificate.
    resourceGroupName String
    The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
    thumbprint String
    The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
    thumbprintAlgorithm String

    Import

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

     $ pulumi import azure:batch/certificate:Certificate example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.Batch/batchAccounts/batch1/certificates/certificate1
    

    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.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.