Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. hardwaresecuritymodules
  5. getCloudHsmCluster
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.hardwaresecuritymodules.getCloudHsmCluster

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-azure-native

    Gets the specified Cloud HSM Cluster Azure REST API version: 2022-08-31-preview.

    Using getCloudHsmCluster

    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 getCloudHsmCluster(args: GetCloudHsmClusterArgs, opts?: InvokeOptions): Promise<GetCloudHsmClusterResult>
function getCloudHsmClusterOutput(args: GetCloudHsmClusterOutputArgs, opts?: InvokeOptions): Output<GetCloudHsmClusterResult>
    def get_cloud_hsm_cluster(cloud_hsm_cluster_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCloudHsmClusterResult
def get_cloud_hsm_cluster_output(cloud_hsm_cluster_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCloudHsmClusterResult]
    func LookupCloudHsmCluster(ctx *Context, args *LookupCloudHsmClusterArgs, opts ...InvokeOption) (*LookupCloudHsmClusterResult, error)
func LookupCloudHsmClusterOutput(ctx *Context, args *LookupCloudHsmClusterOutputArgs, opts ...InvokeOption) LookupCloudHsmClusterResultOutput

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

    public static class GetCloudHsmCluster 
{
    public static Task<GetCloudHsmClusterResult> InvokeAsync(GetCloudHsmClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudHsmClusterResult> Invoke(GetCloudHsmClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudHsmClusterResult> getCloudHsmCluster(GetCloudHsmClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:hardwaresecuritymodules:getCloudHsmCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CloudHsmClusterName string

    The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 24 characters in length.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    CloudHsmClusterName string

    The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 24 characters in length.

    ResourceGroupName string

    The name of the resource group. The name is case insensitive.

    cloudHsmClusterName String

    The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 24 characters in length.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    cloudHsmClusterName string

    The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 24 characters in length.

    resourceGroupName string

    The name of the resource group. The name is case insensitive.

    cloud_hsm_cluster_name str

    The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 24 characters in length.

    resource_group_name str

    The name of the resource group. The name is case insensitive.

    cloudHsmClusterName String

    The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 24 characters in length.

    resourceGroupName String

    The name of the resource group. The name is case insensitive.

    getCloudHsmCluster Result

    The following output properties are available:

    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

    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"

    AutoGeneratedDomainNameLabelScope string

    The Cloud HSM Cluster's auto-generated Domain Name Label Scope

    Hsms List<Pulumi.AzureNative.HardwareSecurityModules.Outputs.CloudHsmPropertiesResponse>

    An array of Cloud HSM Cluster's HSMs

    PrivateEndpointConnections List<Pulumi.AzureNative.HardwareSecurityModules.Outputs.PrivateEndpointConnectionResponse>

    List of private endpoint connection resources

    ProvisioningState string

    The Cloud HSM Cluster's provisioningState

    PublicNetworkAccess string

    The Cloud HSM Cluster public network access

    SecurityDomain Pulumi.AzureNative.HardwareSecurityModules.Outputs.CloudHsmClusterSecurityDomainPropertiesResponse

    Security domain properties information for Cloud HSM cluster

    Sku Pulumi.AzureNative.HardwareSecurityModules.Outputs.CloudHsmClusterSkuResponse

    SKU details

    Tags Dictionary<string, string>

    Resource tags.

    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

    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"

    AutoGeneratedDomainNameLabelScope string

    The Cloud HSM Cluster's auto-generated Domain Name Label Scope

    Hsms []CloudHsmPropertiesResponse

    An array of Cloud HSM Cluster's HSMs

    PrivateEndpointConnections []PrivateEndpointConnectionResponse

    List of private endpoint connection resources

    ProvisioningState string

    The Cloud HSM Cluster's provisioningState

    PublicNetworkAccess string

    The Cloud HSM Cluster public network access

    SecurityDomain CloudHsmClusterSecurityDomainPropertiesResponse

    Security domain properties information for Cloud HSM cluster

    Sku CloudHsmClusterSkuResponse

    SKU details

    Tags map[string]string

    Resource tags.

    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

    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"

    autoGeneratedDomainNameLabelScope String

    The Cloud HSM Cluster's auto-generated Domain Name Label Scope

    hsms List<CloudHsmPropertiesResponse>

    An array of Cloud HSM Cluster's HSMs

    privateEndpointConnections List<PrivateEndpointConnectionResponse>

    List of private endpoint connection resources

    provisioningState String

    The Cloud HSM Cluster's provisioningState

    publicNetworkAccess String

    The Cloud HSM Cluster public network access

    securityDomain CloudHsmClusterSecurityDomainPropertiesResponse

    Security domain properties information for Cloud HSM cluster

    sku CloudHsmClusterSkuResponse

    SKU details

    tags Map<String,String>

    Resource tags.

    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

    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"

    autoGeneratedDomainNameLabelScope string

    The Cloud HSM Cluster's auto-generated Domain Name Label Scope

    hsms CloudHsmPropertiesResponse[]

    An array of Cloud HSM Cluster's HSMs

    privateEndpointConnections PrivateEndpointConnectionResponse[]

    List of private endpoint connection resources

    provisioningState string

    The Cloud HSM Cluster's provisioningState

    publicNetworkAccess string

    The Cloud HSM Cluster public network access

    securityDomain CloudHsmClusterSecurityDomainPropertiesResponse

    Security domain properties information for Cloud HSM cluster

    sku CloudHsmClusterSkuResponse

    SKU details

    tags {[key: string]: string}

    Resource tags.

    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

    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"

    auto_generated_domain_name_label_scope str

    The Cloud HSM Cluster's auto-generated Domain Name Label Scope

    hsms Sequence[CloudHsmPropertiesResponse]

    An array of Cloud HSM Cluster's HSMs

    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]

    List of private endpoint connection resources

    provisioning_state str

    The Cloud HSM Cluster's provisioningState

    public_network_access str

    The Cloud HSM Cluster public network access

    security_domain CloudHsmClusterSecurityDomainPropertiesResponse

    Security domain properties information for Cloud HSM cluster

    sku CloudHsmClusterSkuResponse

    SKU details

    tags Mapping[str, str]

    Resource tags.

    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

    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"

    autoGeneratedDomainNameLabelScope String

    The Cloud HSM Cluster's auto-generated Domain Name Label Scope

    hsms List<Property Map>

    An array of Cloud HSM Cluster's HSMs

    privateEndpointConnections List<Property Map>

    List of private endpoint connection resources

    provisioningState String

    The Cloud HSM Cluster's provisioningState

    publicNetworkAccess String

    The Cloud HSM Cluster public network access

    securityDomain Property Map

    Security domain properties information for Cloud HSM cluster

    sku Property Map

    SKU details

    tags Map<String>

    Resource tags.

    Supporting Types

    CloudHsmClusterSecurityDomainPropertiesResponse

    ActivationStatus string

    status of security domain activation

    FipsState int

    FIPS state information for security domain

    ActivationStatus string

    status of security domain activation

    FipsState int

    FIPS state information for security domain

    activationStatus String

    status of security domain activation

    fipsState Integer

    FIPS state information for security domain

    activationStatus string

    status of security domain activation

    fipsState number

    FIPS state information for security domain

    activation_status str

    status of security domain activation

    fips_state int

    FIPS state information for security domain

    activationStatus String

    status of security domain activation

    fipsState Number

    FIPS state information for security domain

    CloudHsmClusterSkuResponse

    Family string

    Sku family of the Cloud HSM Cluster

    Name string

    Sku name of the Cloud HSM Cluster

    Capacity int

    Sku capacity

    Family string

    Sku family of the Cloud HSM Cluster

    Name string

    Sku name of the Cloud HSM Cluster

    Capacity int

    Sku capacity

    family String

    Sku family of the Cloud HSM Cluster

    name String

    Sku name of the Cloud HSM Cluster

    capacity Integer

    Sku capacity

    family string

    Sku family of the Cloud HSM Cluster

    name string

    Sku name of the Cloud HSM Cluster

    capacity number

    Sku capacity

    family str

    Sku family of the Cloud HSM Cluster

    name str

    Sku name of the Cloud HSM Cluster

    capacity int

    Sku capacity

    family String

    Sku family of the Cloud HSM Cluster

    name String

    Sku name of the Cloud HSM Cluster

    capacity Number

    Sku capacity

    CloudHsmPropertiesResponse

    Fqdn string

    FQDN of the Cloud HSM

    State string

    The Cloud HSM State

    StateMessage string

    The Cloud HSM State message

    Fqdn string

    FQDN of the Cloud HSM

    State string

    The Cloud HSM State

    StateMessage string

    The Cloud HSM State message

    fqdn String

    FQDN of the Cloud HSM

    state String

    The Cloud HSM State

    stateMessage String

    The Cloud HSM State message

    fqdn string

    FQDN of the Cloud HSM

    state string

    The Cloud HSM State

    stateMessage string

    The Cloud HSM State message

    fqdn str

    FQDN of the Cloud HSM

    state str

    The Cloud HSM State

    state_message str

    The Cloud HSM State message

    fqdn String

    FQDN of the Cloud HSM

    state String

    The Cloud HSM State

    stateMessage String

    The Cloud HSM State message

    PrivateEndpointConnectionResponse

    GroupIds List<string>

    The group ids for the private endpoint resource.

    Id string

    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

    Name string

    The name of the resource

    PrivateLinkServiceConnectionState Pulumi.AzureNative.HardwareSecurityModules.Inputs.PrivateLinkServiceConnectionStateResponse

    A collection of information about the state of the connection between service consumer and provider.

    ProvisioningState string

    The provisioning state of the private endpoint connection resource.

    SystemData Pulumi.AzureNative.HardwareSecurityModules.Inputs.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"

    Etag string

    Modified whenever there is a change in the state of private endpoint connection.

    PrivateEndpoint Pulumi.AzureNative.HardwareSecurityModules.Inputs.PrivateEndpointResponse

    The private endpoint resource.

    GroupIds []string

    The group ids for the private endpoint resource.

    Id string

    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

    Name string

    The name of the resource

    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

    A collection of information about the state of the connection between service consumer and provider.

    ProvisioningState string

    The provisioning state of the private endpoint connection resource.

    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"

    Etag string

    Modified whenever there is a change in the state of private endpoint connection.

    PrivateEndpoint PrivateEndpointResponse

    The private endpoint resource.

    groupIds List<String>

    The group ids for the private endpoint resource.

    id String

    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

    name String

    The name of the resource

    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

    A collection of information about the state of the connection between service consumer and provider.

    provisioningState String

    The provisioning state of the private endpoint connection resource.

    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"

    etag String

    Modified whenever there is a change in the state of private endpoint connection.

    privateEndpoint PrivateEndpointResponse

    The private endpoint resource.

    groupIds string[]

    The group ids for the private endpoint resource.

    id string

    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

    name string

    The name of the resource

    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

    A collection of information about the state of the connection between service consumer and provider.

    provisioningState string

    The provisioning state of the private endpoint connection resource.

    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"

    etag string

    Modified whenever there is a change in the state of private endpoint connection.

    privateEndpoint PrivateEndpointResponse

    The private endpoint resource.

    group_ids Sequence[str]

    The group ids for the private endpoint resource.

    id str

    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

    name str

    The name of the resource

    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse

    A collection of information about the state of the connection between service consumer and provider.

    provisioning_state str

    The provisioning state of the private endpoint connection resource.

    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"

    etag str

    Modified whenever there is a change in the state of private endpoint connection.

    private_endpoint PrivateEndpointResponse

    The private endpoint resource.

    groupIds List<String>

    The group ids for the private endpoint resource.

    id String

    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

    name String

    The name of the resource

    privateLinkServiceConnectionState Property Map

    A collection of information about the state of the connection between service consumer and provider.

    provisioningState String

    The provisioning state of the private endpoint connection resource.

    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"

    etag String

    Modified whenever there is a change in the state of private endpoint connection.

    privateEndpoint Property Map

    The private endpoint resource.

    PrivateEndpointResponse

    Id string

    The ARM identifier for private endpoint.

    Id string

    The ARM identifier for private endpoint.

    id String

    The ARM identifier for private endpoint.

    id string

    The ARM identifier for private endpoint.

    id str

    The ARM identifier for private endpoint.

    id String

    The ARM identifier for private endpoint.

    PrivateLinkServiceConnectionStateResponse

    ActionsRequired string

    A message indicating if changes on the service provider require any updates on the consumer.

    Description string

    The reason for approval/rejection of the connection.

    Status string

    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    ActionsRequired string

    A message indicating if changes on the service provider require any updates on the consumer.

    Description string

    The reason for approval/rejection of the connection.

    Status string

    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    actionsRequired String

    A message indicating if changes on the service provider require any updates on the consumer.

    description String

    The reason for approval/rejection of the connection.

    status String

    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    actionsRequired string

    A message indicating if changes on the service provider require any updates on the consumer.

    description string

    The reason for approval/rejection of the connection.

    status string

    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    actions_required str

    A message indicating if changes on the service provider require any updates on the consumer.

    description str

    The reason for approval/rejection of the connection.

    status str

    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    actionsRequired String

    A message indicating if changes on the service provider require any updates on the consumer.

    description String

    The reason for approval/rejection of the connection.

    status String

    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.8.0 published on Monday, Sep 18, 2023 by Pulumi
    pulumi/pulumi-azure-native