@azure/arm-search package

Access rule in a network security perimeter configuration profile

Properties of Access Rule

Network security perimeter configuration

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

Optional parameters.

Interface representing a AdminKeys operations.

Optional parameters.

Describes the Azure Active Directory application credentials required to access an Azure Key Vault.

Input of check name availability API.

Output of check name availability API.

Contains information about an API error.

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

Abstract base type for data identities.

Clears the identity property.

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

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

Specifies the user assigned identity to use.

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

Describes the availability of a specific feature in a region.

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

The IP restriction rule of the Azure AI Search service.

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

Information about a network security perimeter (NSP)

Network security perimeter (NSP) configuration resource

Network security configuration properties.

Optional parameters.

Optional parameters.

Interface representing a NetworkSecurityPerimeterConfigurations operations.

Optional parameters.

Network security perimeter configuration profile

Describes the Azure AI Search features and SKUs available in a specific Azure region.

Optional parameters.

Response containing the list of offerings available in Azure AI Search, organized by region.

Interface representing a Offerings operations.

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for an operation.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

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

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

The private endpoint resource from Microsoft.Network provider.

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

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a PrivateEndpointConnections operations.

Optional parameters.

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

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.

Optional parameters.

Interface representing a PrivateLinkResources operations.

Describes a provisioning issue for a network security perimeter configuration

Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules

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

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

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a QueryKeys operations.

Describes the quota usage for a particular SKU.

The SKU name information, including its identifier and localized display name.

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

Information about resource association

Optional parameters for the client.

model interface SearchManagementRequestOptions

A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps.

Describes an Azure AI Search service and its current state.

Properties of the search service.

The parameters used to update an Azure AI Search service.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Services operations.

Optional parameters.

Optional parameters.

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

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

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

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a SharedPrivateLinkResources operations.

A simple poller that can be used to poll a long running operation.

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

Describes the limits associated with a SKU offering.

Describes a SKU offering with its limits in a specific region.

Metadata pertaining to creation and last modification of the resource.

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

Optional parameters.

Optional parameters.

Interface representing a Usages operations.

User assigned identity properties

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

Direction of Access Rule
KnownAccessRuleDirection can be used interchangeably with AccessRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound: Applies to inbound network traffic to the secured resources.
Outbound: Applies to outbound network traffic from the secured resources

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

Type of AdminKeyKind

The supported values for cloud setting as a string literal type

Configure this property to support the search service using either the Default Compute or Azure Confidential Compute.
KnownComputeType can be used interchangeably with ComputeType, this enum contains the known values that the service supports.

Known values supported by the service

Default: Create the service with the Default Compute.
Confidential: Create the dedicated service with Azure Confidential Compute.

An interface that describes a page of results.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

Alias for DataIdentityUnion

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

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.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: Indicates that any identity associated with the search service needs to be removed.
SystemAssigned: Indicates that system-assigned identity for the search service will be enabled.
UserAssigned: Indicates that one or more user assigned identities will be assigned to the search service.
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.

Type of issue
KnownIssueType can be used interchangeably with IssueType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown issue type
ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration.
MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules.
MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP.

Specifies the billing plan for agentic retrieval on the Azure AI Search service. This configuration is only available for certain pricing tiers in certain regions.
KnownKnowledgeRetrieval can be used interchangeably with KnowledgeRetrieval, this enum contains the known values that the service supports.

Known values supported by the service

free: Enables knowledge retrieval 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 knowledge retrieval requests and is offered at no extra charge.
standard: Enables knowledge retrieval on a search service as a billable feature after the free quota is exhausted, with higher throughput and volume of knowledge retrieval requests.

Provisioning state of a network security perimeter configuration that is being created or updated.
KnownNetworkSecurityPerimeterConfigurationProvisioningState can be used interchangeably with NetworkSecurityPerimeterConfigurationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.
KnownPrivateLinkServiceConnectionProvisioningState can be used interchangeably with PrivateLinkServiceConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional.
Deleting: The private link service connection is in the process of being deleted.
Failed: The private link service connection has failed to be provisioned or deleted.
Succeeded: The private link service connection has finished provisioning and is ready for approval.
Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet.
Canceled: Provisioning request for the private link service connection resource has been canceled.

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

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.

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.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: The search service is accessible from traffic originating from the public internet.
Disabled: The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections.
SecuredByPerimeter: The network security perimeter configuration rules allow or disallow public network access to the resource. Requires an associated network security perimeter.

Access mode of the resource association
KnownResourceAssociationAccessMode can be used interchangeably with ResourceAssociationAccessMode, this enum contains the known values that the service supports.

Known values supported by the service

Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked
Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked
Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked

Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section.
KnownSearchBypass can be used interchangeably with SearchBypass, this enum contains the known values that the service supports.

Known values supported by the service

None: Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default.
AzurePortal: Indicates that requests originating from the Azure Portal can bypass the rules defined in the 'ipRules' section.
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section.

A specific data exfiltration scenario that is disabled for the service.
KnownSearchDataExfiltrationProtection can be used interchangeably with SearchDataExfiltrationProtection, this enum contains the known values that the service supports.

Known values supported by the service

BlockAll: Indicates that all data exfiltration scenarios are disabled.

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.

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

Specifies the availability and billing plan for semantic search on the Azure AI Search service. This configuration is only available for certain pricing tiers in certain regions.
KnownSearchSemanticSearch can be used interchangeably with SearchSemanticSearch, this enum contains the known values that the service supports.

Known values supported by the service

disabled: Indicates that semantic reranker is disabled for the search service.
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. This is the default.
standard: Enables semantic reranker on a search service as a billable feature after the free quota is exhausted, with higher throughput and volume of semantically reranked queries.

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.

Severity of the issue.
KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports.

Known values supported by the service

Warning
Error

The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete.
KnownSharedPrivateLinkResourceProvisioningState can be used interchangeably with SharedPrivateLinkResourceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Updating: The shared private link resource is in the process of being created along with other resources for it to be fully functional.
Deleting: The shared private link resource is in the process of being deleted.
Failed: The shared private link resource has failed to be provisioned or deleted.
Succeeded: The shared private link resource has finished provisioning and is ready for approval.
Incomplete: Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet.

Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected.
KnownSharedPrivateLinkResourceStatus can be used interchangeably with SharedPrivateLinkResourceStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: The shared private link resource has been created and is pending approval.
Approved: The shared private link resource is approved and is ready for use.
Rejected: The shared private link resource has been rejected and cannot be used.
Disconnected: The shared private link resource has been removed from the service.

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. 'serverless': Serverless tier with auto-scaling capabilities.
KnownSkuName can be used interchangeably with SkuName, this enum contains the known values that the service supports.

Known values supported by the service

free: Free tier, with no SLA guarantees and a subset of the features offered on billable tiers.
basic: Billable tier for a dedicated service having up to 3 replicas.
standard: Billable tier for a dedicated service having 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: Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.
storage_optimized_l2: Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.
serverless: Serverless tier, offering low-touch, consumption-based, and pay-as-you-go experience, with auto-scaling capabilities.

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.
KnownUnavailableNameReason can be used interchangeably with UnavailableNameReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: The search service name doesn't match naming requirements.
AlreadyExists: The search service name is already assigned to a different search service.

Indicates if the dedicated search service has an upgrade available.
KnownUpgradeAvailable can be used interchangeably with UpgradeAvailable, this enum contains the known values that the service supports.

Known values supported by the service

notAvailable: An upgrade is currently not available for the dedicated service.
available: There is an upgrade available for the dedicated service.

An enum to describe Azure Cloud environments.

Direction of Access Rule

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

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

The kind of entity that created the resource.

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.

Type of issue

Specifies the billing plan for agentic retrieval on the Azure AI Search service. This configuration is only available for certain pricing tiers in certain regions.

Provisioning state of a network security perimeter configuration that is being created or updated.

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

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

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.

Access mode of the resource association

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

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

Specifies the availability and billing plan for semantic search on the Azure AI Search service. This configuration is only available for certain pricing tiers in certain regions.

Severity of the issue.

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

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

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. 'serverless': Serverless tier with auto-scaling capabilities.

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.

Indicates if the dedicated search service has an upgrade available.

The available API versions.

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.