1. Packages
  2. Azure Native
  3. API Docs
  4. hardwaresecuritymodules
  5. getCloudHsmCluster
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.hardwaresecuritymodules.getCloudHsmCluster

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets the specified Cloud HSM Cluster

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

Other available API versions: 2022-08-31-preview, 2023-12-10-preview. 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 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>
Copy
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]
Copy
func LookupCloudHsmCluster(ctx *Context, args *LookupCloudHsmClusterArgs, opts ...InvokeOption) (*LookupCloudHsmClusterResult, error)
func LookupCloudHsmClusterOutput(ctx *Context, args *LookupCloudHsmClusterOutputArgs, opts ...InvokeOption) LookupCloudHsmClusterResultOutput
Copy

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

The following arguments are supported:

CloudHsmClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CloudHsmClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
cloudHsmClusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
cloudHsmClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
cloud_hsm_cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
cloudHsmClusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getCloudHsmCluster Result

The following output properties are available:

ActivationState string
State of security domain activation
AzureApiVersion string
The Azure API version of the resource.
Hsms List<Pulumi.AzureNative.HardwareSecurityModules.Outputs.CloudHsmPropertiesResponse>
An array of Cloud HSM Cluster's HSMs
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
PrivateEndpointConnections List<Pulumi.AzureNative.HardwareSecurityModules.Outputs.PrivateEndpointConnectionResponse>
List of private endpoint connection resources
ProvisioningState string
The Cloud HSM Cluster's provisioningState
StatusMessage string
Cloud HSM Cluster 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"
AutoGeneratedDomainNameLabelScope string
The Cloud HSM Cluster's auto-generated Domain Name Label Scope
Identity Pulumi.AzureNative.HardwareSecurityModules.Outputs.ManagedServiceIdentityResponse
Managed service identity (system assigned and/or user assigned identities)
PublicNetworkAccess string
The Cloud HSM Cluster public network access
Sku Pulumi.AzureNative.HardwareSecurityModules.Outputs.CloudHsmClusterSkuResponse
SKU details
Tags Dictionary<string, string>
Resource tags.
ActivationState string
State of security domain activation
AzureApiVersion string
The Azure API version of the resource.
Hsms []CloudHsmPropertiesResponse
An array of Cloud HSM Cluster's HSMs
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
PrivateEndpointConnections []PrivateEndpointConnectionResponse
List of private endpoint connection resources
ProvisioningState string
The Cloud HSM Cluster's provisioningState
StatusMessage string
Cloud HSM Cluster 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"
AutoGeneratedDomainNameLabelScope string
The Cloud HSM Cluster's auto-generated Domain Name Label Scope
Identity ManagedServiceIdentityResponse
Managed service identity (system assigned and/or user assigned identities)
PublicNetworkAccess string
The Cloud HSM Cluster public network access
Sku CloudHsmClusterSkuResponse
SKU details
Tags map[string]string
Resource tags.
activationState String
State of security domain activation
azureApiVersion String
The Azure API version of the resource.
hsms List<CloudHsmPropertiesResponse>
An array of Cloud HSM Cluster's HSMs
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
privateEndpointConnections List<PrivateEndpointConnectionResponse>
List of private endpoint connection resources
provisioningState String
The Cloud HSM Cluster's provisioningState
statusMessage String
Cloud HSM Cluster 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"
autoGeneratedDomainNameLabelScope String
The Cloud HSM Cluster's auto-generated Domain Name Label Scope
identity ManagedServiceIdentityResponse
Managed service identity (system assigned and/or user assigned identities)
publicNetworkAccess String
The Cloud HSM Cluster public network access
sku CloudHsmClusterSkuResponse
SKU details
tags Map<String,String>
Resource tags.
activationState string
State of security domain activation
azureApiVersion string
The Azure API version of the resource.
hsms CloudHsmPropertiesResponse[]
An array of Cloud HSM Cluster's HSMs
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
privateEndpointConnections PrivateEndpointConnectionResponse[]
List of private endpoint connection resources
provisioningState string
The Cloud HSM Cluster's provisioningState
statusMessage string
Cloud HSM Cluster 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"
autoGeneratedDomainNameLabelScope string
The Cloud HSM Cluster's auto-generated Domain Name Label Scope
identity ManagedServiceIdentityResponse
Managed service identity (system assigned and/or user assigned identities)
publicNetworkAccess string
The Cloud HSM Cluster public network access
sku CloudHsmClusterSkuResponse
SKU details
tags {[key: string]: string}
Resource tags.
activation_state str
State of security domain activation
azure_api_version str
The Azure API version of the resource.
hsms Sequence[CloudHsmPropertiesResponse]
An array of Cloud HSM Cluster's HSMs
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
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
List of private endpoint connection resources
provisioning_state str
The Cloud HSM Cluster's provisioningState
status_message str
Cloud HSM Cluster 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"
auto_generated_domain_name_label_scope str
The Cloud HSM Cluster's auto-generated Domain Name Label Scope
identity ManagedServiceIdentityResponse
Managed service identity (system assigned and/or user assigned identities)
public_network_access str
The Cloud HSM Cluster public network access
sku CloudHsmClusterSkuResponse
SKU details
tags Mapping[str, str]
Resource tags.
activationState String
State of security domain activation
azureApiVersion String
The Azure API version of the resource.
hsms List<Property Map>
An array of Cloud HSM Cluster's HSMs
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
privateEndpointConnections List<Property Map>
List of private endpoint connection resources
provisioningState String
The Cloud HSM Cluster's provisioningState
statusMessage String
Cloud HSM Cluster 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"
autoGeneratedDomainNameLabelScope String
The Cloud HSM Cluster's auto-generated Domain Name Label Scope
identity Property Map
Managed service identity (system assigned and/or user assigned identities)
publicNetworkAccess String
The Cloud HSM Cluster public network access
sku Property Map
SKU details
tags Map<String>
Resource tags.

Supporting Types

CloudHsmClusterSkuResponse

Family This property is required. string
Sku family of the Cloud HSM Cluster
Name This property is required. string
Sku name of the Cloud HSM Cluster
Capacity int
Sku capacity
Family This property is required. string
Sku family of the Cloud HSM Cluster
Name This property is required. string
Sku name of the Cloud HSM Cluster
Capacity int
Sku capacity
family This property is required. String
Sku family of the Cloud HSM Cluster
name This property is required. String
Sku name of the Cloud HSM Cluster
capacity Integer
Sku capacity
family This property is required. string
Sku family of the Cloud HSM Cluster
name This property is required. string
Sku name of the Cloud HSM Cluster
capacity number
Sku capacity
family This property is required. str
Sku family of the Cloud HSM Cluster
name This property is required. str
Sku name of the Cloud HSM Cluster
capacity int
Sku capacity
family This property is required. String
Sku family of the Cloud HSM Cluster
name This property is required. 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. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating
StateMessage string
The Cloud HSM State message
Fqdn string
FQDN of the Cloud HSM
State string
The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating
StateMessage string
The Cloud HSM State message
fqdn String
FQDN of the Cloud HSM
state String
The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating
stateMessage String
The Cloud HSM State message
fqdn string
FQDN of the Cloud HSM
state string
The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating
stateMessage string
The Cloud HSM State message
fqdn str
FQDN of the Cloud HSM
state str
The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating
state_message str
The Cloud HSM State message
fqdn String
FQDN of the Cloud HSM
state String
The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating
stateMessage String
The Cloud HSM State message

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.HardwareSecurityModules.Inputs.UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principal_id This property is required. str
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. str
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrivateEndpointConnectionResponse

GroupIds This property is required. List<string>
The group ids for the private endpoint resource.
Id This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.HardwareSecurityModules.Inputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
SystemData This property is required. Pulumi.AzureNative.HardwareSecurityModules.Inputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. 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 This property is required. []string
The group ids for the private endpoint resource.
Id This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
SystemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. 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 This property is required. List<String>
The group ids for the private endpoint resource.
id This property is required. String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. 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 This property is required. string[]
The group ids for the private endpoint resource.
id This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. string
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. 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 This property is required. Sequence[str]
The group ids for the private endpoint resource.
id This property is required. str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. str
The name of the resource
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioning_state This property is required. str
The provisioning state of the private endpoint connection resource.
system_data This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. 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 This property is required. List<String>
The group ids for the private endpoint resource.
id This property is required. String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
systemData This property is required. Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. 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 This property is required. string
The ARM identifier for private endpoint.
Id This property is required. string
The ARM identifier for private endpoint.
id This property is required. String
The ARM identifier for private endpoint.
id This property is required. string
The ARM identifier for private endpoint.
id This property is required. str
The ARM identifier for private endpoint.
id This property is required. 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 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.

UserAssignedIdentityResponse

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

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