Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Get-AzSearchService

  • Preview

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Gets an Azure AI Search service.

Syntax

ResourceGroupParameterSet (Default) 

Get-AzSearchService
 [-ResourceGroupName] <String>
 [[-Name] <String>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

ResourceIdParameterSet 

Get-AzSearchService
 [-ResourceId] <String>
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Description

The Get-AzSearchService cmdlet gets the specified Azure AI Search service.

Examples

Example 1

Get-AzSearchService -ResourceGroupName felixwa-01

ResourceGroupName : felixwa-01
Name : felixwa-basic-search
Location : West US
Sku : Basic
ReplicaCount : 1
PartitionCount : 1
HostingMode : Default
Id : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/felixwa-01/providers/Microsoft.Search/searchServices/felixwa-basic-search

Get an Azure AI Search service with specified parameters.

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

-Name

Azure AI Search Service name.

Parameter properties

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

Parameter sets

-ResourceGroupName

Resource Group name.

Parameter properties

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

Parameter sets

-ResourceId

Azure AI Search Service Resource Id.

Parameter properties

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

Parameter sets

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

String

Outputs

PSSearchService

Related Links

Feedback

Was this page helpful?