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

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

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

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.

Output of check name availability API.

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

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.

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

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.

The IP restriction rule of the Azure AI Search service.

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.

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.

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

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

Network security configuration properties.

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

Network security perimeter configuration profile.

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

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

Localized display information for this particular operation.

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

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.

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.

Response containing a list of private endpoint connections.

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

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.

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.

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.

Response containing a list of supported Private Link Resources.

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

Describes a provisioning issue for a network security perimeter configuration.

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

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.

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

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.

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.

Describes the quota usage for a particular SKU.

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

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.

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

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.

Information about resource association.

Parameter group.

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.

Response containing a list of Azure AI Search services.

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

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.

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.

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.

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.

Response containing a list of shared private link resources.

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

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

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

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.

User assigned identity properties.

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

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

Direction of Access Rule.

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

AdminKeyKind.

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

The type of identity that created the resource.

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.

Type of issue.

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.

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.

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.

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.

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

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.

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

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

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 search service has an upgrade available.