@azure/arm-search package

Access rule in a network security perimeter configuration profile

Properties of Access Rule

Subscription identifiers

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

Interface representing a AdminKeys.

Optional parameters.

Optional parameters.

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

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.

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.

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

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.

Response containing the query API keys for a given 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

Result of a list NSP (network security perimeter) configurations request.

Network security configuration properties.

Interface representing a NetworkSecurityPerimeterConfigurations.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for NetworkSecurityPerimeterConfigurations_reconcile operation.

Optional parameters.

Network security perimeter configuration profile

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

Localized display information for this particular operation.

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.

Interface representing a Operations.

Optional parameters.

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

Response containing a list of private endpoint connections.

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.

Interface representing a PrivateEndpointConnections.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

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.

Interface representing a PrivateLinkResources.

Optional parameters.

Response containing a list of supported Private Link Resources.

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.

Interface representing a QueryKeys.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Describes the quota usage for a particular SKU.

The name of the SKU supported by Azure AI Search.

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

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

Information about resource association

Optional parameters.

Parameter group

Describes an Azure AI Search service and its current state.

Response containing a list of Azure AI Search services.

The parameters used to update an Azure AI Search service.

Interface representing a Services.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for Services_upgrade operation.

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.

Response containing a list of shared private link resources.

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

Interface representing a SharedPrivateLinkResources.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

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

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.

Interface representing a Usages.

Optional parameters.

Optional parameters.

User assigned identity properties

Defines values for AadAuthFailureMode.

Defines values for AccessRuleDirection.
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

Defines values for ActionType.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal

Defines values for AdminKeyKind.

Contains response data for the get operation.

Contains response data for the regenerate operation.

Defines values for ComputeType.
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 service with Azure Confidential Compute.

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for HostingMode.

Defines values for IdentityType.
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.

Defines values for IssueType.
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.

Defines values for NetworkSecurityPerimeterConfigurationProvisioningState.
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

Contains response data for the get operation.

Contains response data for the listByServiceNext operation.

Contains response data for the listByService operation.

Contains response data for the reconcile operation.

Contains response data for the list operation.

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user
system
user,system

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByServiceNext operation.

Contains response data for the listByService operation.

Contains response data for the update operation.

Contains response data for the listSupported operation.

Defines values for PrivateLinkServiceConnectionProvisioningState.
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.

Defines values for PrivateLinkServiceConnectionStatus.

Defines values for ProvisioningState.

Defines values for PublicNetworkAccess.
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.

Contains response data for the create operation.

Contains response data for the listBySearchServiceNext operation.

Contains response data for the listBySearchService operation.

Defines values for ResourceAssociationAccessMode.
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

Defines values for SearchBypass.
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.
AzureServices: Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section.

Defines values for SearchDataExfiltrationProtection.
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.

Defines values for SearchEncryptionComplianceStatus.

Defines values for SearchEncryptionWithCmk.

Defines values for SearchSemanticSearch.
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. This is the default.
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: Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries.

Defines values for SearchServiceStatus.

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the update operation.

Contains response data for the upgrade operation.

Defines values for Severity.
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

Defines values for SharedPrivateLinkResourceAsyncOperationResult.
KnownSharedPrivateLinkResourceAsyncOperationResult can be used interchangeably with SharedPrivateLinkResourceAsyncOperationResult, this enum contains the known values that the service supports.

Known values supported by the service

Running
Succeeded
Failed

Defines values for SharedPrivateLinkResourceProvisioningState.
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.

Defines values for SharedPrivateLinkResourceStatus.
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.

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listByServiceNext operation.

Contains response data for the listByService operation.

Defines values for SkuName.
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.

Defines values for UnavailableNameReason.
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.

Defines values for UpgradeAvailable.
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 service.
available: There is an upgrade available for the service.

Contains response data for the usageBySubscriptionSku operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Known values of AccessRuleDirection that the service accepts.

Known values of ActionType that the service accepts.

Known values of ComputeType that the service accepts.

Known values of CreatedByType that the service accepts.

Known values of IdentityType that the service accepts.

Known values of IssueType that the service accepts.

Known values of NetworkSecurityPerimeterConfigurationProvisioningState that the service accepts.

Known values of Origin that the service accepts.

Known values of PrivateLinkServiceConnectionProvisioningState that the service accepts.

Known values of PublicNetworkAccess that the service accepts.

Known values of ResourceAssociationAccessMode that the service accepts.

Known values of SearchBypass that the service accepts.

Known values of SearchDataExfiltrationProtection that the service accepts.

Known values of SearchSemanticSearch that the service accepts.

Known values of Severity that the service accepts.

Known values of SharedPrivateLinkResourceAsyncOperationResult that the service accepts.

Known values of SharedPrivateLinkResourceProvisioningState that the service accepts.

Known values of SharedPrivateLinkResourceStatus that the service accepts.

Known values of SkuName that the service accepts.

Known values of UnavailableNameReason that the service accepts.

Known values of UpgradeAvailable that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.