Edit

Share via

Get-AzSearchAdminKeyPair

Module:
Az.Search Module

Gets admin key pair of the Azure AI Search service.

Syntax

ResourceNameParameterSet (Default) 

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

ParentObjectParameterSet 

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

ParentResourceIdParameterSet 

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

Description

The Get-AzSearchAdminKeyPair cmdlet gets the admin key pair of the Azure AI 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 AI Search service.

Parameters

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentObject

Azure AI Search Service Input Object.

Parameter properties

Type:PSSearchService
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ParentObjectParameterSet
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ParentResourceId

Azure AI Search Service Resource Id.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ParentResourceIdParameterSet
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ResourceGroupName

Resource Group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceNameParameterSet
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceName

Azure AI Search Service name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ResourceNameParameterSet
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

PSSearchService

String

Outputs

PSSearchAdminKey