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 v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.hardwaresecuritymodules.getDedicatedHsm

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Gets the specified Azure dedicated HSM.

    Uses Azure REST API version 2024-06-30-preview.

    Other available API versions: 2021-11-30. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native hardwaresecuritymodules [ApiVersion]. See the version guide for details.

    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>
    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]
    func LookupDedicatedHsm(ctx *Context, args *LookupDedicatedHsmArgs, opts ...InvokeOption) (*LookupDedicatedHsmResult, error)
    func LookupDedicatedHsmOutput(ctx *Context, args *LookupDedicatedHsmOutputArgs, opts ...InvokeOption) LookupDedicatedHsmResultOutput

    > 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)
    }
    public static CompletableFuture<GetDedicatedHsmResult> getDedicatedHsm(GetDedicatedHsmArgs args, InvokeOptions options)
    public static Output<GetDedicatedHsmResult> getDedicatedHsm(GetDedicatedHsmArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:hardwaresecuritymodules:getDedicatedHsm
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the dedicated Hsm
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Name string
    Name of the dedicated Hsm
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    name String
    Name of the dedicated Hsm
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    name string
    Name of the dedicated Hsm
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    name str
    Name of the dedicated Hsm
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    name String
    Name of the dedicated Hsm
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getDedicatedHsm Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state.
    Sku Pulumi.AzureNative.HardwareSecurityModules.Outputs.SkuResponse
    SKU details
    StatusMessage string
    Resource Status Message.
    SystemData Pulumi.AzureNative.HardwareSecurityModules.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state.
    Sku SkuResponse
    SKU details
    StatusMessage string
    Resource Status Message.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state.
    sku SkuResponse
    SKU details
    statusMessage String
    Resource Status Message.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    Provisioning state.
    sku SkuResponse
    SKU details
    statusMessage string
    Resource Status Message.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    Provisioning state.
    sku SkuResponse
    SKU details
    status_message str
    Resource Status Message.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state.
    sku Property Map
    SKU details
    statusMessage String
    Resource Status Message.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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

    ResourceId string
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    ResourceId string
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    resourceId String
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    resourceId string
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    resource_id str
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    resourceId String
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

    NetworkInterfaceResponse

    ResourceId string
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    PrivateIpAddress string
    Private Ip address of the interface
    ResourceId string
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    PrivateIpAddress string
    Private Ip address of the interface
    resourceId String
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    privateIpAddress String
    Private Ip address of the interface
    resourceId string
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    privateIpAddress string
    Private Ip address of the interface
    resource_id str
    The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    private_ip_address str
    Private Ip address of the interface
    resourceId String
    The Azure 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 resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi