3.27.0 (latest) 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0

    public sealed class SingleTenantHsmInstanceProposal : IMessage<SingleTenantHsmInstanceProposal>, IEquatable<SingleTenantHsmInstanceProposal>, IDeepCloneable<SingleTenantHsmInstanceProposal>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class SingleTenantHsmInstanceProposal.

A
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\]
represents a proposal to perform an operation on a
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\].

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> SingleTenantHsmInstanceProposal

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[SingleTenantHsmInstanceProposal](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Kms.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1)

## Assembly

Google.Cloud.Kms.V1.dll

## Constructors

### SingleTenantHsmInstanceProposal()

    public SingleTenantHsmInstanceProposal()

### SingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposal)

    public SingleTenantHsmInstanceProposal(SingleTenantHsmInstanceProposal other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal` |

## Properties

### AddQuorumMember

    public SingleTenantHsmInstanceProposal.Types.AddQuorumMember AddQuorumMember { get; set; }

Add a quorum member to the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\].
This will increase the
\[total_approver_count\]\[google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth.total_approver_count\]
by 1. The
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
must be in the
\[ACTIVE\]\[google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE\] state
to perform this operation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.AddQuorumMember` |   |

### ApprovalParametersCase

    public SingleTenantHsmInstanceProposal.ApprovalParametersOneofCase ApprovalParametersCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.ApprovalParametersOneofCase` |   |

### CreateTime

    public Timestamp CreateTime { get; set; }

Output only. The time at which the
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\]
was created.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### DeleteSingleTenantHsmInstance

    public SingleTenantHsmInstanceProposal.Types.DeleteSingleTenantHsmInstance DeleteSingleTenantHsmInstance { get; set; }

Delete the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\].
Deleting a
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
will make all \[CryptoKeys\]\[google.cloud.kms.v1.CryptoKey\] attached to the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
unusable. The
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
must be in the
\[DISABLED\]\[google.cloud.kms.v1.SingleTenantHsmInstance.State.DISABLED\] or
\[PENDING_TWO_FACTOR_AUTH_REGISTRATION\]\[google.cloud.kms.v1.SingleTenantHsmInstance.State.PENDING_TWO_FACTOR_AUTH_REGISTRATION\]
state to perform this operation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.DeleteSingleTenantHsmInstance` |   |

### DeleteTime

    public Timestamp DeleteTime { get; set; }

Output only. The time at which the
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\]
was deleted.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### DisableSingleTenantHsmInstance

    public SingleTenantHsmInstanceProposal.Types.DisableSingleTenantHsmInstance DisableSingleTenantHsmInstance { get; set; }

Disable the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\].
The
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
must be in the
\[ACTIVE\]\[google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE\] state
to perform this operation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.DisableSingleTenantHsmInstance` |   |

### EnableSingleTenantHsmInstance

    public SingleTenantHsmInstanceProposal.Types.EnableSingleTenantHsmInstance EnableSingleTenantHsmInstance { get; set; }

Enable the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\].
The
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
must be in the
\[DISABLED\]\[google.cloud.kms.v1.SingleTenantHsmInstance.State.DISABLED\]
state to perform this operation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.EnableSingleTenantHsmInstance` |   |

### ExpirationCase

    public SingleTenantHsmInstanceProposal.ExpirationOneofCase ExpirationCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.ExpirationOneofCase` |   |

### ExpireTime

    public Timestamp ExpireTime { get; set; }

The time at which the
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\]
will expire if not approved and executed.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### FailureReason

    public string FailureReason { get; set; }

Output only. The root cause of the most recent failure. Only present if
\[state\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal.state\] is
\[FAILED\]\[SingleTenantHsmInstanceProposal.FAILED\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Name

    public string Name { get; set; }

Identifier. The resource name for this
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\] in
the format `projects/*/locations/*/singleTenantHsmInstances/*/proposals/*`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### OperationCase

    public SingleTenantHsmInstanceProposal.OperationOneofCase OperationCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.OperationOneofCase` |   |

### PurgeTime

    public Timestamp PurgeTime { get; set; }

Output only. The time at which the soft-deleted
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\]
will be permanently purged. This field is only populated
when the state is DELETED and will be set a time after expiration of the
proposal, i.e. \>= expire_time or (create_time + ttl).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### QuorumParameters

    public SingleTenantHsmInstanceProposal.Types.QuorumParameters QuorumParameters { get; set; }

Output only. The quorum approval parameters for the
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.QuorumParameters` |   |

### RefreshSingleTenantHsmInstance

    public SingleTenantHsmInstanceProposal.Types.RefreshSingleTenantHsmInstance RefreshSingleTenantHsmInstance { get; set; }

Refreshes the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\].
This operation must be performed periodically to keep the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
active. This operation must be performed before
\[unrefreshed_duration_until_disable\]\[google.cloud.kms.v1.SingleTenantHsmInstance.unrefreshed_duration_until_disable\]
has passed. The
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
must be in the
\[ACTIVE\]\[google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE\] state
to perform this operation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.RefreshSingleTenantHsmInstance` |   |

### RegisterTwoFactorAuthKeys

    public SingleTenantHsmInstanceProposal.Types.RegisterTwoFactorAuthKeys RegisterTwoFactorAuthKeys { get; set; }

Register 2FA keys for the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\].
This operation requires all N Challenges to be signed by 2FA keys. The
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
must be in the
\[PENDING_TWO_FACTOR_AUTH_REGISTRATION\]\[google.cloud.kms.v1.SingleTenantHsmInstance.State.PENDING_TWO_FACTOR_AUTH_REGISTRATION\]
state to perform this operation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.RegisterTwoFactorAuthKeys` |   |

### RemoveQuorumMember

    public SingleTenantHsmInstanceProposal.Types.RemoveQuorumMember RemoveQuorumMember { get; set; }

Remove a quorum member from the
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\].
This will reduce
\[total_approver_count\]\[google.cloud.kms.v1.SingleTenantHsmInstance.QuorumAuth.total_approver_count\]
by 1. The
\[SingleTenantHsmInstance\]\[google.cloud.kms.v1.SingleTenantHsmInstance\]
must be in the
\[ACTIVE\]\[google.cloud.kms.v1.SingleTenantHsmInstance.State.ACTIVE\] state
to perform this operation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.RemoveQuorumMember` |   |

### RequiredActionQuorumParameters

    public SingleTenantHsmInstanceProposal.Types.RequiredActionQuorumParameters RequiredActionQuorumParameters { get; set; }

Output only. Parameters for an approval of a
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\]
that has both required challenges and a quorum.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.RequiredActionQuorumParameters` |   |

### SingleTenantHsmInstanceProposalName

    public SingleTenantHsmInstanceProposalName SingleTenantHsmInstanceProposalName { get; set; }

[SingleTenantHsmInstanceProposalName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal#Google_Cloud_Kms_V1_SingleTenantHsmInstanceProposal_Name) resource name
property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalName` |   |

### State

    public SingleTenantHsmInstanceProposal.Types.State State { get; set; }

Output only. The state of the
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.State` |   |

### Ttl

    public Duration Ttl { get; set; }

Input only. The TTL for the
\[SingleTenantHsmInstanceProposal\]\[google.cloud.kms.v1.SingleTenantHsmInstanceProposal\].
Proposals will expire after this duration.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Duration.html` |   |

### UpgradeKeyTrust

    public SingleTenantHsmInstanceProposal.Types.UpgradeKeyTrust UpgradeKeyTrust { get; set; }

Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key.
The key must be in the
\[ACTIVE\]\[CryptoKeyVersion.CryptoKeyVersionState.ACTIVE\] state to perform
this operation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposalhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.SingleTenantHsmInstanceProposal.Types.UpgradeKeyTrust` |   |