ArmSearchModelFactory.SearchServicePatch Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initializes a new instance of SearchServicePatch.
public static Azure.ResourceManager.Search.Models.SearchServicePatch SearchServicePatch (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, Azure.ResourceManager.Search.Models.SearchServiceSkuName? searchSkuName = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, int? replicaCount = default, int? partitionCount = default, Azure.ResourceManager.Search.Models.SearchServiceHostingMode? hostingMode = default, Azure.ResourceManager.Search.Models.SearchServicePublicInternetAccess? publicInternetAccess = default, Azure.ResourceManager.Search.Models.SearchServiceStatus? status = default, string statusDetails = default, Azure.ResourceManager.Search.Models.SearchServiceProvisioningState? provisioningState = default, Azure.ResourceManager.Search.Models.SearchServiceNetworkRuleSet networkRuleSet = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Search.Models.SearchDisabledDataExfiltrationOption> disabledDataExfiltrationOptions = default, Azure.ResourceManager.Search.Models.SearchEncryptionWithCmk encryptionWithCmk = default, bool? isLocalAuthDisabled = default, Azure.ResourceManager.Search.Models.SearchAadAuthDataPlaneAuthOptions authOptions = default, Azure.ResourceManager.Search.Models.SearchSemanticSearch? semanticSearch = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Search.SearchPrivateEndpointConnectionData> privateEndpointConnections = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Search.SharedSearchServicePrivateLinkResourceData> sharedPrivateLinkResources = default, Azure.ETag? eTag = default);static member SearchServicePatch : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * Nullable<Azure.ResourceManager.Search.Models.SearchServiceSkuName> * Azure.ResourceManager.Models.ManagedServiceIdentity * Nullable<int> * Nullable<int> * Nullable<Azure.ResourceManager.Search.Models.SearchServiceHostingMode> * Nullable<Azure.ResourceManager.Search.Models.SearchServicePublicInternetAccess> * Nullable<Azure.ResourceManager.Search.Models.SearchServiceStatus> * string * Nullable<Azure.ResourceManager.Search.Models.SearchServiceProvisioningState> * Azure.ResourceManager.Search.Models.SearchServiceNetworkRuleSet * seq<Azure.ResourceManager.Search.Models.SearchDisabledDataExfiltrationOption> * Azure.ResourceManager.Search.Models.SearchEncryptionWithCmk * Nullable<bool> * Azure.ResourceManager.Search.Models.SearchAadAuthDataPlaneAuthOptions * Nullable<Azure.ResourceManager.Search.Models.SearchSemanticSearch> * seq<Azure.ResourceManager.Search.SearchPrivateEndpointConnectionData> * seq<Azure.ResourceManager.Search.SharedSearchServicePrivateLinkResourceData> * Nullable<Azure.ETag> -> Azure.ResourceManager.Search.Models.SearchServicePatchPublic Shared Function SearchServicePatch (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional searchSkuName As Nullable(Of SearchServiceSkuName) = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional replicaCount As Nullable(Of Integer) = Nothing, Optional partitionCount As Nullable(Of Integer) = Nothing, Optional hostingMode As Nullable(Of SearchServiceHostingMode) = Nothing, Optional publicInternetAccess As Nullable(Of SearchServicePublicInternetAccess) = Nothing, Optional status As Nullable(Of SearchServiceStatus) = Nothing, Optional statusDetails As String = Nothing, Optional provisioningState As Nullable(Of SearchServiceProvisioningState) = Nothing, Optional networkRuleSet As SearchServiceNetworkRuleSet = Nothing, Optional disabledDataExfiltrationOptions As IEnumerable(Of SearchDisabledDataExfiltrationOption) = Nothing, Optional encryptionWithCmk As SearchEncryptionWithCmk = Nothing, Optional isLocalAuthDisabled As Nullable(Of Boolean) = Nothing, Optional authOptions As SearchAadAuthDataPlaneAuthOptions = Nothing, Optional semanticSearch As Nullable(Of SearchSemanticSearch) = Nothing, Optional privateEndpointConnections As IEnumerable(Of SearchPrivateEndpointConnectionData) = Nothing, Optional sharedPrivateLinkResources As IEnumerable(Of SharedSearchServicePrivateLinkResourceData) = Nothing, Optional eTag As Nullable(Of ETag) = Nothing) As SearchServicePatchParameters
The id.
- name
- String
The name.
- resourceType
- ResourceType
The resourceType.
- systemData
- SystemData
The systemData.
- tags
- IDictionary<String,String>
The tags.
- location
- AzureLocation
The location.
- searchSkuName
- Nullable<SearchServiceSkuName>
The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.
- identity
- ManagedServiceIdentity
Details about the search service identity. A null value indicates that the search service has no identity assigned.
The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU.
The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3.
- hostingMode
- Nullable<SearchServiceHostingMode>
Applicable only for the standard3 SKU. You can set this property to enable up to 3 high density partitions that allow up to 1000 indexes, which is much higher than the maximum indexes allowed for any other SKU. For the standard3 SKU, the value is either 'default' or 'highDensity'. For all other SKUs, this value must be 'default'.
- publicInternetAccess
- Nullable<SearchServicePublicInternetAccess>
This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
- status
- Nullable<SearchServiceStatus>
The status of the search service. Possible values include: 'running': The search service is running and no provisioning operations are underway. 'provisioning': The search service is being provisioned or scaled up or down. 'deleting': The search service is being deleted. 'degraded': The search service is degraded. This can occur when the underlying search units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. 'stopped': The search service is in a subscription that's disabled. If your service is in the degraded, disabled, or error states, it means the Azure AI Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
- statusDetails
- String
The details of the search service status.
- provisioningState
- Nullable<SearchServiceProvisioningState>
The state of the last provisioning operation performed on the search service. Provisioning is an intermediate state that occurs while service capacity is being established. After capacity is set up, provisioningState changes to either 'succeeded' or 'failed'. Client applications can poll provisioning status (the recommended polling interval is from 30 seconds to one minute) by using the Get Search Service operation to see when an operation is completed. If you are using the free service, this value tends to come back as 'succeeded' directly in the call to Create search service. This is because the free service uses capacity that is already set up.
- networkRuleSet
- SearchServiceNetworkRuleSet
Network specific rules that determine how the Azure AI Search service may be reached.
- disabledDataExfiltrationOptions
- IEnumerable<SearchDisabledDataExfiltrationOption>
A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future.
- encryptionWithCmk
- SearchEncryptionWithCmk
Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.
When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined.
- authOptions
- SearchAadAuthDataPlaneAuthOptions
Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true.
- semanticSearch
- Nullable<SearchSemanticSearch>
Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
- privateEndpointConnections
- IEnumerable<SearchPrivateEndpointConnectionData>
The list of private endpoint connections to the Azure AI Search service.
- sharedPrivateLinkResources
- IEnumerable<SharedSearchServicePrivateLinkResourceData>
The list of shared private link resources managed by the Azure AI Search service.
A system generated property representing the service's etag that can be for optimistic concurrency control during updates.
Returns
A new SearchServicePatch instance for mocking.
Applies to
Azure SDK for .NET