azure.mgmt.search.models module

class azure.mgmt.search.models.AadAuthFailureMode(*values)[source]

Bases: str, Enum

Describes what response the data plane API of a search service would send for requests that failed authentication.

HTTP401_WITH_BEARER_CHALLENGE = 'http401WithBearerChallenge'

Indicates that requests that failed authentication should be presented with an HTTP status code of 401 (Unauthorized) and present a Bearer Challenge.

HTTP403 = 'http403'

Indicates that requests that failed authentication should be presented with an HTTP status code of 403 (Forbidden).

class azure.mgmt.search.models.AdminKeyKind(*values)[source]

Bases: str, Enum

AdminKeyKind.

PRIMARY = 'primary'

The primary API key for the search service.

SECONDARY = 'secondary'

The secondary API key for the search service.

class azure.mgmt.search.models.AdminKeyResult(**kwargs: Any)[source]

Bases: Model

Response containing the primary and secondary admin API keys for a given Azure AI Search service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • primary_key (str) – The primary admin API key of the search service.

  • secondary_key (str) – The secondary admin API key of the search service.

class azure.mgmt.search.models.AsyncOperationResult(*, status: str | _models.SharedPrivateLinkResourceAsyncOperationResult | None = None, **kwargs: Any)[source]

Bases: Model

The details of a long running asynchronous shared private link resource operation.

Variables:

status (str or SharedPrivateLinkResourceAsyncOperationResult) – The current status of the long running asynchronous shared private link resource operation. Known values are: “Running”, “Succeeded”, and “Failed”.

Keyword Arguments:

status (str or SharedPrivateLinkResourceAsyncOperationResult) – The current status of the long running asynchronous shared private link resource operation. Known values are: “Running”, “Succeeded”, and “Failed”.

class azure.mgmt.search.models.CheckNameAvailabilityInput(*, name: str, **kwargs: Any)[source]

Bases: Model

Input of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • name (str) – The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Required.

  • type (str) – The type of the resource whose name is to be validated. This value must always be ‘searchServices’. Required. Default value is “searchServices”.

Keyword Arguments:

name (str) – The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Required.

type = 'searchServices'
class azure.mgmt.search.models.CheckNameAvailabilityOutput(**kwargs: Any)[source]

Bases: Model

Output of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • is_name_available (bool) – A value indicating whether the name is available.

  • reason (str or UnavailableNameReason) – The reason why the name is not available. ‘Invalid’ indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). ‘AlreadyExists’ indicates that the name is already in use and is therefore unavailable. Known values are: “Invalid” and “AlreadyExists”.

  • message (str) – A message that explains why the name is invalid and provides resource naming requirements. Available only if ‘Invalid’ is returned in the ‘reason’ property.

class azure.mgmt.search.models.CloudErrorBody(*, code: str | None = None, message: str | None = None, target: str | None = None, details: List[_models.CloudErrorBody] | None = None, **kwargs: Any)[source]

Bases: Model

Describes a particular API error with an error code and a message.

Variables:

  • code (str) – An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.

  • message (str) – A message that describes the error in detail and provides debugging information.

  • target (str) – The target of the particular error (for example, the name of the property in error).

  • details (list[CloudErrorBody]) – Contains nested errors that are related to this error.

Keyword Arguments:

  • code (str) – An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases.

  • message (str) – A message that describes the error in detail and provides debugging information.

  • target (str) – The target of the particular error (for example, the name of the property in error).

  • details (list[CloudErrorBody]) – Contains nested errors that are related to this error.

class azure.mgmt.search.models.ComputeType(*values)[source]

Bases: str, Enum

Configure this property to support the search service using either the default compute or Azure Confidential Compute.

CONFIDENTIAL = 'confidential'

Create the service with Azure Confidential Compute.

DEFAULT = 'default'

Create the service with the default compute.

class azure.mgmt.search.models.CreatedByType(*values)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.search.models.DataPlaneAadOrApiKeyAuthOption(*, aad_auth_failure_mode: str | _models.AadAuthFailureMode | None = None, **kwargs: Any)[source]

Bases: Model

Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.

Variables:

aad_auth_failure_mode (str or AadAuthFailureMode) – Describes what response the data plane API of a search service would send for requests that failed authentication. Known values are: “http403” and “http401WithBearerChallenge”.

Keyword Arguments:

aad_auth_failure_mode (str or AadAuthFailureMode) – Describes what response the data plane API of a search service would send for requests that failed authentication. Known values are: “http403” and “http401WithBearerChallenge”.

class azure.mgmt.search.models.DataPlaneAuthOptions(*, api_key_only: MutableMapping[str, Any] | None = None, aad_or_api_key: _models.DataPlaneAadOrApiKeyAuthOption | None = None, **kwargs: Any)[source]

Bases: Model

Defines the options for how the search service authenticates a data plane request. This cannot be set if ‘disableLocalAuth’ is set to true.

Variables:

  • api_key_only (JSON) – Indicates that only the API key can be used for authentication.

  • aad_or_api_key (DataPlaneAadOrApiKeyAuthOption) – Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.

Keyword Arguments:

  • api_key_only (JSON) – Indicates that only the API key can be used for authentication.

  • aad_or_api_key (DataPlaneAadOrApiKeyAuthOption) – Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication.

class azure.mgmt.search.models.EncryptionWithCmk(*, enforcement: str | _models.SearchEncryptionWithCmk | None = None, **kwargs: Any)[source]

Bases: Model

Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • enforcement (str or SearchEncryptionWithCmk) – Describes how a search service should enforce compliance if it finds objects that aren’t encrypted with the customer-managed key. Known values are: “Disabled”, “Enabled”, and “Unspecified”.

  • encryption_compliance_status (str or SearchEncryptionComplianceStatus) – Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant. Known values are: “Compliant” and “NonCompliant”.

Keyword Arguments:

enforcement (str or SearchEncryptionWithCmk) – Describes how a search service should enforce compliance if it finds objects that aren’t encrypted with the customer-managed key. Known values are: “Disabled”, “Enabled”, and “Unspecified”.

class azure.mgmt.search.models.FeatureName(*values)[source]

Bases: str, Enum

The name of the feature offered in this region.

AVAILABILITY_ZONES = 'AvailabilityZones'

Supports Availability Zones feature.

DOCUMENT_INTELLIGENCE = 'DocumentIntelligence'

Supports Document Intelligence feature.

GROK = 'Grok'

Supports Grok feature.

IMAGE_VECTORIZATION = 'ImageVectorization'

Supports Image Vectorization feature.

MEGA_STORE = 'MegaStore'

Supports Mega Store feature.

QUERY_REWRITE = 'QueryRewrite'

Supports Query Rewrite feature.

S3 = 'S3'

Supports S3 feature.

Supports Semantic Search feature.

STORAGE_OPTIMIZED = 'StorageOptimized'

Supports Storage Optimized feature.

class azure.mgmt.search.models.FeatureOffering(*, name: str | _models.FeatureName | None = None, **kwargs: Any)[source]

Bases: Model

FeatureOffering.

Variables:

name (str or FeatureName) – The name of the feature offered in this region. Known values are: “Grok”, “ImageVectorization”, “DocumentIntelligence”, “QueryRewrite”, “S3”, “StorageOptimized”, “SemanticSearch”, “MegaStore”, and “AvailabilityZones”.

Keyword Arguments:

name (str or FeatureName) – The name of the feature offered in this region. Known values are: “Grok”, “ImageVectorization”, “DocumentIntelligence”, “QueryRewrite”, “S3”, “StorageOptimized”, “SemanticSearch”, “MegaStore”, and “AvailabilityZones”.

class azure.mgmt.search.models.HostingMode(*values)[source]

Bases: str, Enum

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’.

DEFAULT = 'default'

The limit on number of indexes is determined by the default limits for the SKU.

HIGH_DENSITY = 'highDensity'

Only application for standard3 SKU, where the search service can have up to 1000 indexes.

class azure.mgmt.search.models.Identity(*, type: str | _models.IdentityType, user_assigned_identities: Dict[str, _models.UserAssignedManagedIdentity] | None = None, **kwargs: Any)[source]

Bases: Model

Details about the search service identity. A null value indicates that the search service has no identity assigned.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • principal_id (str) – The principal ID of the system-assigned identity of the search service.

  • tenant_id (str) – The tenant ID of the system-assigned identity of the search service.

  • type (str or IdentityType) – The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an identity created by the system and a set of user assigned identities. The type ‘None’ will remove all identities from the service. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.

  • user_assigned_identities (dict[str, UserAssignedManagedIdentity]) – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. # pylint: disable=line-too-long

Keyword Arguments:

  • type (str or IdentityType) – The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an identity created by the system and a set of user assigned identities. The type ‘None’ will remove all identities from the service. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned, UserAssigned”.

  • user_assigned_identities (dict[str, UserAssignedManagedIdentity]) – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. # pylint: disable=line-too-long

class azure.mgmt.search.models.IdentityType(*values)[source]

Bases: str, Enum

The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an identity created by the system and a set of user assigned identities. The type ‘None’ will remove all identities from the service.

NONE = 'None'

Indicates that any identity associated with the search service needs to be removed.

SYSTEM_ASSIGNED = 'SystemAssigned'

Indicates that system-assigned identity for the search service will be enabled.

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'

Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities.

USER_ASSIGNED = 'UserAssigned'

Indicates that one or more user assigned identities will be assigned to the search service.

class azure.mgmt.search.models.IpRule(*, value: str | None = None, **kwargs: Any)[source]

Bases: Model

The IP restriction rule of the Azure AI Search service.

Variables:

value (str) – Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.

Keyword Arguments:

value (str) – Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed.

class azure.mgmt.search.models.ListQueryKeysResult(**kwargs: Any)[source]

Bases: Model

Response containing the query API keys for a given Azure AI Search service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[QueryKey]) – The query keys for the Azure AI Search service.

  • next_link (str) – Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size.

class azure.mgmt.search.models.NSPConfigAccessRule(*, name: str | None = None, properties: _models.NSPConfigAccessRuleProperties | None = None, **kwargs: Any)[source]

Bases: Model

An access rule for a network security perimeter configuration.

Variables:
Keyword Arguments:
class azure.mgmt.search.models.NSPConfigAccessRuleProperties(*, direction: str | None = None, address_prefixes: List[str] | None = None, fully_qualified_domain_names: List[str] | None = None, subscriptions: List[str] | None = None, network_security_perimeters: List[_models.NSPConfigNetworkSecurityPerimeterRule] | None = None, **kwargs: Any)[source]

Bases: Model

The properties for the access rules in a network security perimeter configuration.

Variables:
Keyword Arguments:
class azure.mgmt.search.models.NSPConfigAssociation(*, name: str | None = None, access_mode: str | None = None, **kwargs: Any)[source]

Bases: Model

The resource association for the network security perimeter.

Variables:

  • name (str)

  • access_mode (str)

Keyword Arguments:

  • name (str)

  • access_mode (str)

class azure.mgmt.search.models.NSPConfigNetworkSecurityPerimeterRule(*, id: str | None = None, perimeter_guid: str | None = None, location: str | None = None, **kwargs: Any)[source]

Bases: Model

The network security perimeter properties present in a configuration rule.

Variables:

  • id (str)

  • perimeter_guid (str)

  • location (str)

Keyword Arguments:

  • id (str)

  • perimeter_guid (str)

  • location (str)

class azure.mgmt.search.models.NSPConfigPerimeter(*, id: str | None = None, perimeter_guid: str | None = None, location: str | None = None, **kwargs: Any)[source]

Bases: Model

The perimeter for a network security perimeter configuration.

Variables:

  • id (str)

  • perimeter_guid (str)

  • location (str)

Keyword Arguments:

  • id (str)

  • perimeter_guid (str)

  • location (str)

class azure.mgmt.search.models.NSPConfigProfile(*, name: str | None = None, access_rules_version: str | None = None, access_rules: List[_models.NSPConfigAccessRule] | None = None, **kwargs: Any)[source]

Bases: Model

The profile for a network security perimeter configuration.

Variables:
Keyword Arguments:
class azure.mgmt.search.models.NSPProvisioningIssue(*, name: str | None = None, properties: _models.NSPProvisioningIssueProperties | None = None, **kwargs: Any)[source]

Bases: Model

An object to describe any issues with provisioning network security perimeters to a search service.

Variables:

  • name (str)

  • properties (NSPProvisioningIssueProperties) – The properties to describe any issues with provisioning network security perimeters to a search service.

Keyword Arguments:

  • name (str)

  • properties (NSPProvisioningIssueProperties) – The properties to describe any issues with provisioning network security perimeters to a search service.

class azure.mgmt.search.models.NSPProvisioningIssueProperties(*, issue_type: str | None = None, severity: str | None = None, description: str | None = None, suggested_resource_ids: List[str] | None = None, suggested_access_rules: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

The properties to describe any issues with provisioning network security perimeters to a search service.

Variables:

  • issue_type (str)

  • severity (str)

  • description (str)

  • suggested_resource_ids (list[str])

  • suggested_access_rules (list[str])

Keyword Arguments:

  • issue_type (str)

  • severity (str)

  • description (str)

  • suggested_resource_ids (list[str])

  • suggested_access_rules (list[str])

class azure.mgmt.search.models.NetworkRuleSet(*, ip_rules: List[_models.IpRule] | None = None, bypass: str | _models.SearchBypass | None = None, **kwargs: Any)[source]

Bases: Model

Network specific rules that determine how the Azure AI Search service may be reached.

Variables:

  • ip_rules (list[IpRule]) – A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the ‘publicNetworkAccess’ of the search service is ‘enabled’; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method.

  • bypass (str or SearchBypass) – Possible origins of inbound traffic that can bypass the rules defined in the ‘ipRules’ section. Known values are: “None”, “AzurePortal”, and “AzureServices”.

Keyword Arguments:

  • ip_rules (list[IpRule]) – A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the ‘publicNetworkAccess’ of the search service is ‘enabled’; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method.

  • bypass (str or SearchBypass) – Possible origins of inbound traffic that can bypass the rules defined in the ‘ipRules’ section. Known values are: “None”, “AzurePortal”, and “AzureServices”.

class azure.mgmt.search.models.NetworkSecurityPerimeterConfiguration(*, network_security_perimeter: _models.NSPConfigPerimeter | None = None, resource_association: _models.NSPConfigAssociation | None = None, profile: _models.NSPConfigProfile | None = None, provisioning_issues: List[_models.NSPProvisioningIssue] | None = None, **kwargs: Any)[source]

Bases: ProxyResource

Network security perimeter configuration for a server.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • provisioning_state (str)

  • network_security_perimeter (NSPConfigPerimeter) – The perimeter for a network security perimeter configuration.

  • resource_association (NSPConfigAssociation) – The resource association for the network security perimeter.

  • profile (NSPConfigProfile) – The profile for a network security perimeter configuration.

  • provisioning_issues (list[NSPProvisioningIssue])

Keyword Arguments:
class azure.mgmt.search.models.NetworkSecurityPerimeterConfigurationListResult(**kwargs: Any)[source]

Bases: Model

A list of network security perimeter configurations for a server.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
class azure.mgmt.search.models.OfferingsByRegion(*, region_name: str | None = None, features: List[_models.FeatureOffering] | None = None, skus: List[_models.SkuOffering] | None = None, **kwargs: Any)[source]

Bases: Model

OfferingsByRegion.

Variables:

  • region_name (str) – The name of the region.

  • features (list[FeatureOffering]) – The list of features offered in this region.

  • skus (list[SkuOffering]) – The list of SKUs offered in this region.

Keyword Arguments:

  • region_name (str) – The name of the region.

  • features (list[FeatureOffering]) – The list of features offered in this region.

  • skus (list[SkuOffering]) – The list of SKUs offered in this region.

class azure.mgmt.search.models.OfferingsListResult(*, value: List[_models.OfferingsByRegion] | None = None, **kwargs: Any)[source]

Bases: Model

The response containing a list of features and SKUs offered in various regions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[OfferingsByRegion]) – The list of regions with their respective features and SKUs offered.

  • next_link (str) – The URL to get the next set of offerings, if any.

Keyword Arguments:

value (list[OfferingsByRegion]) – The list of regions with their respective features and SKUs offered.

class azure.mgmt.search.models.Operation(**kwargs: Any)[source]

Bases: Model

Describes a REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The name of the operation. This name is of the form {provider}/{resource}/{operation}.

  • display (OperationDisplay) – The object that describes the operation.

  • is_data_action (bool) – Describes if the specified operation is a data plane API operation. Operations where this value is not true are supported directly by the resource provider.

  • origin (str) – Describes which originating entities are allowed to invoke this operation.

  • properties (OperationProperties) – Describes additional properties for this operation.

class azure.mgmt.search.models.OperationAvailability(**kwargs: Any)[source]

Bases: Model

Describes a particular availability for the metric specification.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • time_grain (str) – The time grain for the dimension.

  • blob_duration (str) – The blob duration for the dimension.

class azure.mgmt.search.models.OperationDisplay(**kwargs: Any)[source]

Bases: Model

The object that describes the operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • provider (str) – The friendly name of the resource provider.

  • operation (str) – The operation type: read, write, delete, listKeys/action, etc.

  • resource (str) – The resource type on which the operation is performed.

  • description (str) – The friendly name of the operation.

class azure.mgmt.search.models.OperationListResult(**kwargs: Any)[source]

Bases: Model

The result of the request to list REST API operations. It contains a list of operations and a URL to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[Operation]) – The list of operations by Azure AI Search, some supported by the resource provider and others by data plane APIs.

  • next_link (str) – The URL to get the next set of operation list results, if any.

class azure.mgmt.search.models.OperationLogsSpecification(**kwargs: Any)[source]

Bases: Model

Specifications of one type of log for this operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The name of the log specification.

  • display_name (str) – The display name of the log specification.

  • blob_duration (str) – The blob duration for the log specification.

class azure.mgmt.search.models.OperationMetricDimension(**kwargs: Any)[source]

Bases: Model

Describes a particular dimension for the metric specification.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The name of the dimension.

  • display_name (str) – The display name of the dimension.

class azure.mgmt.search.models.OperationMetricsSpecification(**kwargs: Any)[source]

Bases: Model

Specifications of one type of metric for this operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The name of the metric specification.

  • display_name (str) – The display name of the metric specification.

  • display_description (str) – The display description of the metric specification.

  • unit (str) – The unit for the metric specification.

  • aggregation_type (str) – The type of aggregation for the metric specification.

  • dimensions (list[OperationMetricDimension]) – Dimensions for the metric specification.

  • availabilities (list[OperationAvailability]) – Availabilities for the metric specification.

class azure.mgmt.search.models.OperationProperties(**kwargs: Any)[source]

Bases: Model

Describes additional properties for this operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

service_specification (OperationServiceSpecification) – Specifications of the service for this operation.

class azure.mgmt.search.models.OperationServiceSpecification(**kwargs: Any)[source]

Bases: Model

Specifications of the service for this operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
class azure.mgmt.search.models.PrivateEndpointConnection(*, properties: _models.PrivateEndpointConnectionProperties | None = None, **kwargs: Any)[source]

Bases: Resource

Describes an existing private endpoint connection to the Azure AI Search service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • properties (PrivateEndpointConnectionProperties) – Describes the properties of an existing private endpoint connection to the Azure AI Search service.

Keyword Arguments:

properties (PrivateEndpointConnectionProperties) – Describes the properties of an existing private endpoint connection to the Azure AI Search service.

class azure.mgmt.search.models.PrivateEndpointConnectionListResult(**kwargs: Any)[source]

Bases: Model

Response containing a list of private endpoint connections.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[PrivateEndpointConnection]) – The list of private endpoint connections.

  • next_link (str) – Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size.

class azure.mgmt.search.models.PrivateEndpointConnectionProperties(*, private_endpoint: _models.PrivateEndpointConnectionPropertiesPrivateEndpoint | None = None, private_link_service_connection_state: _models.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState | None = None, group_id: str | None = None, provisioning_state: str | _models.PrivateLinkServiceConnectionProvisioningState | None = None, **kwargs: Any)[source]

Bases: Model

Describes the properties of an existing private endpoint connection to the search service.

Variables:
Keyword Arguments:
class azure.mgmt.search.models.PrivateEndpointConnectionPropertiesPrivateEndpoint(*, id: str | None = None, **kwargs: Any)[source]

Bases: Model

The private endpoint resource from Microsoft.Network provider.

Variables:

id (str) – The resource ID of the private endpoint resource from Microsoft.Network provider.

Keyword Arguments:

id (str) – The resource ID of the private endpoint resource from Microsoft.Network provider.

class azure.mgmt.search.models.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState(*, status: str | _models.PrivateLinkServiceConnectionStatus | None = None, description: str | None = None, actions_required: str = 'None', **kwargs: Any)[source]

Bases: Model

Describes the current state of an existing Azure Private Link service connection to the private endpoint.

Variables:

  • status (str or PrivateLinkServiceConnectionStatus) – Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • description (str) – The description for the private link service connection state.

  • actions_required (str) – A description of any extra actions that may be required.

Keyword Arguments:

  • status (str or PrivateLinkServiceConnectionStatus) – Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • description (str) – The description for the private link service connection state.

  • actions_required (str) – A description of any extra actions that may be required.

class azure.mgmt.search.models.PrivateLinkResource(**kwargs: Any)[source]

Bases: Resource

Describes a supported private link resource for the Azure AI Search service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • properties (PrivateLinkResourceProperties) – Describes the properties of a supported private link resource for the Azure AI Search service.

class azure.mgmt.search.models.PrivateLinkResourceProperties(**kwargs: Any)[source]

Bases: Model

Describes the properties of a supported private link resource for the Azure AI Search service. For a given API version, this represents the ‘supported’ groupIds when creating a shared private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • group_id (str) – The group ID of the private link resource.

  • required_members (list[str]) – The list of required members of the private link resource.

  • required_zone_names (list[str]) – The list of required DNS zone names of the private link resource.

  • shareable_private_link_resource_types (list[ShareablePrivateLinkResourceType]) – The list of resources that are onboarded to private link service, that are supported by Azure AI Search.

class azure.mgmt.search.models.PrivateLinkResourcesResult(**kwargs: Any)[source]

Bases: Model

Response containing a list of supported Private Link Resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

value (list[PrivateLinkResource]) – The list of supported Private Link Resources.

class azure.mgmt.search.models.PrivateLinkServiceConnectionProvisioningState(*values)[source]

Bases: str, Enum

The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.

CANCELED = 'Canceled'

Provisioning request for the private link service connection resource has been canceled.

DELETING = 'Deleting'

The private link service connection is in the process of being deleted.

FAILED = 'Failed'

The private link service connection has failed to be provisioned or deleted.

INCOMPLETE = 'Incomplete'

Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet.

SUCCEEDED = 'Succeeded'

The private link service connection has finished provisioning and is ready for approval.

UPDATING = 'Updating'

The private link service connection is in the process of being created along with other resources for it to be fully functional.

class azure.mgmt.search.models.PrivateLinkServiceConnectionStatus(*values)[source]

Bases: str, Enum

Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.

APPROVED = 'Approved'

The private endpoint connection is approved and is ready for use.

DISCONNECTED = 'Disconnected'

The private endpoint connection has been removed from the service.

PENDING = 'Pending'

The private endpoint connection has been created and is pending approval.

REJECTED = 'Rejected'

The private endpoint connection has been rejected and cannot be used.

class azure.mgmt.search.models.ProvisioningState(*values)[source]

Bases: str, Enum

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.

FAILED = 'Failed'

The last provisioning operation has failed.

PROVISIONING = 'Provisioning'

The search service is being provisioned or scaled up or down.

SUCCEEDED = 'Succeeded'

The last provisioning operation has completed successfully.

class azure.mgmt.search.models.ProxyResource(**kwargs: Any)[source]

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.search.models.PublicNetworkAccess(*values)[source]

Bases: str, Enum

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.

DISABLED = 'disabled'

The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections.

ENABLED = 'enabled'

The search service is accessible from traffic originating from the public internet.

class azure.mgmt.search.models.QueryKey(**kwargs: Any)[source]

Bases: Model

Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The name of the query API key. Query names are optional, but assigning a name can help you remember how it’s used.

  • key (str) – The value of the query API key.

class azure.mgmt.search.models.QuotaUsageResult(*, id: str | None = None, unit: str | None = None, current_value: int | None = None, limit: int | None = None, **kwargs: Any)[source]

Bases: Model

Describes the quota usage for a particular SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – The resource ID of the quota usage SKU endpoint for Microsoft.Search provider.

  • unit (str) – The unit of measurement for the search SKU.

  • current_value (int) – The currently used up value for the particular search SKU.

  • limit (int) – The quota limit for the particular search SKU.

  • name (QuotaUsageResultName) – The name of the SKU supported by Azure AI Search.

Keyword Arguments:

  • id (str) – The resource ID of the quota usage SKU endpoint for Microsoft.Search provider.

  • unit (str) – The unit of measurement for the search SKU.

  • current_value (int) – The currently used up value for the particular search SKU.

  • limit (int) – The quota limit for the particular search SKU.

class azure.mgmt.search.models.QuotaUsageResultName(*, value: str | None = None, localized_value: str | None = None, **kwargs: Any)[source]

Bases: Model

The name of the SKU supported by Azure AI Search.

Variables:

  • value (str) – The SKU name supported by Azure AI Search.

  • localized_value (str) – The localized string value for the SKU name.

Keyword Arguments:

  • value (str) – The SKU name supported by Azure AI Search.

  • localized_value (str) – The localized string value for the SKU name.

class azure.mgmt.search.models.QuotaUsagesListResult(**kwargs: Any)[source]

Bases: Model

Response containing the quota usage information for all the supported SKUs of Azure AI Search.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[QuotaUsageResult]) – The quota usages for the SKUs supported by Azure AI Search.

  • next_link (str) – Request URL that can be used to query next page of quota usages. Returned when the total number of requested quota usages exceed maximum page size.

class azure.mgmt.search.models.Resource(**kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.search.models.SearchBypass(*values)[source]

Bases: str, Enum

Possible origins of inbound traffic that can bypass the rules defined in the ‘ipRules’ section.

AZURE_PORTAL = 'AzurePortal'

Indicates that requests originating from the Azure portal can bypass the rules defined in the ‘ipRules’ section.

AZURE_SERVICES = 'AzureServices'

Indicates that requests originating from Azure trusted services can bypass the rules defined in the ‘ipRules’ section.

NONE = 'None'

Indicates that no origin can bypass the rules defined in the ‘ipRules’ section. This is the default.

class azure.mgmt.search.models.SearchDisabledDataExfiltrationOption(*values)[source]

Bases: str, Enum

A specific data exfiltration scenario that is disabled for the service.

ALL = 'All'

Indicates that all data exfiltration scenarios are disabled.

class azure.mgmt.search.models.SearchEncryptionComplianceStatus(*values)[source]

Bases: str, Enum

Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant.

COMPLIANT = 'Compliant'

Indicates that the search service is compliant, either because the number of non-CMK-encrypted objects is zero or enforcement is disabled.

NON_COMPLIANT = 'NonCompliant'

Indicates that the search service has more than one non-CMK-encrypted objects.

class azure.mgmt.search.models.SearchEncryptionWithCmk(*values)[source]

Bases: str, Enum

Describes how a search service should enforce compliance if it finds objects that aren’t encrypted with the customer-managed key.

DISABLED = 'Disabled'

No enforcement of customer-managed key encryption will be made. Only the built-in service-managed encryption is used.

ENABLED = 'Enabled'

Search service will be marked as non-compliant if one or more objects aren’t encrypted with a customer-managed key.

UNSPECIFIED = 'Unspecified'

Enforcement policy is not explicitly specified, with the behavior being the same as if it were set to ‘Disabled’.

class azure.mgmt.search.models.SearchManagementRequestOptions(*, client_request_id: str | None = None, **kwargs: Any)[source]

Bases: Model

Parameter group.

Variables:

client_request_id (str) – A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

Keyword Arguments:

client_request_id (str) – A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.

class azure.mgmt.search.models.SearchSemanticSearch(*values)[source]

Bases: str, Enum

Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.

DISABLED = 'disabled'

Indicates that semantic reranker is disabled for the search service. This is the default.

FREE = 'free'

Enables semantic reranker on a search service and indicates that it is to be used within the limits of the free plan. The free plan would cap the volume of semantic ranking requests and is offered at no extra charge. This is the default for newly provisioned search services.

STANDARD = 'standard'

Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries.

class azure.mgmt.search.models.SearchService(*, location: str, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, identity: _models.Identity | None = None, replica_count: int = 1, partition_count: int = 1, endpoint: str | None = None, hosting_mode: str | _models.HostingMode = 'default', compute_type: str | _models.ComputeType | None = None, public_network_access: str | _models.PublicNetworkAccess = 'enabled', network_rule_set: _models.NetworkRuleSet | None = None, disabled_data_exfiltration_options: List[str | _models.SearchDisabledDataExfiltrationOption] | 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)[source]

Bases: TrackedResource

Describes an Azure AI Search service and its current state.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • sku (Sku) – The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.

  • identity (Identity) – The identity of the resource.

  • system_data (SystemData) – Azure Resource Manager metadata of the search service containing createdBy and modifiedBy information.

  • replica_count (int) – 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.

  • partition_count (int) – 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.

  • endpoint (str) – The endpoint of the Azure AI Search service.

  • hosting_mode (str or HostingMode) – 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”.

  • compute_type (str or ComputeType) – Configure this property to support the search service using either the default compute or Azure Confidential Compute. Known values are: “default” and “confidential”.

  • public_network_access (str or PublicNetworkAccess) – 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”.

  • status (str or 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. Known values are: “running”, “provisioning”, “deleting”, “degraded”, “disabled”, “error”, and “stopped”.

  • status_details (str) – The details of the search service status.

  • provisioning_state (str or ProvisioningState) – 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”.

  • network_rule_set (NetworkRuleSet) – Network specific rules that determine how the Azure AI Search service may be reached.

  • disabled_data_exfiltration_options (list[str or 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.

  • encryption_with_cmk (EncryptionWithCmk) – Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.

  • disable_local_auth (bool) – 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.

  • auth_options (DataPlaneAuthOptions) – 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.

  • semantic_search (str or SearchSemanticSearch) – Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. Known values are: “disabled”, “free”, and “standard”.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – The list of private endpoint connections to the Azure AI Search service.

  • shared_private_link_resources (list[SharedPrivateLinkResource]) – The list of shared private link resources managed by the Azure AI Search service.

  • e_tag (str) – A system generated property representing the service’s etag that can be for optimistic concurrency control during updates.

  • upgrade_available (bool) – Indicates whether or not the search service has an upgrade available.

  • service_upgrade_date (datetime) – The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • sku (Sku) – The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.

  • identity (Identity) – The identity of the resource.

  • replica_count (int) – 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.

  • partition_count (int) – 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.

  • endpoint (str) – The endpoint of the Azure AI Search service.

  • hosting_mode (str or HostingMode) – 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”.

  • compute_type (str or ComputeType) – Configure this property to support the search service using either the default compute or Azure Confidential Compute. Known values are: “default” and “confidential”.

  • public_network_access (str or PublicNetworkAccess) – 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”.

  • network_rule_set (NetworkRuleSet) – Network specific rules that determine how the Azure AI Search service may be reached.

  • disabled_data_exfiltration_options (list[str or 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.

  • encryption_with_cmk (EncryptionWithCmk) – Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.

  • disable_local_auth (bool) – 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.

  • auth_options (DataPlaneAuthOptions) – 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.

  • semantic_search (str or SearchSemanticSearch) – Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. Known values are: “disabled”, “free”, and “standard”.

class azure.mgmt.search.models.SearchServiceListResult(**kwargs: Any)[source]

Bases: Model

Response containing a list of Azure AI Search services.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[SearchService]) – The list of search services.

  • next_link (str) – Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size.

class azure.mgmt.search.models.SearchServiceStatus(*values)[source]

Bases: str, Enum

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.

DEGRADED = 'degraded'

The search service is degraded because underlying search units are not healthy.

DELETING = 'deleting'

The search service is being deleted.

DISABLED = 'disabled'

The search service is disabled and all API requests will be rejected.

ERROR = 'error'

The search service is in error state, indicating either a failure to provision or to be deleted.

PROVISIONING = 'provisioning'

The search service is being provisioned or scaled up or down.

RUNNING = 'running'

The search service is running and no provisioning operations are underway.

STOPPED = 'stopped'

The search service is in a subscription that’s disabled.

class azure.mgmt.search.models.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, endpoint: str | None = None, hosting_mode: str | _models.HostingMode = 'default', compute_type: str | _models.ComputeType | None = None, public_network_access: str | _models.PublicNetworkAccess = 'enabled', network_rule_set: _models.NetworkRuleSet | None = None, disabled_data_exfiltration_options: List[str | _models.SearchDisabledDataExfiltrationOption] | 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)[source]

Bases: Resource

The parameters used to update an Azure AI Search service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • sku (Sku) – The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.

  • location (str) – 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.

  • tags (dict[str, str]) – Tags to help categorize the resource in the Azure portal.

  • identity (Identity) – Details about the search service identity. A null value indicates that the search service has no identity assigned.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • replica_count (int) – 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.

  • partition_count (int) – 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.

  • endpoint (str) – The endpoint of the Azure AI Search service.

  • hosting_mode (str or HostingMode) – 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”.

  • compute_type (str or ComputeType) – Configure this property to support the search service using either the default compute or Azure Confidential Compute. Known values are: “default” and “confidential”.

  • public_network_access (str or PublicNetworkAccess) – 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”.

  • status (str or 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. Known values are: “running”, “provisioning”, “deleting”, “degraded”, “disabled”, “error”, and “stopped”.

  • status_details (str) – The details of the search service status.

  • provisioning_state (str or ProvisioningState) – 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”.

  • network_rule_set (NetworkRuleSet) – Network specific rules that determine how the Azure AI Search service may be reached.

  • disabled_data_exfiltration_options (list[str or 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.

  • encryption_with_cmk (EncryptionWithCmk) – Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.

  • disable_local_auth (bool) – 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.

  • auth_options (DataPlaneAuthOptions) – 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.

  • semantic_search (str or SearchSemanticSearch) – Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. Known values are: “disabled”, “free”, and “standard”.

  • private_endpoint_connections (list[PrivateEndpointConnection]) – The list of private endpoint connections to the Azure AI Search service.

  • shared_private_link_resources (list[SharedPrivateLinkResource]) – The list of shared private link resources managed by the Azure AI Search service.

  • e_tag (str) – A system generated property representing the service’s etag that can be for optimistic concurrency control during updates.

  • upgrade_available (bool) – Indicates whether or not the search service has an upgrade available.

  • service_upgrade_date (datetime) – The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time.

Keyword Arguments:

  • sku (Sku) – The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service.

  • location (str) – 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.

  • tags (dict[str, str]) – Tags to help categorize the resource in the Azure portal.

  • identity (Identity) – Details about the search service identity. A null value indicates that the search service has no identity assigned.

  • replica_count (int) – 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.

  • partition_count (int) – 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.

  • endpoint (str) – The endpoint of the Azure AI Search service.

  • hosting_mode (str or HostingMode) – 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”.

  • compute_type (str or ComputeType) – Configure this property to support the search service using either the default compute or Azure Confidential Compute. Known values are: “default” and “confidential”.

  • public_network_access (str or PublicNetworkAccess) – 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”.

  • network_rule_set (NetworkRuleSet) – Network specific rules that determine how the Azure AI Search service may be reached.

  • disabled_data_exfiltration_options (list[str or 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.

  • encryption_with_cmk (EncryptionWithCmk) – Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service.

  • disable_local_auth (bool) – 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.

  • auth_options (DataPlaneAuthOptions) – 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.

  • semantic_search (str or SearchSemanticSearch) – Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. Known values are: “disabled”, “free”, and “standard”.

class azure.mgmt.search.models.ShareablePrivateLinkResourceProperties(**kwargs: Any)[source]

Bases: Model

Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • type (str) – The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search.

  • group_id (str) – The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search.

  • description (str) – The description of the resource type that has been onboarded to private link service, supported by Azure AI Search.

class azure.mgmt.search.models.ShareablePrivateLinkResourceType(**kwargs: Any)[source]

Bases: Model

Describes an resource type that has been onboarded to private link service, supported by Azure AI Search.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • name (str) – The name of the resource type that has been onboarded to private link service, supported by Azure AI Search.

  • properties (ShareablePrivateLinkResourceProperties) – Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.

class azure.mgmt.search.models.SharedPrivateLinkResource(*, properties: _models.SharedPrivateLinkResourceProperties | None = None, **kwargs: Any)[source]

Bases: Resource

Describes a shared private link resource managed by the Azure AI Search service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • properties (SharedPrivateLinkResourceProperties) – Describes the properties of a shared private link resource managed by the Azure AI Search service.

Keyword Arguments:

properties (SharedPrivateLinkResourceProperties) – Describes the properties of a shared private link resource managed by the Azure AI Search service.

class azure.mgmt.search.models.SharedPrivateLinkResourceAsyncOperationResult(*values)[source]

Bases: str, Enum

The current status of the long running asynchronous shared private link resource operation.

FAILED = 'Failed'
RUNNING = 'Running'
SUCCEEDED = 'Succeeded'
class azure.mgmt.search.models.SharedPrivateLinkResourceListResult(*, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Response containing a list of shared private link resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • value (list[SharedPrivateLinkResource]) – The list of shared private link resources.

  • next_link (str) – The URL to get the next set of shared private link resources, if there are any.

Keyword Arguments:

next_link (str) – The URL to get the next set of shared private link resources, if there are any.

class azure.mgmt.search.models.SharedPrivateLinkResourceProperties(*, private_link_resource_id: str | None = None, group_id: str | None = None, request_message: str | None = None, resource_region: str | None = None, status: str | _models.SharedPrivateLinkResourceStatus | None = None, provisioning_state: str | _models.SharedPrivateLinkResourceProvisioningState | None = None, **kwargs: Any)[source]

Bases: Model

Describes the properties of an existing shared private link resource managed by the Azure AI Search service.

Variables:

  • private_link_resource_id (str) – The resource ID of the resource the shared private link resource is for.

  • group_id (str) – The group ID from the provider of resource the shared private link resource is for.

  • request_message (str) – The message for requesting approval of the shared private link resource.

  • resource_region (str) – Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).

  • status (str or SharedPrivateLinkResourceStatus) – Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • provisioning_state (str or SharedPrivateLinkResourceProvisioningState) – The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: “Updating”, “Deleting”, “Failed”, “Succeeded”, and “Incomplete”.

Keyword Arguments:

  • private_link_resource_id (str) – The resource ID of the resource the shared private link resource is for.

  • group_id (str) – The group ID from the provider of resource the shared private link resource is for.

  • request_message (str) – The message for requesting approval of the shared private link resource.

  • resource_region (str) – Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service).

  • status (str or SharedPrivateLinkResourceStatus) – Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.

  • provisioning_state (str or SharedPrivateLinkResourceProvisioningState) – The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: “Updating”, “Deleting”, “Failed”, “Succeeded”, and “Incomplete”.

class azure.mgmt.search.models.SharedPrivateLinkResourceProvisioningState(*values)[source]

Bases: str, Enum

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.

DELETING = 'Deleting'

The shared private link resource is in the process of being deleted.

FAILED = 'Failed'

The shared private link resource has failed to be provisioned or deleted.

INCOMPLETE = 'Incomplete'

Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet.

SUCCEEDED = 'Succeeded'

The shared private link resource has finished provisioning and is ready for approval.

UPDATING = 'Updating'

The shared private link resource is in the process of being created along with other resources for it to be fully functional.

class azure.mgmt.search.models.SharedPrivateLinkResourceStatus(*values)[source]

Bases: str, Enum

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.

APPROVED = 'Approved'

The shared private link resource is approved and is ready for use.

DISCONNECTED = 'Disconnected'

The shared private link resource has been removed from the service.

PENDING = 'Pending'

The shared private link resource has been created and is pending approval.

REJECTED = 'Rejected'

The shared private link resource has been rejected and cannot be used.

class azure.mgmt.search.models.Sku(*, name: str | _models.SkuName | None = None, **kwargs: Any)[source]

Bases: Model

Defines the SKU of a search service, which determines billing rate and capacity limits.

Variables:

name (str or SkuName) – The SKU of the search service. Valid values include: ‘free’: Shared service. ‘basic’: Dedicated service with up to 3 replicas. ‘standard’: Dedicated service with up to 12 partitions and 12 replicas. ‘standard2’: Similar to standard, but with more capacity per search unit. ‘standard3’: The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to ‘highDensity’). ‘storage_optimized_l1’: Supports 1TB per partition, up to 12 partitions. ‘storage_optimized_l2’: Supports 2TB per partition, up to 12 partitions.’. Known values are: “free”, “basic”, “standard”, “standard2”, “standard3”, “storage_optimized_l1”, and “storage_optimized_l2”.

Keyword Arguments:

name (str or SkuName) – The SKU of the search service. Valid values include: ‘free’: Shared service. ‘basic’: Dedicated service with up to 3 replicas. ‘standard’: Dedicated service with up to 12 partitions and 12 replicas. ‘standard2’: Similar to standard, but with more capacity per search unit. ‘standard3’: The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to ‘highDensity’). ‘storage_optimized_l1’: Supports 1TB per partition, up to 12 partitions. ‘storage_optimized_l2’: Supports 2TB per partition, up to 12 partitions.’. Known values are: “free”, “basic”, “standard”, “standard2”, “standard3”, “storage_optimized_l1”, and “storage_optimized_l2”.

class azure.mgmt.search.models.SkuName(*values)[source]

Bases: str, Enum

The SKU of the search service. Valid values include: ‘free’: Shared service. ‘basic’: Dedicated service with up to 3 replicas. ‘standard’: Dedicated service with up to 12 partitions and 12 replicas. ‘standard2’: Similar to standard, but with more capacity per search unit. ‘standard3’: The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to ‘highDensity’). ‘storage_optimized_l1’: Supports 1TB per partition, up to 12 partitions. ‘storage_optimized_l2’: Supports 2TB per partition, up to 12 partitions.’.

BASIC = 'basic'

Billable tier for a dedicated service having up to 3 replicas.

FREE = 'free'

Free tier, with no SLA guarantees and a subset of the features offered on billable tiers.

STANDARD = 'standard'

Billable tier for a dedicated service having up to 12 partitions and 12 replicas.

STANDARD2 = 'standard2'

Similar to ‘standard’, but with more capacity per search unit.

STANDARD3 = 'standard3'

The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to ‘highDensity’).

STORAGE_OPTIMIZED_L1 = 'storage_optimized_l1'

Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.

STORAGE_OPTIMIZED_L2 = 'storage_optimized_l2'

Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.

class azure.mgmt.search.models.SkuOffering(*, sku: _models.Sku | None = None, limits: _models.SkuOfferingLimits | None = None, **kwargs: Any)[source]

Bases: Model

SkuOffering.

Variables:

  • sku (Sku) – Defines the SKU of a search service, which determines billing rate and capacity limits.

  • limits (SkuOfferingLimits) – The limits associated with this SKU offered in this region.

Keyword Arguments:

  • sku (Sku) – Defines the SKU of a search service, which determines billing rate and capacity limits.

  • limits (SkuOfferingLimits) – The limits associated with this SKU offered in this region.

class azure.mgmt.search.models.SkuOfferingLimits(*, indexes: int | None = None, indexers: int | None = None, partition_storage_in_gigabytes: float | None = None, partition_vector_storage_in_gigabytes: float | None = None, search_units: int | None = None, replicas: int | None = None, partitions: int | None = None, **kwargs: Any)[source]

Bases: Model

The limits associated with this SKU offered in this region.

Variables:

  • indexes (int) – The maximum number of indexes available for this SKU.

  • indexers (int) – The maximum number of indexers available for this SKU.

  • partition_storage_in_gigabytes (float) – The maximum storage size in Gigabytes available for this SKU per partition.

  • partition_vector_storage_in_gigabytes (float) – The maximum vector storage size in Gigabytes available for this SKU per partition.

  • search_units (int) – The maximum number of search units available for this SKU.

  • replicas (int) – The maximum number of replicas available for this SKU.

  • partitions (int) – The maximum number of partitions available for this SKU.

Keyword Arguments:

  • indexes (int) – The maximum number of indexes available for this SKU.

  • indexers (int) – The maximum number of indexers available for this SKU.

  • partition_storage_in_gigabytes (float) – The maximum storage size in Gigabytes available for this SKU per partition.

  • partition_vector_storage_in_gigabytes (float) – The maximum vector storage size in Gigabytes available for this SKU per partition.

  • search_units (int) – The maximum number of search units available for this SKU.

  • replicas (int) – The maximum number of replicas available for this SKU.

  • partitions (int) – The maximum number of partitions available for this SKU.

class azure.mgmt.search.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Metadata pertaining to creation and last modification of the resource.

Variables:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments:

  • created_by (str) – The identity that created the resource.

  • created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • created_at (datetime) – The timestamp of resource creation (UTC).

  • last_modified_by (str) – The identity that last modified the resource.

  • last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.

  • last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.search.models.TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Variables:

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long

  • name (str) – The name of the resource.

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

Keyword Arguments:

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.search.models.UnavailableNameReason(*values)[source]

Bases: str, Enum

The reason why the name is not available. ‘Invalid’ indicates the name provided does not match the naming requirements (incorrect length, unsupported characters, etc.). ‘AlreadyExists’ indicates that the name is already in use and is therefore unavailable.

ALREADY_EXISTS = 'AlreadyExists'

The search service name is already assigned to a different search service.

INVALID = 'Invalid'

The search service name doesn’t match naming requirements.

class azure.mgmt.search.models.UserAssignedManagedIdentity(**kwargs: Any)[source]

Bases: Model

The details of the user assigned managed identity assigned to the search service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

  • principal_id (str) – The principal ID of user assigned identity.

  • client_id (str) – The client ID of user assigned identity.