Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. hardwaresecuritymodules
  5. getDedicatedHsm
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.hardwaresecuritymodules.getDedicatedHsm

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified Azure dedicated HSM.

Uses Azure REST API version 2021-11-30.

Other available API versions: 2024-06-30-preview.

Using getDedicatedHsm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDedicatedHsm(args: GetDedicatedHsmArgs, opts?: InvokeOptions): Promise<GetDedicatedHsmResult>
function getDedicatedHsmOutput(args: GetDedicatedHsmOutputArgs, opts?: InvokeOptions): Output<GetDedicatedHsmResult>
Copy
def get_dedicated_hsm(name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDedicatedHsmResult
def get_dedicated_hsm_output(name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDedicatedHsmResult]
Copy
func LookupDedicatedHsm(ctx *Context, args *LookupDedicatedHsmArgs, opts ...InvokeOption) (*LookupDedicatedHsmResult, error)
func LookupDedicatedHsmOutput(ctx *Context, args *LookupDedicatedHsmOutputArgs, opts ...InvokeOption) LookupDedicatedHsmResultOutput
Copy

> Note: This function is named LookupDedicatedHsm in the Go SDK.

public static class GetDedicatedHsm 
{
    public static Task<GetDedicatedHsmResult> InvokeAsync(GetDedicatedHsmArgs args, InvokeOptions? opts = null)
    public static Output<GetDedicatedHsmResult> Invoke(GetDedicatedHsmInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDedicatedHsmResult> getDedicatedHsm(GetDedicatedHsmArgs args, InvokeOptions options)
public static Output<GetDedicatedHsmResult> getDedicatedHsm(GetDedicatedHsmArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:hardwaresecuritymodules:getDedicatedHsm
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the dedicated HSM.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group to which the dedicated hsm belongs.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the dedicated HSM.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group to which the dedicated hsm belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the dedicated HSM.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group to which the dedicated hsm belongs.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the dedicated HSM.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group to which the dedicated hsm belongs.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the dedicated HSM.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group to which the dedicated hsm belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the dedicated HSM.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group to which the dedicated hsm belongs.

getDedicatedHsm Result

The following output properties are available:

Id string
The Azure Resource Manager resource ID for the dedicated HSM.
Location string
The supported Azure location where the dedicated HSM should be created.
Name string
The name of the dedicated HSM.
ProvisioningState string
Provisioning state.
Sku Pulumi.AzureNative.HardwareSecurityModules.Outputs.SkuResponse
SKU details
StatusMessage string
Resource Status Message.
SystemData Pulumi.AzureNative.HardwareSecurityModules.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource
Type string
The resource type of the dedicated HSM.
ManagementNetworkProfile Pulumi.AzureNative.HardwareSecurityModules.Outputs.NetworkProfileResponse
Specifies the management network interfaces of the dedicated hsm.
NetworkProfile Pulumi.AzureNative.HardwareSecurityModules.Outputs.NetworkProfileResponse
Specifies the network interfaces of the dedicated hsm.
StampId string
This field will be used when RP does not support Availability zones.
Tags Dictionary<string, string>
Resource tags
Zones List<string>
The Dedicated Hsm zones.
Id string
The Azure Resource Manager resource ID for the dedicated HSM.
Location string
The supported Azure location where the dedicated HSM should be created.
Name string
The name of the dedicated HSM.
ProvisioningState string
Provisioning state.
Sku SkuResponse
SKU details
StatusMessage string
Resource Status Message.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource
Type string
The resource type of the dedicated HSM.
ManagementNetworkProfile NetworkProfileResponse
Specifies the management network interfaces of the dedicated hsm.
NetworkProfile NetworkProfileResponse
Specifies the network interfaces of the dedicated hsm.
StampId string
This field will be used when RP does not support Availability zones.
Tags map[string]string
Resource tags
Zones []string
The Dedicated Hsm zones.
id String
The Azure Resource Manager resource ID for the dedicated HSM.
location String
The supported Azure location where the dedicated HSM should be created.
name String
The name of the dedicated HSM.
provisioningState String
Provisioning state.
sku SkuResponse
SKU details
statusMessage String
Resource Status Message.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource
type String
The resource type of the dedicated HSM.
managementNetworkProfile NetworkProfileResponse
Specifies the management network interfaces of the dedicated hsm.
networkProfile NetworkProfileResponse
Specifies the network interfaces of the dedicated hsm.
stampId String
This field will be used when RP does not support Availability zones.
tags Map<String,String>
Resource tags
zones List<String>
The Dedicated Hsm zones.
id string
The Azure Resource Manager resource ID for the dedicated HSM.
location string
The supported Azure location where the dedicated HSM should be created.
name string
The name of the dedicated HSM.
provisioningState string
Provisioning state.
sku SkuResponse
SKU details
statusMessage string
Resource Status Message.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource
type string
The resource type of the dedicated HSM.
managementNetworkProfile NetworkProfileResponse
Specifies the management network interfaces of the dedicated hsm.
networkProfile NetworkProfileResponse
Specifies the network interfaces of the dedicated hsm.
stampId string
This field will be used when RP does not support Availability zones.
tags {[key: string]: string}
Resource tags
zones string[]
The Dedicated Hsm zones.
id str
The Azure Resource Manager resource ID for the dedicated HSM.
location str
The supported Azure location where the dedicated HSM should be created.
name str
The name of the dedicated HSM.
provisioning_state str
Provisioning state.
sku SkuResponse
SKU details
status_message str
Resource Status Message.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource
type str
The resource type of the dedicated HSM.
management_network_profile NetworkProfileResponse
Specifies the management network interfaces of the dedicated hsm.
network_profile NetworkProfileResponse
Specifies the network interfaces of the dedicated hsm.
stamp_id str
This field will be used when RP does not support Availability zones.
tags Mapping[str, str]
Resource tags
zones Sequence[str]
The Dedicated Hsm zones.
id String
The Azure Resource Manager resource ID for the dedicated HSM.
location String
The supported Azure location where the dedicated HSM should be created.
name String
The name of the dedicated HSM.
provisioningState String
Provisioning state.
sku Property Map
SKU details
statusMessage String
Resource Status Message.
systemData Property Map
Metadata pertaining to creation and last modification of the resource
type String
The resource type of the dedicated HSM.
managementNetworkProfile Property Map
Specifies the management network interfaces of the dedicated hsm.
networkProfile Property Map
Specifies the network interfaces of the dedicated hsm.
stampId String
This field will be used when RP does not support Availability zones.
tags Map<String>
Resource tags
zones List<String>
The Dedicated Hsm zones.

Supporting Types

ApiEntityReferenceResponse

Id string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
Id string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id String
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id str
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
id String
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

NetworkInterfaceResponse

Id This property is required. string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
PrivateIpAddress string
Private Ip address of the interface
Id This property is required. string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
PrivateIpAddress string
Private Ip address of the interface
id This property is required. String
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
privateIpAddress String
Private Ip address of the interface
id This property is required. string
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
privateIpAddress string
Private Ip address of the interface
id This property is required. str
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
private_ip_address str
Private Ip address of the interface
id This property is required. String
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
privateIpAddress String
Private Ip address of the interface

NetworkProfileResponse

NetworkInterfaces List<Pulumi.AzureNative.HardwareSecurityModules.Inputs.NetworkInterfaceResponse>
Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
Subnet Pulumi.AzureNative.HardwareSecurityModules.Inputs.ApiEntityReferenceResponse
Specifies the identifier of the subnet.
NetworkInterfaces []NetworkInterfaceResponse
Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
Subnet ApiEntityReferenceResponse
Specifies the identifier of the subnet.
networkInterfaces List<NetworkInterfaceResponse>
Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
subnet ApiEntityReferenceResponse
Specifies the identifier of the subnet.
networkInterfaces NetworkInterfaceResponse[]
Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
subnet ApiEntityReferenceResponse
Specifies the identifier of the subnet.
network_interfaces Sequence[NetworkInterfaceResponse]
Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
subnet ApiEntityReferenceResponse
Specifies the identifier of the subnet.
networkInterfaces List<Property Map>
Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM.
subnet Property Map
Specifies the identifier of the subnet.

SkuResponse

Name string
SKU of the dedicated HSM
Name string
SKU of the dedicated HSM
name String
SKU of the dedicated HSM
name string
SKU of the dedicated HSM
name str
SKU of the dedicated HSM
name String
SKU of the dedicated HSM

SystemDataResponse

CreatedAt string
The timestamp of dedicated hsm resource creation (UTC).
CreatedBy string
The identity that created dedicated hsm resource.
CreatedByType string
The type of identity that created dedicated hsm resource.
LastModifiedAt string
The timestamp of dedicated hsm resource last modification (UTC).
LastModifiedBy string
The identity that last modified dedicated hsm resource.
LastModifiedByType string
The type of identity that last modified dedicated hsm resource.
CreatedAt string
The timestamp of dedicated hsm resource creation (UTC).
CreatedBy string
The identity that created dedicated hsm resource.
CreatedByType string
The type of identity that created dedicated hsm resource.
LastModifiedAt string
The timestamp of dedicated hsm resource last modification (UTC).
LastModifiedBy string
The identity that last modified dedicated hsm resource.
LastModifiedByType string
The type of identity that last modified dedicated hsm resource.
createdAt String
The timestamp of dedicated hsm resource creation (UTC).
createdBy String
The identity that created dedicated hsm resource.
createdByType String
The type of identity that created dedicated hsm resource.
lastModifiedAt String
The timestamp of dedicated hsm resource last modification (UTC).
lastModifiedBy String
The identity that last modified dedicated hsm resource.
lastModifiedByType String
The type of identity that last modified dedicated hsm resource.
createdAt string
The timestamp of dedicated hsm resource creation (UTC).
createdBy string
The identity that created dedicated hsm resource.
createdByType string
The type of identity that created dedicated hsm resource.
lastModifiedAt string
The timestamp of dedicated hsm resource last modification (UTC).
lastModifiedBy string
The identity that last modified dedicated hsm resource.
lastModifiedByType string
The type of identity that last modified dedicated hsm resource.
created_at str
The timestamp of dedicated hsm resource creation (UTC).
created_by str
The identity that created dedicated hsm resource.
created_by_type str
The type of identity that created dedicated hsm resource.
last_modified_at str
The timestamp of dedicated hsm resource last modification (UTC).
last_modified_by str
The identity that last modified dedicated hsm resource.
last_modified_by_type str
The type of identity that last modified dedicated hsm resource.
createdAt String
The timestamp of dedicated hsm resource creation (UTC).
createdBy String
The identity that created dedicated hsm resource.
createdByType String
The type of identity that created dedicated hsm resource.
lastModifiedAt String
The timestamp of dedicated hsm resource last modification (UTC).
lastModifiedBy String
The identity that last modified dedicated hsm resource.
lastModifiedByType String
The type of identity that last modified dedicated hsm resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native