Edit

Share via

Get-AzSearchQueryKey

  • Reference
Module:
Az.Search

Gets query key(s) of the Azure Cognitive Search service.

Syntax

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

Description

The Get-AzSearchQueryKey cmdlet gets query key(s) of the Azure Cognitive Search service.

Examples

Example 1

Get-AzSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01"

Name Key                             
---- ---                             
     896AA09C167541072D404E1BE0442CE9

The example gets all query key(s) 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

PSSearchQueryKey