Edit

Share via

Update-AzElasticExternalUser

  • Reference
Module:
Az.Elastic

Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment

Syntax

PowerShell 
Update-AzElasticExternalUser
      -MonitorName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-EmailId <String>]
      [-FullName <String>]
      [-Password <String>]
      [-Role <String[]>]
      [-UserName <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell 
Update-AzElasticExternalUser
      -MonitorName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Body <IExternalUserInfo>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell 
Update-AzElasticExternalUser
      -InputObject <IElasticIdentity>
      [-EmailId <String>]
      [-FullName <String>]
      [-Password <String>]
      [-Role <String[]>]
      [-UserName <String>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell 
Update-AzElasticExternalUser
      -InputObject <IElasticIdentity>
      -Body <IExternalUserInfo>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment

Examples

Example 1: Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment

PowerShell 
Update-AzElasticExternalUser -ResourceGroupName elastic-rg-3eytki -MonitorName elastic-rhqz1v

This command will Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment

Parameters

-Body

The properties of the request required for creating user on elastic side To construct, see NOTES section for BODY properties and create a hash table.

Type:IExternalUserInfo
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EmailId

Email id of the user to be created or updated

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FullName

Full name of the user to be created or updated

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IElasticIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MonitorName

Monitor resource name

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Password

Password of the user to be created or updated

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Role

Roles to be assigned for created or updated user

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserName

Username of the user to be created or updated

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Outputs