Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. keyvault
  5. ManagedHardwareSecurityModuleRoleAssignment

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

azure.keyvault.ManagedHardwareSecurityModuleRoleAssignment

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Managed Hardware Security Module Role Assignment.

    Create ManagedHardwareSecurityModuleRoleAssignment Resource

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

    Constructor syntax

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

@overload
def ManagedHardwareSecurityModuleRoleAssignment(resource_name: str,
                                                opts: Optional[ResourceOptions] = None,
                                                principal_id: Optional[str] = None,
                                                role_definition_id: Optional[str] = None,
                                                scope: Optional[str] = None,
                                                managed_hsm_id: Optional[str] = None,
                                                name: Optional[str] = None,
                                                vault_base_url: Optional[str] = None)
    func NewManagedHardwareSecurityModuleRoleAssignment(ctx *Context, name string, args ManagedHardwareSecurityModuleRoleAssignmentArgs, opts ...ResourceOption) (*ManagedHardwareSecurityModuleRoleAssignment, error)
    public ManagedHardwareSecurityModuleRoleAssignment(string name, ManagedHardwareSecurityModuleRoleAssignmentArgs args, CustomResourceOptions? opts = null)
    public ManagedHardwareSecurityModuleRoleAssignment(String name, ManagedHardwareSecurityModuleRoleAssignmentArgs args)
public ManagedHardwareSecurityModuleRoleAssignment(String name, ManagedHardwareSecurityModuleRoleAssignmentArgs args, CustomResourceOptions options)

    type: azure:keyvault:ManagedHardwareSecurityModuleRoleAssignment
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 ManagedHardwareSecurityModuleRoleAssignmentArgs
    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 ManagedHardwareSecurityModuleRoleAssignmentArgs
    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 ManagedHardwareSecurityModuleRoleAssignmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagedHardwareSecurityModuleRoleAssignmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagedHardwareSecurityModuleRoleAssignmentArgs
    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 managedHardwareSecurityModuleRoleAssignmentResource = new Azure.KeyVault.ManagedHardwareSecurityModuleRoleAssignment("managedHardwareSecurityModuleRoleAssignmentResource", new()
{
    PrincipalId = "string",
    RoleDefinitionId = "string",
    Scope = "string",
    ManagedHsmId = "string",
    Name = "string",
});

    example, err := keyvault.NewManagedHardwareSecurityModuleRoleAssignment(ctx, "managedHardwareSecurityModuleRoleAssignmentResource", &keyvault.ManagedHardwareSecurityModuleRoleAssignmentArgs{
	PrincipalId:      pulumi.String("string"),
	RoleDefinitionId: pulumi.String("string"),
	Scope:            pulumi.String("string"),
	ManagedHsmId:     pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var managedHardwareSecurityModuleRoleAssignmentResource = new ManagedHardwareSecurityModuleRoleAssignment("managedHardwareSecurityModuleRoleAssignmentResource", ManagedHardwareSecurityModuleRoleAssignmentArgs.builder()
    .principalId("string")
    .roleDefinitionId("string")
    .scope("string")
    .managedHsmId("string")
    .name("string")
    .build());

    managed_hardware_security_module_role_assignment_resource = azure.keyvault.ManagedHardwareSecurityModuleRoleAssignment("managedHardwareSecurityModuleRoleAssignmentResource",
    principal_id="string",
    role_definition_id="string",
    scope="string",
    managed_hsm_id="string",
    name="string")

    const managedHardwareSecurityModuleRoleAssignmentResource = new azure.keyvault.ManagedHardwareSecurityModuleRoleAssignment("managedHardwareSecurityModuleRoleAssignmentResource", {
    principalId: "string",
    roleDefinitionId: "string",
    scope: "string",
    managedHsmId: "string",
    name: "string",
});

    type: azure:keyvault:ManagedHardwareSecurityModuleRoleAssignment
properties:
    managedHsmId: string
    name: string
    principalId: string
    roleDefinitionId: string
    scope: string

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

    PrincipalId string
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    RoleDefinitionId string
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    Scope string
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    ManagedHsmId string
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    Name string
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    VaultBaseUrl string

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    PrincipalId string
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    RoleDefinitionId string
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    Scope string
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    ManagedHsmId string
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    Name string
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    VaultBaseUrl string

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    principalId String
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    roleDefinitionId String
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    scope String
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    managedHsmId String
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    name String
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    vaultBaseUrl String

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    principalId string
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    roleDefinitionId string
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    scope string
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    managedHsmId string
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    name string
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    vaultBaseUrl string

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    principal_id str
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    role_definition_id str
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    scope str
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    managed_hsm_id str
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    name str
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    vault_base_url str

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    principalId String
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    roleDefinitionId String
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    scope String
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    managedHsmId String
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    name String
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    vaultBaseUrl String

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceId string
    (Deprecated) The resource id of created assignment resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceId string
    (Deprecated) The resource id of created assignment resource.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceId String
    (Deprecated) The resource id of created assignment resource.
    id string
    The provider-assigned unique ID for this managed resource.
    resourceId string
    (Deprecated) The resource id of created assignment resource.
    id str
    The provider-assigned unique ID for this managed resource.
    resource_id str
    (Deprecated) The resource id of created assignment resource.
    id String
    The provider-assigned unique ID for this managed resource.
    resourceId String
    (Deprecated) The resource id of created assignment resource.

    Look up Existing ManagedHardwareSecurityModuleRoleAssignment Resource

    Get an existing ManagedHardwareSecurityModuleRoleAssignment 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?: ManagedHardwareSecurityModuleRoleAssignmentState, opts?: CustomResourceOptions): ManagedHardwareSecurityModuleRoleAssignment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        managed_hsm_id: Optional[str] = None,
        name: Optional[str] = None,
        principal_id: Optional[str] = None,
        resource_id: Optional[str] = None,
        role_definition_id: Optional[str] = None,
        scope: Optional[str] = None,
        vault_base_url: Optional[str] = None) -> ManagedHardwareSecurityModuleRoleAssignment
    func GetManagedHardwareSecurityModuleRoleAssignment(ctx *Context, name string, id IDInput, state *ManagedHardwareSecurityModuleRoleAssignmentState, opts ...ResourceOption) (*ManagedHardwareSecurityModuleRoleAssignment, error)
    public static ManagedHardwareSecurityModuleRoleAssignment Get(string name, Input<string> id, ManagedHardwareSecurityModuleRoleAssignmentState? state, CustomResourceOptions? opts = null)
    public static ManagedHardwareSecurityModuleRoleAssignment get(String name, Output<String> id, ManagedHardwareSecurityModuleRoleAssignmentState 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:
    ManagedHsmId string
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    Name string
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    PrincipalId string
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    ResourceId string
    (Deprecated) The resource id of created assignment resource.
    RoleDefinitionId string
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    Scope string
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    VaultBaseUrl string

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    ManagedHsmId string
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    Name string
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    PrincipalId string
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    ResourceId string
    (Deprecated) The resource id of created assignment resource.
    RoleDefinitionId string
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    Scope string
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    VaultBaseUrl string

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    managedHsmId String
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    name String
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    principalId String
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    resourceId String
    (Deprecated) The resource id of created assignment resource.
    roleDefinitionId String
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    scope String
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    vaultBaseUrl String

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    managedHsmId string
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    name string
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    principalId string
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    resourceId string
    (Deprecated) The resource id of created assignment resource.
    roleDefinitionId string
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    scope string
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    vaultBaseUrl string

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    managed_hsm_id str
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    name str
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    principal_id str
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    resource_id str
    (Deprecated) The resource id of created assignment resource.
    role_definition_id str
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    scope str
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    vault_base_url str

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    managedHsmId String
    The ID of a Managed Hardware Security Module resource. Changing this forces a new Managed Hardware Security Module to be created. *
    name String
    The name in GUID notation which should be used for this Managed Hardware Security Module Role Assignment. Changing this forces a new Managed Hardware Security Module to be created.
    principalId String
    The principal ID to be assigned to this role. It can point to a user, service principal, or security group. Changing this forces a new Managed Hardware Security Module to be created.
    resourceId String
    (Deprecated) The resource id of created assignment resource.
    roleDefinitionId String
    The resource ID of the role definition to assign. Changing this forces a new Managed Hardware Security Module to be created.
    scope String
    Specifies the scope to create the role assignment. Changing this forces a new Managed Hardware Security Module to be created.
    vaultBaseUrl String

    Deprecated: The field vault_base_url has been deprecated in favour of managed_hsm_id and will be removed in 4.0 of the Azure Provider

    Import

    Managed Hardware Security Modules can be imported using the resource id, e.g.

    $ pulumi import azure:keyvault/managedHardwareSecurityModuleRoleAssignment:ManagedHardwareSecurityModuleRoleAssignment example https://0000.managedhsm.azure.net///RoleAssignment/00000000-0000-0000-0000-000000000000

    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.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure