Edit

Share via

Get-AzElasticOrganizationApiKey

  • Reference
Module:
Az.Elastic

Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.

Syntax

PowerShell 
Get-AzElasticOrganizationApiKey
   [-SubscriptionId <String[]>]
   [-EmailId <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
PowerShell 
Get-AzElasticOrganizationApiKey
   [-SubscriptionId <String[]>]
   -Body <IUserEmailId>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
PowerShell 
Get-AzElasticOrganizationApiKey
   -InputObject <IElasticIdentity>
   [-EmailId <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
PowerShell 
Get-AzElasticOrganizationApiKey
   -InputObject <IElasticIdentity>
   -Body <IUserEmailId>
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.

Examples

Example 1: Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.

PowerShell 
Get-AzElasticOrganizationApiKey -Body $EmailIdObject

This command will Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.

Parameters

-Body

Email Id of the User Organization, of which the API Key must be returned To construct, see NOTES section for BODY properties and create a hash table.

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

The User email Id

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

-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

-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