Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzSearchService
- Preview
- Module:
- Az.Search Module
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.
Update an Azure AI Search service.
Syntax
ResourceNameParameterSet (Default)
Set-AzSearchService
[-ResourceGroupName] <String>
[-Name] <String>
[-PartitionCount <Int32>]
[-ReplicaCount <Int32>]
[-PublicNetworkAccess <PSPublicNetworkAccess>]
[-IdentityType <PSIdentityType>]
[-IPRuleList <PSIpRule[]>]
[-DisableLocalAuth <Boolean>]
[-AuthOption <PSAuthOptionName>]
[-AadAuthFailureMode <PSAadAuthFailureMode>]
[-DataExfiltrationProtectionList <PSDataExfiltrationProtection[]>]
[-Bypass <PSSearchBypass>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObjectParameterSet
Set-AzSearchService
[-InputObject] <PSSearchService>
[-PartitionCount <Int32>]
[-ReplicaCount <Int32>]
[-PublicNetworkAccess <PSPublicNetworkAccess>]
[-IdentityType <PSIdentityType>]
[-IPRuleList <PSIpRule[]>]
[-DisableLocalAuth <Boolean>]
[-AuthOption <PSAuthOptionName>]
[-AadAuthFailureMode <PSAadAuthFailureMode>]
[-DataExfiltrationProtectionList <PSDataExfiltrationProtection[]>]
[-Bypass <PSSearchBypass>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceIdParameterSet
Set-AzSearchService
[-ResourceId] <String>
[-PartitionCount <Int32>]
[-ReplicaCount <Int32>]
[-PublicNetworkAccess <PSPublicNetworkAccess>]
[-IdentityType <PSIdentityType>]
[-IPRuleList <PSIpRule[]>]
[-DisableLocalAuth <Boolean>]
[-AuthOption <PSAuthOptionName>]
[-AadAuthFailureMode <PSAadAuthFailureMode>]
[-DataExfiltrationProtectionList <PSDataExfiltrationProtection[]>]
[-Bypass <PSSearchBypass>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzSearchService cmdlet modifies an Azure AI Search service.
Examples
Example 1
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 AI Search service to 2.
Parameters
-AadAuthFailureMode
(Optional) What status code to return when failing AAD authentication, if both api key and AAD authentication are allowed for the Azure AI Search service
Parameter properties
| Type: | |
| Default value: | None |
| Accepted values: | Http403, Http401WithBearerChallenge |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AuthOption
(Optional) Whether to only allow API key authentication or both API key authentication and AAD authentication for the Azure AI Search service
Parameter properties
| Type: | |
| Default value: | None |
| Accepted values: | ApiKeyOnly, AadOrApiKey |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Bypass
(Optional) Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section
Parameter properties
| Type: | |
| Default value: | None |
| Accepted values: | None, AzureServices |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DataExfiltrationProtectionList
(Optional) A list of data exfiltration scenarios that are explicitly disallowed for the search service
Parameter properties
| Type: | |
| Default value: | None |
| Accepted values: | BlockAll |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-DisableLocalAuth
(Optional) Disable API key authentication for the Azure AI Search service (true/false/null)
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IdentityType
(Optional) Azure AI Search Service Identity (None/SystemAssigned)
Parameter properties
| Type: | |
| Default value: | None |
| Accepted values: | None, SystemAssigned, UserAssigned, SystemAssignedUserAssigned |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Search Service Input Object.
Parameter properties
| Type: | PSSearchService |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IPRuleList
(Optional) Azure AI Search Service IP rules
Parameter properties
| Type: | PSIpRule[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Search Service name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PartitionCount
Search Service partition count.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PublicNetworkAccess
(Optional) Azure AI Search Service public network access (Enabled/Disabled)
Parameter properties
| Type: | |
| Default value: | None |
| Accepted values: | Enabled, Disabled, SecuredByPerimeter |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ReplicaCount
Search Service replica count.
Parameter properties
| Type: | |
| 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
Search Service Resource Id.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
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
PSSearchService
String
Outputs
PSSearchService
Related Links
Azure PowerShell
Feedback
Was this page helpful?