New-AzDataBoxKeyEncryptionKeyObject

Module:

Az.DataBox Module

Create an in-memory object for KeyEncryptionKey.

Syntax

Default (Default)

New-AzDataBoxKeyEncryptionKeyObject
    -KekType <KekType>
    [-IdentityProperty <IIdentityProperties>]
    [-KekUrl <String>]
    [-KekVaultResourceId <String>]
    [<CommonParameters>]

Description

Create an in-memory object for KeyEncryptionKey.

Examples

Example 1: Create a in-memory object for KeyEncryptionKey

New-AzDataBoxKeyEncryptionKeyObject -KekType "CustomerManaged" -IdentityProperty @{Type = "UserAssigned"; UserAssignedResourceId = "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName"} -KekUrl "keyIdentifier" -KekVaultResourceId "/subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName"

KekType         KekUrl                                           KekVaultResourceId
-------         ------                                           ------------------
CustomerManaged keyIdentifier /subscriptions/SubscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName

Create a in-memory object for KeyEncryptionKey

Parameters

-IdentityProperty

Managed identity properties used for key encryption. To construct, see NOTES section for IDENTITYPROPERTY properties and create a hash table.

Parameter properties

Type:	IIdentityProperties
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-KekType

Type of encryption key used for key encryption.

Parameter properties

Type:	KekType
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-KekUrl

Key encryption key. It is required in case of Customer managed KekType.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-KekVaultResourceId

Kek vault resource id. It is required in case of Customer managed KekType.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

KeyEncryptionKey