models Package

Classes

AdminKeyResult	Response containing the primary and secondary admin API keys for a given Azure Cognitive Search service. Variables are only populated by the server, and will be ignored when sending a request.
AsyncOperationResult	The details of a long running asynchronous shared private link resource operation.
CheckNameAvailabilityInput	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 Azure.
CheckNameAvailabilityOutput	Output of check name availability API. Variables are only populated by the server, and will be ignored when sending a request.
CloudErrorBody	Describes a particular API error with an error code and a message.
DataPlaneAadOrApiKeyAuthOption	Indicates that either the API key or an access token from Azure Active Directory can be used for authentication.
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.
EncryptionWithCmk	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.
Identity	Identity for the resource. 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 Azure.
IpRule	The IP restriction rule of the Azure Cognitive Search service.
ListQueryKeysResult	Response containing the query API keys for a given Azure Cognitive Search service. Variables are only populated by the server, and will be ignored when sending a request.
NetworkRuleSet	Network specific rules that determine how the Azure Cognitive Search service may be reached.
Operation	Describes a REST API operation. Variables are only populated by the server, and will be ignored when sending a request.
OperationDisplay	The object that describes the operation. Variables are only populated by the server, and will be ignored when sending a request.
OperationListResult	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.
PrivateEndpointConnection	Describes an existing Private Endpoint connection to the Azure Cognitive Search service. Variables are only populated by the server, and will be ignored when sending a request.
PrivateEndpointConnectionListResult	Response containing a list of Private Endpoint connections. Variables are only populated by the server, and will be ignored when sending a request.
PrivateEndpointConnectionProperties	Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
PrivateEndpointConnectionPropertiesPrivateEndpoint	The private endpoint resource from Microsoft.Network provider.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint.
PrivateLinkResource	Describes a supported private link resource for the Azure Cognitive Search service. Variables are only populated by the server, and will be ignored when sending a request.
PrivateLinkResourceProperties	Describes the properties of a supported private link resource for the Azure Cognitive 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.
PrivateLinkResourcesResult	Response containing a list of supported Private Link Resources. Variables are only populated by the server, and will be ignored when sending a request.
QueryKey	Describes an API key for a given Azure Cognitive Search service that has permissions for query operations only. Variables are only populated by the server, and will be ignored when sending a request.
QuotaUsageResult	Describes the quota usage for a particular sku supported by Azure Cognitive Search. Variables are only populated by the server, and will be ignored when sending a request.
QuotaUsageResultName	The name of the sku supported by Azure Cognitive Search.
QuotaUsagesListResult	Response containing the quota usage information for all the supported skus of Azure Cognitive Search service. Variables are only populated by the server, and will be ignored when sending a request.
Resource	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.
SearchManagementRequestOptions	Parameter group.
SearchService	Describes an Azure Cognitive 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 Azure.
SearchServiceListResult	Response containing a list of Azure Cognitive Search services. Variables are only populated by the server, and will be ignored when sending a request.
SearchServiceUpdate	The parameters used to update an Azure Cognitive Search service. Variables are only populated by the server, and will be ignored when sending a request.
ShareablePrivateLinkResourceProperties	Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search. Variables are only populated by the server, and will be ignored when sending a request.
ShareablePrivateLinkResourceType	Describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search. Variables are only populated by the server, and will be ignored when sending a request.
SharedPrivateLinkResource	Describes a Shared Private Link Resource managed by the Azure Cognitive Search service. Variables are only populated by the server, and will be ignored when sending a request.
SharedPrivateLinkResourceListResult	Response containing a list of Shared Private Link Resources. Variables are only populated by the server, and will be ignored when sending a request.
SharedPrivateLinkResourceProperties	Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service.
Sku	Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity limits.
TrackedResource	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 Azure.

Enums

AadAuthFailureMode	Describes what response the data plane API of a Search service would send for requests that failed authentication.
AdminKeyKind	AdminKeyKind.
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'.
IdentityType	The identity type.
PrivateLinkServiceConnectionProvisioningState	The provisioning state of the private link service connection. Can be Updating, Deleting, Failed, Succeeded, or Incomplete.
PrivateLinkServiceConnectionStatus	Status of the the private link service connection. Can be Pending, Approved, Rejected, or Disconnected.
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.
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.
SearchEncryptionComplianceStatus	Describes whether the search service is compliant or not with respect to having non customer encrypted resources. If a service has more than one non customer encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'.
SearchEncryptionWithCmk	Describes how a search service should enforce having one or more non customer encrypted resources.
SearchSemanticSearch	Sets options that control the availability of semantic search. This configuration is only possible for certain Azure Cognitive Search SKUs in certain locations.
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. If your service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team is actively investigating the underlying issue. Dedicated services in these states are still chargeable based on the number of search units provisioned.
SharedPrivateLinkResourceAsyncOperationResult	The current status of the long running asynchronous shared private link resource operation.
SharedPrivateLinkResourceProvisioningState	The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, Succeeded or Incomplete.
SharedPrivateLinkResourceStatus	Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
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.'.
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.