Edit

Share via

Get-AzSearchAdminKeyPair

  • Reference
Module:
Az.Search

Gets admin key pair of the Azure Cognitive Search service.

Syntax

Get-AzSearchAdminKeyPair
   [-ResourceGroupName] <String>
   [-ServiceName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSearchAdminKeyPair
   [-ParentObject] <PSSearchService>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzSearchAdminKeyPair
   [-ParentResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSearchAdminKeyPair cmdlet gets the admin key pair of the Azure Cognitive Search service.

Examples

Example 1

Get-AzSearchAdminKeyPair -ResourceGroupName felixwa-01 -ServiceName felixwa-basic-search

Primary                          Secondary                       
-------                          ---------                       
3B06A25BDADFF72EC132736BAA2547A1 E643B75A52E04DF13EB690807C451C55

The example gets admin key pair of the Azure Cognitive Search service.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ParentObject

Azure Cognitive Search Service Input Object.

Type:PSSearchService
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ParentResourceId

Azure Cognitive Search Service Resource Id.

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

-ResourceGroupName

Resource Group name.

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

-ServiceName

Azure Cognitive Search Service name.

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

Inputs

PSSearchService

String

Outputs

PSSearchAdminKey