Get-AzSearchQueryKey.md

external help file	Module Name	online version	schema
Microsoft.Azure.PowerShell.Cmdlets.Search.dll-Help.xml	Az.Search	https://learn.microsoft.com/powershell/module/az.search/get-azsearchquerykey	2.0.0

Get-AzSearchQueryKey

SYNOPSIS

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

SYNTAX

ResourceNameParameterSet (Default)

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

ParentObjectParameterSet

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

ParentResourceIdParameterSet

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: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

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

-ParentObject

Azure Cognitive Search Service Input Object.

Type: Microsoft.Azure.Commands.Management.Search.Models.PSSearchService
Parameter Sets: ParentObjectParameterSet
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ParentResourceId

Azure Cognitive Search Service Resource Id.

Type: System.String
Parameter Sets: ParentResourceIdParameterSet
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceGroupName

Resource Group name.

Type: System.String
Parameter Sets: ResourceNameParameterSet
Aliases:

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

-ServiceName

Azure Cognitive Search Service name.

Type: System.String
Parameter Sets: ResourceNameParameterSet
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.Commands.Management.Search.Models.PSSearchService

System.String

OUTPUTS

Microsoft.Azure.Commands.Management.Search.Models.PSSearchQueryKey

NOTES

RELATED LINKS

New-AzSearchQueryKey.md

Remove-AzSearchQueryKey.md