azure-native.hardwaresecuritymodules.getCloudHsmCluster
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:
- Cloud
Hsm stringCluster Name 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 stringName The name of the resource group. The name is case insensitive.
- Cloud
Hsm stringCluster Name 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 stringName The name of the resource group. The name is case insensitive.
- cloud
Hsm StringCluster Name 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 StringName The name of the resource group. The name is case insensitive.
- cloud
Hsm stringCluster Name 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 stringName The name of the resource group. The name is case insensitive.
- cloud_
hsm_ strcluster_ name 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_ strname The name of the resource group. The name is case insensitive.
- cloud
Hsm StringCluster Name 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 StringName 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
- System
Data Pulumi.Azure Native. Hardware Security Modules. Outputs. System Data Response 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"
- Auto
Generated stringDomain Name Label Scope The Cloud HSM Cluster's auto-generated Domain Name Label Scope
- Hsms
List<Pulumi.
Azure Native. Hardware Security Modules. Outputs. Cloud Hsm Properties Response> An array of Cloud HSM Cluster's HSMs
- Private
Endpoint List<Pulumi.Connections Azure Native. Hardware Security Modules. Outputs. Private Endpoint Connection Response> List of private endpoint connection resources
- Provisioning
State string The Cloud HSM Cluster's provisioningState
- Public
Network stringAccess The Cloud HSM Cluster public network access
- Security
Domain Pulumi.Azure Native. Hardware Security Modules. Outputs. Cloud Hsm Cluster Security Domain Properties Response Security domain properties information for Cloud HSM cluster
- Sku
Pulumi.
Azure Native. Hardware Security Modules. Outputs. Cloud Hsm Cluster Sku Response SKU details
- 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
- System
Data SystemData Response 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"
- Auto
Generated stringDomain Name Label Scope The Cloud HSM Cluster's auto-generated Domain Name Label Scope
- Hsms
[]Cloud
Hsm Properties Response An array of Cloud HSM Cluster's HSMs
- Private
Endpoint []PrivateConnections Endpoint Connection Response List of private endpoint connection resources
- Provisioning
State string The Cloud HSM Cluster's provisioningState
- Public
Network stringAccess The Cloud HSM Cluster public network access
- Security
Domain CloudHsm Cluster Security Domain Properties Response Security domain properties information for Cloud HSM cluster
- Sku
Cloud
Hsm Cluster Sku Response SKU details
- 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
- system
Data SystemData Response 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"
- auto
Generated StringDomain Name Label Scope The Cloud HSM Cluster's auto-generated Domain Name Label Scope
- hsms
List<Cloud
Hsm Properties Response> An array of Cloud HSM Cluster's HSMs
- private
Endpoint List<PrivateConnections Endpoint Connection Response> List of private endpoint connection resources
- provisioning
State String The Cloud HSM Cluster's provisioningState
- public
Network StringAccess The Cloud HSM Cluster public network access
- security
Domain CloudHsm Cluster Security Domain Properties Response Security domain properties information for Cloud HSM cluster
- sku
Cloud
Hsm Cluster Sku Response SKU details
- 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
- system
Data SystemData Response 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"
- auto
Generated stringDomain Name Label Scope The Cloud HSM Cluster's auto-generated Domain Name Label Scope
- hsms
Cloud
Hsm Properties Response[] An array of Cloud HSM Cluster's HSMs
- private
Endpoint PrivateConnections Endpoint Connection Response[] List of private endpoint connection resources
- provisioning
State string The Cloud HSM Cluster's provisioningState
- public
Network stringAccess The Cloud HSM Cluster public network access
- security
Domain CloudHsm Cluster Security Domain Properties Response Security domain properties information for Cloud HSM cluster
- sku
Cloud
Hsm Cluster Sku Response SKU details
- {[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 SystemData Response 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_ strdomain_ name_ label_ scope The Cloud HSM Cluster's auto-generated Domain Name Label Scope
- hsms
Sequence[Cloud
Hsm Properties Response] An array of Cloud HSM Cluster's HSMs
- private_
endpoint_ Sequence[Privateconnections Endpoint Connection Response] List of private endpoint connection resources
- provisioning_
state str The Cloud HSM Cluster's provisioningState
- public_
network_ straccess The Cloud HSM Cluster public network access
- security_
domain CloudHsm Cluster Security Domain Properties Response Security domain properties information for Cloud HSM cluster
- sku
Cloud
Hsm Cluster Sku Response SKU details
- 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
- system
Data 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"
- auto
Generated StringDomain Name Label Scope The Cloud HSM Cluster's auto-generated Domain Name Label Scope
- hsms List<Property Map>
An array of Cloud HSM Cluster's HSMs
- private
Endpoint List<Property Map>Connections List of private endpoint connection resources
- provisioning
State String The Cloud HSM Cluster's provisioningState
- public
Network StringAccess The Cloud HSM Cluster public network access
- security
Domain Property Map Security domain properties information for Cloud HSM cluster
- sku Property Map
SKU details
- Map<String>
Resource tags.
Supporting Types
CloudHsmClusterSecurityDomainPropertiesResponse
- Activation
Status string status of security domain activation
- Fips
State int FIPS state information for security domain
- Activation
Status string status of security domain activation
- Fips
State int FIPS state information for security domain
- activation
Status String status of security domain activation
- fips
State Integer FIPS state information for security domain
- activation
Status string status of security domain activation
- fips
State number FIPS state information for security domain
- activation_
status str status of security domain activation
- fips_
state int FIPS state information for security domain
- activation
Status String status of security domain activation
- fips
State Number FIPS state information for security domain
CloudHsmClusterSkuResponse
CloudHsmPropertiesResponse
- Fqdn string
FQDN of the Cloud HSM
- State string
The Cloud HSM State
- State
Message string The Cloud HSM State message
- Fqdn string
FQDN of the Cloud HSM
- State string
The Cloud HSM State
- State
Message string The Cloud HSM State message
- fqdn String
FQDN of the Cloud HSM
- state String
The Cloud HSM State
- state
Message String The Cloud HSM State message
- fqdn string
FQDN of the Cloud HSM
- state string
The Cloud HSM State
- state
Message 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
- state
Message String The Cloud HSM State message
PrivateEndpointConnectionResponse
- Group
Ids 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
- Private
Link Pulumi.Service Connection State Azure Native. Hardware Security Modules. Inputs. Private Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string The provisioning state of the private endpoint connection resource.
- System
Data Pulumi.Azure Native. Hardware Security Modules. Inputs. System Data Response 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.
- Private
Endpoint Pulumi.Azure Native. Hardware Security Modules. Inputs. Private Endpoint Response The private endpoint resource.
- Group
Ids []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
- Private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string The provisioning state of the private endpoint connection resource.
- System
Data SystemData Response 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.
- Private
Endpoint PrivateEndpoint Response The private endpoint resource.
- group
Ids 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
- private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String The provisioning state of the private endpoint connection resource.
- system
Data SystemData Response 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.
- private
Endpoint PrivateEndpoint Response The private endpoint resource.
- group
Ids 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
- private
Link PrivateService Connection State Link Service Connection State Response A collection of information about the state of the connection between service consumer and provider.
- provisioning
State string The provisioning state of the private endpoint connection resource.
- system
Data SystemData Response 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.
- private
Endpoint PrivateEndpoint Response 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_ Privateservice_ connection_ state Link Service Connection State Response 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 SystemData Response 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 PrivateEndpoint Response The private endpoint resource.
- group
Ids 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
- private
Link Property MapService Connection State A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String The provisioning state of the private endpoint connection resource.
- system
Data 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.
- private
Endpoint 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
- Actions
Required 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 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 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 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.
- actions
Required 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
- Created
At string The timestamp of dedicated hsm resource creation (UTC).
- Created
By string The identity that created dedicated hsm resource.
- Created
By stringType The type of identity that created dedicated hsm resource.
- Last
Modified stringAt The timestamp of dedicated hsm resource last modification (UTC).
- Last
Modified stringBy The identity that last modified dedicated hsm resource.
- Last
Modified stringBy Type The type of identity that last modified dedicated hsm resource.
- Created
At string The timestamp of dedicated hsm resource creation (UTC).
- Created
By string The identity that created dedicated hsm resource.
- Created
By stringType The type of identity that created dedicated hsm resource.
- Last
Modified stringAt The timestamp of dedicated hsm resource last modification (UTC).
- Last
Modified stringBy The identity that last modified dedicated hsm resource.
- Last
Modified stringBy Type The type of identity that last modified dedicated hsm resource.
- created
At String The timestamp of dedicated hsm resource creation (UTC).
- created
By String The identity that created dedicated hsm resource.
- created
By StringType The type of identity that created dedicated hsm resource.
- last
Modified StringAt The timestamp of dedicated hsm resource last modification (UTC).
- last
Modified StringBy The identity that last modified dedicated hsm resource.
- last
Modified StringBy Type The type of identity that last modified dedicated hsm resource.
- created
At string The timestamp of dedicated hsm resource creation (UTC).
- created
By string The identity that created dedicated hsm resource.
- created
By stringType The type of identity that created dedicated hsm resource.
- last
Modified stringAt The timestamp of dedicated hsm resource last modification (UTC).
- last
Modified stringBy The identity that last modified dedicated hsm resource.
- last
Modified stringBy Type 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_ strtype The type of identity that created dedicated hsm resource.
- last_
modified_ strat The timestamp of dedicated hsm resource last modification (UTC).
- last_
modified_ strby The identity that last modified dedicated hsm resource.
- last_
modified_ strby_ type The type of identity that last modified dedicated hsm resource.
- created
At String The timestamp of dedicated hsm resource creation (UTC).
- created
By String The identity that created dedicated hsm resource.
- created
By StringType The type of identity that created dedicated hsm resource.
- last
Modified StringAt The timestamp of dedicated hsm resource last modification (UTC).
- last
Modified StringBy The identity that last modified dedicated hsm resource.
- last
Modified StringBy Type The type of identity that last modified dedicated hsm resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0