Edit

Share via


New-AzNetworkCloudKeySetUserObject

Create an in-memory object for KeySetUser.

Syntax

Default (Default)

New-AzNetworkCloudKeySetUserObject
    -AzureUserName <String>
    -SshPublicKeyData <String>
    [-Description <String>]
    [-UserPrincipalName <String>]
    [<CommonParameters>]

Description

Create an in-memory object for KeySetUser.

Examples

Example 1: Create an in-memory object for KeySetUser.

New-AzNetworkCloudKeySetUserObject -AzureUserName azureUserName -SshPublicKeyData "ssh-rsa-key" -Description "userDescription"
AzureUserName Description
------------- -----------
azureUserName userDescription

Create an in-memory object for KeySetUser.

Parameters

-AzureUserName

The user name that will be used for access.

Parameter properties

Type:String
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

-Description

The free-form description for this user.

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

-SshPublicKeyData

The SSH public key data.

Parameter properties

Type:String
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

-UserPrincipalName

The user principal name (email format) used to validate this user's group membership.

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

KeySetUser