Get-AzureRmSearchQueryKey

Reference

Module:: AzureRM.Search

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

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmSearchQueryKey
   [-ResourceGroupName] <String>
   [-ServiceName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmSearchQueryKey
   [-ParentObject] <PSSearchService>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmSearchQueryKey
   [-ParentResourceId] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

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

Examples

Example 1

PS C:\> Get-AzureRmSearchQueryKey -ResourceGroupName "TestAzureSearchPsGroup" -ServiceName "pstestazuresearch01"

Name Key                             
---- ---                             
     896AA09C167541072D404E1BE0442CE9

The example gets all query key(s) of the Azure Search Service.

Parameters

-DefaultProfile

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

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

-ParentObject

Search Service Input Object.

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

-ParentResourceId

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

Search Service name.

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

Inputs

PSSearchService

Parameters: ParentObject (ByValue)

String

Outputs

PSSearchQueryKey