We recommend using Azure Native.
azure.batch.Certificate
Explore with Pulumi AI
Manages a certificate in an Azure Batch account.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as std from "@pulumi/std";
const example = new azure.core.ResourceGroup("example", {
name: "testbatch",
location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
name: "teststorage",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const exampleAccount2 = new azure.batch.Account("example", {
name: "testbatchaccount",
resourceGroupName: example.name,
location: example.location,
poolAllocationMode: "BatchService",
storageAccountId: exampleAccount.id,
storageAccountAuthenticationMode: "StorageKeys",
tags: {
env: "test",
},
});
const exampleCertificate = new azure.batch.Certificate("example", {
resourceGroupName: example.name,
accountName: exampleAccount2.name,
certificate: std.filebase64({
input: "certificate.pfx",
}).then(invoke => invoke.result),
format: "Pfx",
password: "password",
thumbprint: "42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
thumbprintAlgorithm: "SHA1",
});
import pulumi
import pulumi_azure as azure
import pulumi_std as std
example = azure.core.ResourceGroup("example",
name="testbatch",
location="West Europe")
example_account = azure.storage.Account("example",
name="teststorage",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="LRS")
example_account2 = azure.batch.Account("example",
name="testbatchaccount",
resource_group_name=example.name,
location=example.location,
pool_allocation_mode="BatchService",
storage_account_id=example_account.id,
storage_account_authentication_mode="StorageKeys",
tags={
"env": "test",
})
example_certificate = azure.batch.Certificate("example",
resource_group_name=example.name,
account_name=example_account2.name,
certificate=std.filebase64(input="certificate.pfx").result,
format="Pfx",
password="password",
thumbprint="42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
thumbprint_algorithm="SHA1")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/batch"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
"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 {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("testbatch"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("teststorage"),
ResourceGroupName: example.Name,
Location: example.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("LRS"),
})
if err != nil {
return err
}
exampleAccount2, err := batch.NewAccount(ctx, "example", &batch.AccountArgs{
Name: pulumi.String("testbatchaccount"),
ResourceGroupName: example.Name,
Location: example.Location,
PoolAllocationMode: pulumi.String("BatchService"),
StorageAccountId: exampleAccount.ID(),
StorageAccountAuthenticationMode: pulumi.String("StorageKeys"),
Tags: pulumi.StringMap{
"env": pulumi.String("test"),
},
})
if err != nil {
return err
}
invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
Input: "certificate.pfx",
}, nil)
if err != nil {
return err
}
_, err = batch.NewCertificate(ctx, "example", &batch.CertificateArgs{
ResourceGroupName: example.Name,
AccountName: exampleAccount2.Name,
Certificate: pulumi.String(invokeFilebase64.Result),
Format: pulumi.String("Pfx"),
Password: pulumi.String("password"),
Thumbprint: pulumi.String("42C107874FD0E4A9583292A2F1098E8FE4B2EDDA"),
ThumbprintAlgorithm: pulumi.String("SHA1"),
})
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 example = new Azure.Core.ResourceGroup("example", new()
{
Name = "testbatch",
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "teststorage",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var exampleAccount2 = new Azure.Batch.Account("example", new()
{
Name = "testbatchaccount",
ResourceGroupName = example.Name,
Location = example.Location,
PoolAllocationMode = "BatchService",
StorageAccountId = exampleAccount.Id,
StorageAccountAuthenticationMode = "StorageKeys",
Tags =
{
{ "env", "test" },
},
});
var exampleCertificate = new Azure.Batch.Certificate("example", new()
{
ResourceGroupName = example.Name,
AccountName = exampleAccount2.Name,
BatchCertificate = Std.Filebase64.Invoke(new()
{
Input = "certificate.pfx",
}).Apply(invoke => invoke.Result),
Format = "Pfx",
Password = "password",
Thumbprint = "42C107874FD0E4A9583292A2F1098E8FE4B2EDDA",
ThumbprintAlgorithm = "SHA1",
});
});
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.batch.Account;
import com.pulumi.azure.batch.AccountArgs;
import com.pulumi.azure.batch.Certificate;
import com.pulumi.azure.batch.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("testbatch")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("teststorage")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.build());
var exampleAccount2 = new Account("exampleAccount2", AccountArgs.builder()
.name("testbatchaccount")
.resourceGroupName(example.name())
.location(example.location())
.poolAllocationMode("BatchService")
.storageAccountId(exampleAccount.id())
.storageAccountAuthenticationMode("StorageKeys")
.tags(Map.of("env", "test"))
.build());
var exampleCertificate = new Certificate("exampleCertificate", CertificateArgs.builder()
.resourceGroupName(example.name())
.accountName(exampleAccount2.name())
.certificate(StdFunctions.filebase64(Filebase64Args.builder()
.input("certificate.pfx")
.build()).result())
.format("Pfx")
.password("password")
.thumbprint("42C107874FD0E4A9583292A2F1098E8FE4B2EDDA")
.thumbprintAlgorithm("SHA1")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: testbatch
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: teststorage
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: LRS
exampleAccount2:
type: azure:batch:Account
name: example
properties:
name: testbatchaccount
resourceGroupName: ${example.name}
location: ${example.location}
poolAllocationMode: BatchService
storageAccountId: ${exampleAccount.id}
storageAccountAuthenticationMode: StorageKeys
tags:
env: test
exampleCertificate:
type: azure:batch:Certificate
name: example
properties:
resourceGroupName: ${example.name}
accountName: ${exampleAccount2.name}
certificate:
fn::invoke:
Function: std:filebase64
Arguments:
input: certificate.pfx
Return: result
format: Pfx
password: password
thumbprint: 42C107874FD0E4A9583292A2F1098E8FE4B2EDDA
thumbprintAlgorithm: SHA1
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 Certificate("examplecertificateResourceResourceFromBatchcertificate", 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:
- Account
Name string - Specifies the name of the Batch account. Changing this forces a new resource to be created.
- Batch
Certificate string - The base64-encoded contents of the certificate.
- Format string
- The format of the certificate. Possible values are
Cer
orPfx
. - Resource
Group stringName - 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. Changing this forces a new resource to be created.
- Thumbprint
Algorithm string - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created. - Password string
- The password to access the certificate's private key. This can only be specified when
format
isPfx
.
- Account
Name 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
orPfx
. - Resource
Group stringName - 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. Changing this forces a new resource to be created.
- Thumbprint
Algorithm string - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created. - Password string
- The password to access the certificate's private key. This can only be specified when
format
isPfx
.
- account
Name 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
orPfx
. - resource
Group StringName - 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. Changing this forces a new resource to be created.
- thumbprint
Algorithm String - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created. - password String
- The password to access the certificate's private key. This can only be specified when
format
isPfx
.
- account
Name 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
orPfx
. - resource
Group stringName - 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. Changing this forces a new resource to be created.
- thumbprint
Algorithm string - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created. - password string
- The password to access the certificate's private key. This can only be specified when
format
isPfx
.
- 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
orPfx
. - resource_
group_ strname - 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. Changing this forces a new resource to be created.
- thumbprint_
algorithm str - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created. - password str
- The password to access the certificate's private key. This can only be specified when
format
isPfx
.
- account
Name 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
orPfx
. - resource
Group StringName - 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. Changing this forces a new resource to be created.
- thumbprint
Algorithm String - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created. - password String
- The password to access the certificate's private key. This can only be specified when
format
isPfx
.
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.
- Public
Data 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.
- Public
Data 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.
- public
Data 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.
- public
Data 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.
- public
Data 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)
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.
- Account
Name string - Specifies the name of the Batch account. Changing this forces a new resource to be created.
- Batch
Certificate string - The base64-encoded contents of the certificate.
- Format string
- The format of the certificate. Possible values are
Cer
orPfx
. - 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
isPfx
. - Public
Data string - The public key of the certificate.
- Resource
Group stringName - 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. Changing this forces a new resource to be created.
- Thumbprint
Algorithm string - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created.
- Account
Name 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
orPfx
. - 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
isPfx
. - Public
Data string - The public key of the certificate.
- Resource
Group stringName - 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. Changing this forces a new resource to be created.
- Thumbprint
Algorithm string - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created.
- account
Name 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
orPfx
. - 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
isPfx
. - public
Data String - The public key of the certificate.
- resource
Group StringName - 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. Changing this forces a new resource to be created.
- thumbprint
Algorithm String - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created.
- account
Name 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
orPfx
. - 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
isPfx
. - public
Data string - The public key of the certificate.
- resource
Group stringName - 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. Changing this forces a new resource to be created.
- thumbprint
Algorithm string - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created.
- 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
orPfx
. - 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
isPfx
. - public_
data str - The public key of the certificate.
- resource_
group_ strname - 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. Changing this forces a new resource to be created.
- thumbprint_
algorithm str - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created.
- account
Name 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
orPfx
. - 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
isPfx
. - public
Data String - The public key of the certificate.
- resource
Group StringName - 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. Changing this forces a new resource to be created.
- thumbprint
Algorithm String - The algorithm of the certificate thumbprint. At this time the only supported value is
SHA1
. Changing this forces a new resource to be created.
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.