azure.mgmt.search.models.SearchServiceUpdate.yml

### YamlMime:PythonClass
uid: azure.mgmt.search.models.SearchServiceUpdate
name: SearchServiceUpdate
fullName: azure.mgmt.search.models.SearchServiceUpdate
module: azure.mgmt.search.models
inheritances:
- azure.mgmt.search.models._models_py3.Resource
summary: 'The parameters used to update an Azure Cognitive Search service.


  Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
  syntax: 'SearchServiceUpdate(*, sku: _models.Sku | None = None, location: str |
    None = None, tags: Dict[str, str] | None = None, identity: _models.Identity |
    None = None, replica_count: int = 1, partition_count: int = 1, hosting_mode: str
    | _models.HostingMode = ''default'', public_network_access: str | _models.PublicNetworkAccess
    = ''enabled'', network_rule_set: _models.NetworkRuleSet | None = None, encryption_with_cmk:
    _models.EncryptionWithCmk | None = None, disable_local_auth: bool | None = None,
    auth_options: _models.DataPlaneAuthOptions | None = None, semantic_search: str
    | _models.SearchSemanticSearch | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: sku
    description: 'The SKU of the Search Service, which determines price tier and capacity
      limits.

      This property is required when creating a new Search Service.'
    types:
    - <xref:azure.mgmt.search.models.Sku>
  - name: location
    description: 'The geographic location of the resource. This must be one of the
      supported

      and registered Azure Geo Regions (for example, West US, East US, Southeast Asia,
      and so forth).

      This property is required when creating a new resource.'
    types:
    - <xref:str>
  - name: tags
    description: Tags to help categorize the resource in the Azure portal.
    types:
    - <xref:dict>[<xref:str>, <xref:str>]
  - name: identity
    description: The identity of the resource.
    types:
    - <xref:azure.mgmt.search.models.Identity>
  - name: replica_count
    description: '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.'
    defaultValue: '1'
    types:
    - <xref:int>
  - name: partition_count
    description: '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.'
    defaultValue: '1'
    types:
    - <xref:int>
  - name: hosting_mode
    description: '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''.
      Known values are:

      "default" and "highDensity".'
    defaultValue: default
    types:
    - <xref:str>
    - <xref:azure.mgmt.search.models.HostingMode>
  - name: public_network_access
    description: '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. Known

      values are: "enabled" and "disabled".'
    defaultValue: enabled
    types:
    - <xref:str>
    - <xref:azure.mgmt.search.models.PublicNetworkAccess>
  - name: network_rule_set
    description: 'Network specific rules that determine how the Azure Cognitive Search

      service may be reached.'
    types:
    - <xref:azure.mgmt.search.models.NetworkRuleSet>
  - name: encryption_with_cmk
    description: 'Specifies any policy regarding encryption of resources (such as

      indexes) using customer manager keys within a search service.'
    types:
    - <xref:azure.mgmt.search.models.EncryptionWithCmk>
  - name: disable_local_auth
    description: '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.'
    types:
    - <xref:bool>
  - name: auth_options
    description: '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.'
    types:
    - <xref:azure.mgmt.search.models.DataPlaneAuthOptions>
  - name: semantic_search
    description: 'Sets options that control the availability of semantic search. This

      configuration is only possible for certain Azure Cognitive Search SKUs in certain
      locations.

      Known values are: "disabled", "free", and "standard".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.search.models.SearchSemanticSearch>
variables:
- description: 'Fully qualified resource ID for the resource. Ex -

    /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.'
  name: id
  types:
  - <xref:str>
- description: The name of the resource.
  name: name
  types:
  - <xref:str>
- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines"
    or

    "Microsoft.Storage/storageAccounts".'
  name: type
  types:
  - <xref:str>
- description: 'The SKU of the Search Service, which determines price tier and capacity
    limits. This

    property is required when creating a new Search Service.'
  name: sku
  types:
  - <xref:azure.mgmt.search.models.Sku>
- description: 'The geographic location of the resource. This must be one of the supported
    and

    registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and
    so forth).

    This property is required when creating a new resource.'
  name: location
  types:
  - <xref:str>
- description: Tags to help categorize the resource in the Azure portal.
  name: tags
  types:
  - <xref:dict>[<xref:str>, <xref:str>]
- description: The identity of the resource.
  name: identity
  types:
  - <xref:azure.mgmt.search.models.Identity>
- description: '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.'
  name: replica_count
  types:
  - <xref:int>
- description: '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.'
  name: partition_count
  types:
  - <xref:int>
- description: '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''. Known
    values are: "default"

    and "highDensity".'
  name: hosting_mode
  types:
  - <xref:str>
  - <xref:azure.mgmt.search.models.HostingMode>
- description: '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. Known

    values are: "enabled" and "disabled".'
  name: public_network_access
  types:
  - <xref:str>
  - <xref:azure.mgmt.search.models.PublicNetworkAccess>
- description: '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. If your service is in the degraded, disabled, or error states, it means
    the Azure

    Cognitive Search team is actively investigating the underlying issue. Dedicated
    services in

    these states are still chargeable based on the number of search units provisioned.
    Known values

    are: "running", "provisioning", "deleting", "degraded", "disabled", and "error".'
  name: status
  types:
  - <xref:str>
  - <xref:azure.mgmt.search.models.SearchServiceStatus>
- description: The details of the search service status.
  name: status_details
  types:
  - <xref:str>
- description: '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. Known values are: "succeeded", "provisioning",
    and

    "failed".'
  name: provisioning_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.search.models.ProvisioningState>
- description: 'Network specific rules that determine how the Azure Cognitive Search

    service may be reached.'
  name: network_rule_set
  types:
  - <xref:azure.mgmt.search.models.NetworkRuleSet>
- description: 'Specifies any policy regarding encryption of resources (such as

    indexes) using customer manager keys within a search service.'
  name: encryption_with_cmk
  types:
  - <xref:azure.mgmt.search.models.EncryptionWithCmk>
- description: '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.'
  name: disable_local_auth
  types:
  - <xref:bool>
- description: '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.'
  name: auth_options
  types:
  - <xref:azure.mgmt.search.models.DataPlaneAuthOptions>
- description: 'The list of private endpoint connections to the Azure

    Cognitive Search service.'
  name: private_endpoint_connections
  types:
  - <xref:list>[<xref:azure.mgmt.search.models.PrivateEndpointConnection>]
- description: 'Sets options that control the availability of semantic search. This

    configuration is only possible for certain Azure Cognitive Search SKUs in certain
    locations.

    Known values are: "disabled", "free", and "standard".'
  name: semantic_search
  types:
  - <xref:str>
  - <xref:azure.mgmt.search.models.SearchSemanticSearch>
- description: 'The list of shared private link resources managed by the

    Azure Cognitive Search service.'
  name: shared_private_link_resources
  types:
  - <xref:list>[<xref:azure.mgmt.search.models.SharedPrivateLinkResource>]