We recommend using Azure Native.
Manages a Certificate within an API Management Workspace.
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: "example-resources",
location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
name: "example-apim",
location: example.location,
resourceGroupName: example.name,
publisherName: "My Company",
publisherEmail: "company@terraform.io",
skuName: "Premium_1",
});
const exampleWorkspace = new azure.apimanagement.Workspace("example", {
name: "example-workspace",
apiManagementId: exampleService.id,
displayName: "Example Workspace",
});
const exampleWorkspaceCertificate = new azure.apimanagement.WorkspaceCertificate("example", {
name: "example-cert",
apiManagementWorkspaceId: exampleWorkspace.id,
certificateDataBase64: std.filebase64({
input: "example.pfx",
}).then(invoke => invoke.result),
password: "terraform",
});
import pulumi
import pulumi_azure as azure
import pulumi_std as std
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_service = azure.apimanagement.Service("example",
name="example-apim",
location=example.location,
resource_group_name=example.name,
publisher_name="My Company",
publisher_email="company@terraform.io",
sku_name="Premium_1")
example_workspace = azure.apimanagement.Workspace("example",
name="example-workspace",
api_management_id=example_service.id,
display_name="Example Workspace")
example_workspace_certificate = azure.apimanagement.WorkspaceCertificate("example",
name="example-cert",
api_management_workspace_id=example_workspace.id,
certificate_data_base64=std.filebase64(input="example.pfx").result,
password="terraform")
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"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("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
Name: pulumi.String("example-apim"),
Location: example.Location,
ResourceGroupName: example.Name,
PublisherName: pulumi.String("My Company"),
PublisherEmail: pulumi.String("company@terraform.io"),
SkuName: pulumi.String("Premium_1"),
})
if err != nil {
return err
}
exampleWorkspace, err := apimanagement.NewWorkspace(ctx, "example", &apimanagement.WorkspaceArgs{
Name: pulumi.String("example-workspace"),
ApiManagementId: exampleService.ID(),
DisplayName: pulumi.String("Example Workspace"),
})
if err != nil {
return err
}
invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
Input: "example.pfx",
}, nil)
if err != nil {
return err
}
_, err = apimanagement.NewWorkspaceCertificate(ctx, "example", &apimanagement.WorkspaceCertificateArgs{
Name: pulumi.String("example-cert"),
ApiManagementWorkspaceId: exampleWorkspace.ID(),
CertificateDataBase64: pulumi.String(invokeFilebase64.Result),
Password: pulumi.String("terraform"),
})
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 = "example-resources",
Location = "West Europe",
});
var exampleService = new Azure.ApiManagement.Service("example", new()
{
Name = "example-apim",
Location = example.Location,
ResourceGroupName = example.Name,
PublisherName = "My Company",
PublisherEmail = "company@terraform.io",
SkuName = "Premium_1",
});
var exampleWorkspace = new Azure.ApiManagement.Workspace("example", new()
{
Name = "example-workspace",
ApiManagementId = exampleService.Id,
DisplayName = "Example Workspace",
});
var exampleWorkspaceCertificate = new Azure.ApiManagement.WorkspaceCertificate("example", new()
{
Name = "example-cert",
ApiManagementWorkspaceId = exampleWorkspace.Id,
CertificateDataBase64 = Std.Filebase64.Invoke(new()
{
Input = "example.pfx",
}).Apply(invoke => invoke.Result),
Password = "terraform",
});
});
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.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.Workspace;
import com.pulumi.azure.apimanagement.WorkspaceArgs;
import com.pulumi.azure.apimanagement.WorkspaceCertificate;
import com.pulumi.azure.apimanagement.WorkspaceCertificateArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.Filebase64Args;
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("example-resources")
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.name("example-apim")
.location(example.location())
.resourceGroupName(example.name())
.publisherName("My Company")
.publisherEmail("company@terraform.io")
.skuName("Premium_1")
.build());
var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
.name("example-workspace")
.apiManagementId(exampleService.id())
.displayName("Example Workspace")
.build());
var exampleWorkspaceCertificate = new WorkspaceCertificate("exampleWorkspaceCertificate", WorkspaceCertificateArgs.builder()
.name("example-cert")
.apiManagementWorkspaceId(exampleWorkspace.id())
.certificateDataBase64(StdFunctions.filebase64(Filebase64Args.builder()
.input("example.pfx")
.build()).result())
.password("terraform")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleService:
type: azure:apimanagement:Service
name: example
properties:
name: example-apim
location: ${example.location}
resourceGroupName: ${example.name}
publisherName: My Company
publisherEmail: company@terraform.io
skuName: Premium_1
exampleWorkspace:
type: azure:apimanagement:Workspace
name: example
properties:
name: example-workspace
apiManagementId: ${exampleService.id}
displayName: Example Workspace
exampleWorkspaceCertificate:
type: azure:apimanagement:WorkspaceCertificate
name: example
properties:
name: example-cert
apiManagementWorkspaceId: ${exampleWorkspace.id}
certificateDataBase64:
fn::invoke:
function: std:filebase64
arguments:
input: example.pfx
return: result
password: terraform
API Providers
This resource uses the following Azure API Providers:
Microsoft.ApiManagement- 2024-05-01
Create WorkspaceCertificate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkspaceCertificate(name: string, args: WorkspaceCertificateArgs, opts?: CustomResourceOptions);@overload
def WorkspaceCertificate(resource_name: str,
args: WorkspaceCertificateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def WorkspaceCertificate(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_management_workspace_id: Optional[str] = None,
certificate_data_base64: Optional[str] = None,
key_vault_secret_id: Optional[str] = None,
name: Optional[str] = None,
password: Optional[str] = None,
user_assigned_identity_client_id: Optional[str] = None)func NewWorkspaceCertificate(ctx *Context, name string, args WorkspaceCertificateArgs, opts ...ResourceOption) (*WorkspaceCertificate, error)public WorkspaceCertificate(string name, WorkspaceCertificateArgs args, CustomResourceOptions? opts = null)
public WorkspaceCertificate(String name, WorkspaceCertificateArgs args)
public WorkspaceCertificate(String name, WorkspaceCertificateArgs args, CustomResourceOptions options)
type: azure:apimanagement:WorkspaceCertificate
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 WorkspaceCertificateArgs
- 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 WorkspaceCertificateArgs
- 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 WorkspaceCertificateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkspaceCertificateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkspaceCertificateArgs
- 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 workspaceCertificateResource = new Azure.ApiManagement.WorkspaceCertificate("workspaceCertificateResource", new()
{
ApiManagementWorkspaceId = "string",
CertificateDataBase64 = "string",
KeyVaultSecretId = "string",
Name = "string",
Password = "string",
UserAssignedIdentityClientId = "string",
});
example, err := apimanagement.NewWorkspaceCertificate(ctx, "workspaceCertificateResource", &apimanagement.WorkspaceCertificateArgs{
ApiManagementWorkspaceId: pulumi.String("string"),
CertificateDataBase64: pulumi.String("string"),
KeyVaultSecretId: pulumi.String("string"),
Name: pulumi.String("string"),
Password: pulumi.String("string"),
UserAssignedIdentityClientId: pulumi.String("string"),
})
var workspaceCertificateResource = new WorkspaceCertificate("workspaceCertificateResource", WorkspaceCertificateArgs.builder()
.apiManagementWorkspaceId("string")
.certificateDataBase64("string")
.keyVaultSecretId("string")
.name("string")
.password("string")
.userAssignedIdentityClientId("string")
.build());
workspace_certificate_resource = azure.apimanagement.WorkspaceCertificate("workspaceCertificateResource",
api_management_workspace_id="string",
certificate_data_base64="string",
key_vault_secret_id="string",
name="string",
password="string",
user_assigned_identity_client_id="string")
const workspaceCertificateResource = new azure.apimanagement.WorkspaceCertificate("workspaceCertificateResource", {
apiManagementWorkspaceId: "string",
certificateDataBase64: "string",
keyVaultSecretId: "string",
name: "string",
password: "string",
userAssignedIdentityClientId: "string",
});
type: azure:apimanagement:WorkspaceCertificate
properties:
apiManagementWorkspaceId: string
certificateDataBase64: string
keyVaultSecretId: string
name: string
password: string
userAssignedIdentityClientId: string
WorkspaceCertificate 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 WorkspaceCertificate resource accepts the following input properties:
- Api
Management stringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- Certificate
Data stringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- Key
Vault stringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- Name string
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- Password string
- Specifies the password used to access the
certificate_data_base64. - User
Assigned stringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- Api
Management stringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- Certificate
Data stringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- Key
Vault stringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- Name string
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- Password string
- Specifies the password used to access the
certificate_data_base64. - User
Assigned stringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- api
Management StringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- certificate
Data StringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- key
Vault StringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- name String
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- password String
- Specifies the password used to access the
certificate_data_base64. - user
Assigned StringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- api
Management stringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- certificate
Data stringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- key
Vault stringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- name string
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- password string
- Specifies the password used to access the
certificate_data_base64. - user
Assigned stringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- api_
management_ strworkspace_ id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- certificate_
data_ strbase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- key_
vault_ strsecret_ id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- name str
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- password str
- Specifies the password used to access the
certificate_data_base64. - user_
assigned_ stridentity_ client_ id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- api
Management StringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- certificate
Data StringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- key
Vault StringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- name String
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- password String
- Specifies the password used to access the
certificate_data_base64. - user
Assigned StringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkspaceCertificate resource produces the following output properties:
- Expiration string
- The expiration date of the API Management Workspace Certificate.
- Id string
- The provider-assigned unique ID for this managed resource.
- Subject string
- The subject name of the API Management Workspace Certificate.
- Thumbprint string
- The thumbprint of the API Management Workspace Certificate.
- Expiration string
- The expiration date of the API Management Workspace Certificate.
- Id string
- The provider-assigned unique ID for this managed resource.
- Subject string
- The subject name of the API Management Workspace Certificate.
- Thumbprint string
- The thumbprint of the API Management Workspace Certificate.
- expiration String
- The expiration date of the API Management Workspace Certificate.
- id String
- The provider-assigned unique ID for this managed resource.
- subject String
- The subject name of the API Management Workspace Certificate.
- thumbprint String
- The thumbprint of the API Management Workspace Certificate.
- expiration string
- The expiration date of the API Management Workspace Certificate.
- id string
- The provider-assigned unique ID for this managed resource.
- subject string
- The subject name of the API Management Workspace Certificate.
- thumbprint string
- The thumbprint of the API Management Workspace Certificate.
- expiration str
- The expiration date of the API Management Workspace Certificate.
- id str
- The provider-assigned unique ID for this managed resource.
- subject str
- The subject name of the API Management Workspace Certificate.
- thumbprint str
- The thumbprint of the API Management Workspace Certificate.
- expiration String
- The expiration date of the API Management Workspace Certificate.
- id String
- The provider-assigned unique ID for this managed resource.
- subject String
- The subject name of the API Management Workspace Certificate.
- thumbprint String
- The thumbprint of the API Management Workspace Certificate.
Look up Existing WorkspaceCertificate Resource
Get an existing WorkspaceCertificate 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?: WorkspaceCertificateState, opts?: CustomResourceOptions): WorkspaceCertificate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_management_workspace_id: Optional[str] = None,
certificate_data_base64: Optional[str] = None,
expiration: Optional[str] = None,
key_vault_secret_id: Optional[str] = None,
name: Optional[str] = None,
password: Optional[str] = None,
subject: Optional[str] = None,
thumbprint: Optional[str] = None,
user_assigned_identity_client_id: Optional[str] = None) -> WorkspaceCertificatefunc GetWorkspaceCertificate(ctx *Context, name string, id IDInput, state *WorkspaceCertificateState, opts ...ResourceOption) (*WorkspaceCertificate, error)public static WorkspaceCertificate Get(string name, Input<string> id, WorkspaceCertificateState? state, CustomResourceOptions? opts = null)public static WorkspaceCertificate get(String name, Output<String> id, WorkspaceCertificateState state, CustomResourceOptions options)resources: _: type: azure:apimanagement:WorkspaceCertificate 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.
- Api
Management stringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- Certificate
Data stringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- Expiration string
- The expiration date of the API Management Workspace Certificate.
- Key
Vault stringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- Name string
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- Password string
- Specifies the password used to access the
certificate_data_base64. - Subject string
- The subject name of the API Management Workspace Certificate.
- Thumbprint string
- The thumbprint of the API Management Workspace Certificate.
- User
Assigned stringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- Api
Management stringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- Certificate
Data stringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- Expiration string
- The expiration date of the API Management Workspace Certificate.
- Key
Vault stringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- Name string
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- Password string
- Specifies the password used to access the
certificate_data_base64. - Subject string
- The subject name of the API Management Workspace Certificate.
- Thumbprint string
- The thumbprint of the API Management Workspace Certificate.
- User
Assigned stringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- api
Management StringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- certificate
Data StringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- expiration String
- The expiration date of the API Management Workspace Certificate.
- key
Vault StringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- name String
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- password String
- Specifies the password used to access the
certificate_data_base64. - subject String
- The subject name of the API Management Workspace Certificate.
- thumbprint String
- The thumbprint of the API Management Workspace Certificate.
- user
Assigned StringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- api
Management stringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- certificate
Data stringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- expiration string
- The expiration date of the API Management Workspace Certificate.
- key
Vault stringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- name string
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- password string
- Specifies the password used to access the
certificate_data_base64. - subject string
- The subject name of the API Management Workspace Certificate.
- thumbprint string
- The thumbprint of the API Management Workspace Certificate.
- user
Assigned stringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- api_
management_ strworkspace_ id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- certificate_
data_ strbase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- expiration str
- The expiration date of the API Management Workspace Certificate.
- key_
vault_ strsecret_ id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- name str
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- password str
- Specifies the password used to access the
certificate_data_base64. - subject str
- The subject name of the API Management Workspace Certificate.
- thumbprint str
- The thumbprint of the API Management Workspace Certificate.
- user_
assigned_ stridentity_ client_ id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
- api
Management StringWorkspace Id - Specifies the ID of the API Management Workspace. Changing this forces a new resource to be created.
- certificate
Data StringBase64 Specifies the base64-encoded string containing the certificate in PKCS#12 (.pfx) format.
Note: This is required when
passwordis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- expiration String
- The expiration date of the API Management Workspace Certificate.
- key
Vault StringSecret Id Specifies the ID of the key vault secret.
Note: This is required when
user_assigned_identity_client_idis specified. Exactly one ofcertificate_data_base64orkey_vault_secret_idmust be specified.- name String
- Specifies the name of the API Management Workspace Certificate. Changing this forces a new resource to be created.
- password String
- Specifies the password used to access the
certificate_data_base64. - subject String
- The subject name of the API Management Workspace Certificate.
- thumbprint String
- The thumbprint of the API Management Workspace Certificate.
- user
Assigned StringIdentity Client Id - Specifies the client ID of user-assigned identity to be used for accessing the
key_vault_secret_id.
Import
API Management Workspace Certificates can be imported using the resource id, e.g.
$ pulumi import azure:apimanagement/workspaceCertificate:WorkspaceCertificate example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/workspaces/workspace1/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
azurermTerraform Provider.
