Azure.ResourceManager.Search.Models Namespace

Classes

ArmSearchModelFactory	Model factory for models.
QuotaUsageResult	Describes the quota usage for a particular SKU.
QuotaUsageResultName	The name of the SKU supported by Azure AI Search.
SearchAadAuthDataPlaneAuthOptions	Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true.
SearchEncryptionWithCmk	Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys.
SearchManagementRequestOptions	Parameter group.
SearchPrivateLinkResource	Describes a supported private link resource for the Azure AI Search service.
SearchPrivateLinkResourceProperties	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.
SearchServiceAdminKeyResult	Response containing the primary and secondary admin API keys for a given Azure AI Search service.
SearchServiceIPRule	The IP restriction rule of the Azure AI Search service.
SearchServiceNameAvailabilityContent	Input of check name availability API.
SearchServiceNameAvailabilityResult	Output of check name availability API.
SearchServicePatch	The parameters used to update a search service.
SearchServicePrivateEndpointConnectionProperties	Describes the properties of an existing private endpoint connection to the search service.
SearchServicePrivateLinkServiceConnectionState	Describes the current state of an existing Azure Private Link service connection to the private endpoint.
SearchServiceQueryKey	Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index.
ShareableSearchServicePrivateLinkResourceProperties	Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.
ShareableSearchServicePrivateLinkResourceType	Describes an resource type that has been onboarded to private link service, supported by Azure AI Search.
SharedSearchServicePrivateLinkResourceProperties	Describes the properties of an existing Shared Private Link Resource managed by the search service.

Structs

SearchPrivateLinkServiceConnectionProvisioningState	The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled.
SearchSemanticSearch	Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations.
SearchServiceNameUnavailableReason	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.
SearchServiceResourceType	The type of the resource whose name is to be validated. This value must always be 'searchServices'.

Enums

SearchAadAuthFailureMode	Describes what response the data plane API of a search service would send for requests that failed authentication.
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.
SearchEncryptionWithCmkEnforcement	Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key.
SearchServiceAdminKeyKind	The SearchServiceAdminKeyKind.
SearchServiceHostingMode	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'.
SearchServicePrivateLinkServiceConnectionStatus	Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected.
SearchServiceProvisioningState	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.
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.