Share via

CloudHsmCluster interface

Package:
@azure/arm-hardwaresecuritymodules

Resource information with extended details.

Extends
CloudHsmClusterResource

Properties

activationState

State of security domain activation NOTE: This property will not be serialized. It can only be populated by the server.
autoGeneratedDomainNameLabelScope

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

An array of Cloud HSM Cluster's HSMs NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections

List of private endpoint connection resources NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The Cloud HSM Cluster's provisioningState NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

The Cloud HSM Cluster public network access
statusMessage

Cloud HSM Cluster status message NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
identity

Managed service identity (system assigned and/or user assigned identities)
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
sku

SKU details
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

activationState

State of security domain activation NOTE: This property will not be serialized. It can only be populated by the server.

activationState?: string

Property Value

string

autoGeneratedDomainNameLabelScope

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

autoGeneratedDomainNameLabelScope?: string

Property Value

string

hsms

An array of Cloud HSM Cluster's HSMs NOTE: This property will not be serialized. It can only be populated by the server.

hsms?: CloudHsmProperties[]

Property Value

CloudHsmProperties[]

privateEndpointConnections

List of private endpoint connection resources NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

The Cloud HSM Cluster's provisioningState NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

The Cloud HSM Cluster public network access

publicNetworkAccess?: string

Property Value

string

statusMessage

Cloud HSM Cluster status message NOTE: This property will not be serialized. It can only be populated by the server.

statusMessage?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From CloudHsmClusterResource.id

identity

Managed service identity (system assigned and/or user assigned identities)

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

Inherited From CloudHsmClusterResource.identity

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From CloudHsmClusterResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From CloudHsmClusterResource.name

sku

SKU details

sku?: CloudHsmClusterSku

Property Value

CloudHsmClusterSku

Inherited From CloudHsmClusterResource.sku

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From CloudHsmClusterResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From CloudHsmClusterResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From CloudHsmClusterResource.type