Set-AzSearchService

Update an Azure Cognitive Search service.

Syntax

Set-AzSearchService
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-PartitionCount <Int32>]
   [-ReplicaCount <Int32>]
   [-PublicNetworkAccess <PSPublicNetworkAccess>]
   [-IdentityType <PSIdentityType>]
   [-IPRuleList <PSIpRule[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSearchService
   [-InputObject] <PSSearchService>
   [-PartitionCount <Int32>]
   [-ReplicaCount <Int32>]
   [-PublicNetworkAccess <PSPublicNetworkAccess>]
   [-IdentityType <PSIdentityType>]
   [-IPRuleList <PSIpRule[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSearchService
   [-ResourceId] <String>
   [-PartitionCount <Int32>]
   [-ReplicaCount <Int32>]
   [-PublicNetworkAccess <PSPublicNetworkAccess>]
   [-IdentityType <PSIdentityType>]
   [-IPRuleList <PSIpRule[]>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-AzSearchService cmdlet modifies an Azure Cognitive Search service.

Examples

Example 1

PS C:\> Set-AzSearchService -ResourceGroupName "TestAzureSearchPsGroup" -Name "pstestazuresearch01" -PartitionCount 2 -ReplicaCount 2


ResourceGroupName : TestAzureSearchPsGroup
Name              : pstestazuresearch01
Id                : /subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestAzureSearchPsGroup/providers/Microsoft.Search/searchServices/pstestazuresearch01
Location          : West US
Sku               : Standard
ReplicaCount      : 2
PartitionCount    : 2
HostingMode       : Default
Tags              :

The example changes partition count and replica count of the Azure Cognitive Search service to 2.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

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

(Optional) Azure Cognitive Search Service Identity (None/SystemAssigned)

Type:Nullable<T>[PSIdentityType]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Search Service Input Object.

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

(Optional) Azure Cognitive Search Service IP rules

Type:PSIpRule[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Search Service name.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PartitionCount

Search Service partition count.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PublicNetworkAccess

(Optional) Azure Cognitive Search Service public network access (Enabled/Disabled)

Type:Nullable<T>[PSPublicNetworkAccess]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ReplicaCount

Search Service replica count.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

Resource Group name.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Search Service Resource Id.

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSSearchService

String

Outputs

PSSearchService