Edit

Share via


New-AzEventHubKeyVaultPropertiesObject

Create an in-memory object for KeyVaultProperties.

Syntax

Default (Default)

New-AzEventHubKeyVaultPropertiesObject
    [-KeyName <String>]
    [-KeyVaultUri <String>]
    [-KeyVersion <String>]
    [-UserAssignedIdentity <String>]
    [<CommonParameters>]

Description

Create an in-memory object for KeyVaultProperties.

Examples

Example 1: Construct an in-memory KeyVaultProperties object

New-AzEventHubKeyVaultPropertiesObject -KeyName key1 -KeyVaultUri https://testkeyvault.vault.azure.net

Creates an in-memory object of type IKeyVaultProperties. An array of IKeyVaultProperties can be fed as input to KeyVaultProperty parameter of New-AzEventHubNamespaceV2 and Set-AzEventHubNamespaceV2 to enable encryption.

Parameters

-KeyName

Name of the Key from KeyVault.

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

-KeyVaultUri

Uri of KeyVault.

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

-KeyVersion

Key Version.

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

-UserAssignedIdentity

ARM ID of user Identity selected for encryption.

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

KeyVaultProperties