import * as coreClient from "@azure/core-client"; /** 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. */ export interface OperationListResult { /** * The list of operations by Azure AI Search, some supported by the resource provider and others by data plane APIs. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly value?: Operation[]; /** * The URL to get the next set of operation list results, if any. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly nextLink?: string; } /** Details of a REST API operation, returned from the Resource Provider Operations API */ export interface Operation { /** * The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; /** * Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly isDataAction?: boolean; /** Localized display information for this particular operation. */ display?: OperationDisplay; /** * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly origin?: Origin; /** * Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly actionType?: ActionType; } /** Localized display information for this particular operation. */ export interface OperationDisplay { /** * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly provider?: string; /** * The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly resource?: string; /** * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly operation?: string; /** * The short, localized friendly description of the operation; suitable for tool tips and detailed views. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly description?: string; } /** Contains information about an API error. */ export interface CloudError { /** Describes a particular API error with an error code and a message. */ error?: CloudErrorBody; /** A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). */ message?: string; } /** Describes a particular API error with an error code and a message. */ export interface CloudErrorBody { /** An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. */ code?: string; /** A message that describes the error in detail and provides debugging information. */ message?: string; /** The target of the particular error (for example, the name of the property in error). */ target?: string; /** Contains nested errors that are related to this error. */ details?: CloudErrorBody[]; } /** Response containing the primary and secondary admin API keys for a given Azure AI Search service. */ export interface AdminKeyResult { /** * The primary admin API key of the search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly primaryKey?: string; /** * The secondary admin API key of the search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly secondaryKey?: string; } /** Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index. */ export interface QueryKey { /** * The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; /** * The value of the query API key. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly key?: string; } /** Response containing the query API keys for a given Azure AI Search service. */ export interface ListQueryKeysResult { /** * The query keys for the Azure AI Search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly value?: QueryKey[]; /** * Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly nextLink?: string; } /** Network specific rules that determine how the Azure AI Search service may be reached. */ export interface NetworkRuleSet { /** A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. */ ipRules?: IpRule[]; /** Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. */ bypass?: SearchBypass; } /** The IP restriction rule of the Azure AI Search service. */ export interface IpRule { /** Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed. */ value?: string; } /** Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys. */ export interface EncryptionWithCmk { /** Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. */ enforcement?: SearchEncryptionWithCmk; /** * 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. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly encryptionComplianceStatus?: SearchEncryptionComplianceStatus; } /** Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true. */ export interface DataPlaneAuthOptions { /** Indicates that only the API key can be used for authentication. */ apiKeyOnly?: Record; /** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */ aadOrApiKey?: DataPlaneAadOrApiKeyAuthOption; } /** Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */ export interface DataPlaneAadOrApiKeyAuthOption { /** Describes what response the data plane API of a search service would send for requests that failed authentication. */ aadAuthFailureMode?: AadAuthFailureMode; } /** Describes the properties of an existing private endpoint connection to the search service. */ export interface PrivateEndpointConnectionProperties { /** The private endpoint resource from Microsoft.Network provider. */ privateEndpoint?: PrivateEndpointConnectionPropertiesPrivateEndpoint; /** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */ privateLinkServiceConnectionState?: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState; /** The group ID of the Azure resource for which the private link service is for. */ groupId?: string; /** The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. */ provisioningState?: PrivateLinkServiceConnectionProvisioningState; } /** The private endpoint resource from Microsoft.Network provider. */ export interface PrivateEndpointConnectionPropertiesPrivateEndpoint { /** The resource ID of the private endpoint resource from Microsoft.Network provider. */ id?: string; } /** Describes the current state of an existing Azure Private Link service connection to the private endpoint. */ export interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState { /** Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. */ status?: PrivateLinkServiceConnectionStatus; /** The description for the private link service connection state. */ description?: string; /** A description of any extra actions that may be required. */ actionsRequired?: string; } /** Common fields that are returned in the response for all Azure Resource Manager resources */ export interface Resource { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly id?: string; /** * The name of the resource * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly type?: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly systemData?: SystemData; } /** Metadata pertaining to creation and last modification of the resource. */ export interface SystemData { /** The identity that created the resource. */ createdBy?: string; /** The type of identity that created the resource. */ createdByType?: CreatedByType; /** The timestamp of resource creation (UTC). */ createdAt?: Date; /** The identity that last modified the resource. */ lastModifiedBy?: string; /** The type of identity that last modified the resource. */ lastModifiedByType?: CreatedByType; /** The timestamp of resource last modification (UTC) */ lastModifiedAt?: Date; } /** Describes the properties of an existing shared private link resource managed by the Azure AI Search service. */ export interface SharedPrivateLinkResourceProperties { /** The resource ID of the resource the shared private link resource is for. */ privateLinkResourceId?: string; /** The group ID from the provider of resource the shared private link resource is for. */ groupId?: string; /** The message for requesting approval of the shared private link resource. */ requestMessage?: string; /** Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). */ resourceRegion?: string; /** Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. */ status?: SharedPrivateLinkResourceStatus; /** The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. */ provisioningState?: SharedPrivateLinkResourceProvisioningState; } /** Defines the SKU of a search service, which determines billing rate and capacity limits. */ export interface Sku { /** 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.' */ name?: SkuName; } /** Details about the search service identity. A null value indicates that the search service has no identity assigned. */ export interface Identity { /** * The principal ID of the system-assigned identity of the search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly principalId?: string; /** * The tenant ID of the system-assigned identity of the search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly tenantId?: string; /** 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: IdentityType; /** The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [propertyName: string]: UserAssignedIdentity; }; } /** User assigned identity properties */ export interface UserAssignedIdentity { /** * The principal ID of the assigned identity. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly principalId?: string; /** * The client ID of the assigned identity. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly clientId?: string; } /** Response containing a list of Azure AI Search services. */ export interface SearchServiceListResult { /** * The list of search services. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly value?: SearchService[]; /** * Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly nextLink?: string; } /** Response containing a list of supported Private Link Resources. */ export interface PrivateLinkResourcesResult { /** * The list of supported Private Link Resources. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly value?: PrivateLinkResource[]; } /** 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. */ export interface PrivateLinkResourceProperties { /** * The group ID of the private link resource. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly groupId?: string; /** * The list of required members of the private link resource. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly requiredMembers?: string[]; /** * The list of required DNS zone names of the private link resource. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly requiredZoneNames?: string[]; /** * The list of resources that are onboarded to private link service, that are supported by Azure AI Search. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly shareablePrivateLinkResourceTypes?: ShareablePrivateLinkResourceType[]; } /** Describes an resource type that has been onboarded to private link service, supported by Azure AI Search. */ export interface ShareablePrivateLinkResourceType { /** * The name of the resource type that has been onboarded to private link service, supported by Azure AI Search. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; /** * Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly properties?: ShareablePrivateLinkResourceProperties; } /** Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. */ export interface ShareablePrivateLinkResourceProperties { /** * The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly type?: string; /** * The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly groupId?: string; /** * The description of the resource type that has been onboarded to private link service, supported by Azure AI Search. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly description?: string; } /** Response containing a list of private endpoint connections. */ export interface PrivateEndpointConnectionListResult { /** * The list of private endpoint connections. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly value?: PrivateEndpointConnection[]; /** * Request URL that can be used to query next page of private endpoint connections. Returned when the total number of requested private endpoint connections exceed maximum page size. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly nextLink?: string; } /** Response containing a list of shared private link resources. */ export interface SharedPrivateLinkResourceListResult { /** * The list of shared private link resources. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly value?: SharedPrivateLinkResource[]; /** The URL to get the next set of shared private link resources, if there are any. */ nextLink?: string; } /** Input of check name availability API. */ export interface CheckNameAvailabilityInput { /** The search service name to validate. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. */ name: string; /** The type of the resource whose name is to be validated. This value must always be 'searchServices'. */ type: "searchServices"; } /** Output of check name availability API. */ export interface CheckNameAvailabilityOutput { /** * A value indicating whether the name is available. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly isNameAvailable?: boolean; /** * 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. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly reason?: UnavailableNameReason; /** * A message that explains why the name is invalid and provides resource naming requirements. Available only if 'Invalid' is returned in the 'reason' property. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly message?: string; } /** Response containing the quota usage information for all the supported SKUs of Azure AI Search. */ export interface QuotaUsagesListResult { /** * The quota usages for the SKUs supported by Azure AI Search. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly value?: QuotaUsageResult[]; /** * Request URL that can be used to query next page of quota usages. Returned when the total number of requested quota usages exceed maximum page size. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly nextLink?: string; } /** Describes the quota usage for a particular SKU. */ export interface QuotaUsageResult { /** The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. */ id?: string; /** The unit of measurement for the search SKU. */ unit?: string; /** The currently used up value for the particular search SKU. */ currentValue?: number; /** The quota limit for the particular search SKU. */ limit?: number; /** * The name of the SKU supported by Azure AI Search. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: QuotaUsageResultName; } /** The name of the SKU supported by Azure AI Search. */ export interface QuotaUsageResultName { /** The SKU name supported by Azure AI Search. */ value?: string; /** The localized string value for the SKU name. */ localizedValue?: string; } /** Result of a list NSP (network security perimeter) configurations request. */ export interface NetworkSecurityPerimeterConfigurationListResult { /** Array of network security perimeter results. */ value?: NetworkSecurityPerimeterConfiguration[]; /** The link used to get the next page of results. */ nextLink?: string; } /** Network security configuration properties. */ export interface NetworkSecurityPerimeterConfigurationProperties { /** * Provisioning state of a network security perimeter configuration that is being created or updated. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly provisioningState?: NetworkSecurityPerimeterConfigurationProvisioningState; /** * List of provisioning issues, if any * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly provisioningIssues?: ProvisioningIssue[]; /** Information about a network security perimeter (NSP) */ networkSecurityPerimeter?: NetworkSecurityPerimeter; /** Information about resource association */ resourceAssociation?: ResourceAssociation; /** Network security perimeter configuration profile */ profile?: NetworkSecurityProfile; } /** Describes a provisioning issue for a network security perimeter configuration */ export interface ProvisioningIssue { /** * Name of the issue * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly name?: string; /** * 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 * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly properties?: ProvisioningIssueProperties; } /** 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 */ export interface ProvisioningIssueProperties { /** * Type of issue * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly issueType?: IssueType; /** * Severity of the issue. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly severity?: Severity; /** * Description of the issue * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly description?: string; /** * Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly suggestedResourceIds?: string[]; /** * Access rules that can be added to the network security profile (NSP) to remediate the issue. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly suggestedAccessRules?: AccessRule[]; } /** Access rule in a network security perimeter configuration profile */ export interface AccessRule { /** Name of the access rule */ name?: string; /** Properties of Access Rule */ properties?: AccessRuleProperties; } /** Properties of Access Rule */ export interface AccessRuleProperties { /** Direction of Access Rule */ direction?: AccessRuleDirection; /** Address prefixes in the CIDR format for inbound rules */ addressPrefixes?: string[]; /** Subscriptions for inbound rules */ subscriptions?: AccessRulePropertiesSubscriptionsItem[]; /** Network security perimeters for inbound rules */ networkSecurityPerimeters?: NetworkSecurityPerimeter[]; /** Fully qualified domain names (FQDN) for outbound rules */ fullyQualifiedDomainNames?: string[]; /** Email addresses for outbound rules */ emailAddresses?: string[]; /** Phone numbers for outbound rules */ phoneNumbers?: string[]; } /** Subscription identifiers */ export interface AccessRulePropertiesSubscriptionsItem { /** The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') */ id?: string; } /** Information about a network security perimeter (NSP) */ export interface NetworkSecurityPerimeter { /** Fully qualified Azure resource ID of the NSP resource */ id?: string; /** Universal unique ID (UUID) of the network security perimeter */ perimeterGuid?: string; /** Location of the network security perimeter */ location?: string; } /** Information about resource association */ export interface ResourceAssociation { /** Name of the resource association */ name?: string; /** Access mode of the resource association */ accessMode?: ResourceAssociationAccessMode; } /** Network security perimeter configuration profile */ export interface NetworkSecurityProfile { /** Name of the profile */ name?: string; /** Current access rules version */ accessRulesVersion?: number; /** List of Access Rules */ accessRules?: AccessRule[]; /** Current diagnostic settings version */ diagnosticSettingsVersion?: number; /** List of log categories that are enabled */ enabledLogCategories?: string[]; } /** The details of a long running asynchronous shared private link resource operation. */ export interface AsyncOperationResult { /** The current status of the long running asynchronous shared private link resource operation. */ status?: SharedPrivateLinkResourceAsyncOperationResult; } /** Describes an existing private endpoint connection to the Azure AI Search service. */ export interface PrivateEndpointConnection extends Resource { /** Describes the properties of an existing private endpoint connection to the Azure AI Search service. */ properties?: PrivateEndpointConnectionProperties; } /** Describes a shared private link resource managed by the Azure AI Search service. */ export interface SharedPrivateLinkResource extends Resource { /** Describes the properties of a shared private link resource managed by the Azure AI Search service. */ properties?: SharedPrivateLinkResourceProperties; } /** The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' */ export interface TrackedResource extends Resource { /** Resource tags. */ tags?: { [propertyName: string]: string; }; /** The geo-location where the resource lives */ location: string; } /** The parameters used to update an Azure AI Search service. */ export interface SearchServiceUpdate extends Resource { /** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */ sku?: Sku; /** The geographic location of the resource. This must be one of the supported and registered Azure geo regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource. */ location?: string; /** Tags to help categorize the resource in the Azure portal. */ tags?: { [propertyName: string]: string; }; /** Details about the search service identity. A null value indicates that the search service has no identity assigned. */ identity?: Identity; /** The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. */ replicaCount?: number; /** The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. */ partitionCount?: number; /** The endpoint of the Azure AI Search service. */ endpoint?: string; /** 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'. */ hostingMode?: HostingMode; /** Configure this property to support the search service using either the Default Compute or Azure Confidential Compute. */ computeType?: ComputeType; /** 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. */ publicNetworkAccess?: PublicNetworkAccess; /** * 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. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly status?: SearchServiceStatus; /** * The details of the search service status. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly statusDetails?: string; /** * 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. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly provisioningState?: ProvisioningState; /** Network specific rules that determine how the Azure AI Search service may be reached. */ networkRuleSet?: NetworkRuleSet; /** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */ dataExfiltrationProtections?: SearchDataExfiltrationProtection[]; /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */ encryptionWithCmk?: EncryptionWithCmk; /** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */ disableLocalAuth?: boolean; /** 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. */ authOptions?: DataPlaneAuthOptions; /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */ semanticSearch?: SearchSemanticSearch; /** * The list of private endpoint connections to the Azure AI Search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly privateEndpointConnections?: PrivateEndpointConnection[]; /** * The list of shared private link resources managed by the Azure AI Search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[]; /** * A system generated property representing the service's etag that can be for optimistic concurrency control during updates. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly eTag?: string; /** Indicates if the search service has an upgrade available. */ upgradeAvailable?: UpgradeAvailable; /** * The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly serviceUpgradedAt?: Date; } /** Describes a supported private link resource for the Azure AI Search service. */ export interface PrivateLinkResource extends Resource { /** * Describes the properties of a supported private link resource for the Azure AI Search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly properties?: PrivateLinkResourceProperties; } /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */ export interface ProxyResource extends Resource { } /** Describes an Azure AI Search service and its current state. */ export interface SearchService extends TrackedResource { /** The SKU of the search service, which determines price tier and capacity limits. This property is required when creating a new search service. */ sku?: Sku; /** The identity of the resource. */ identity?: Identity; /** The number of replicas in the search service. If specified, it must be a value between 1 and 12 inclusive for standard SKUs or between 1 and 3 inclusive for basic SKU. */ replicaCount?: number; /** The number of partitions in the search service; if specified, it can be 1, 2, 3, 4, 6, or 12. Values greater than 1 are only valid for standard SKUs. For 'standard3' services with hostingMode set to 'highDensity', the allowed values are between 1 and 3. */ partitionCount?: number; /** The endpoint of the Azure AI Search service. */ endpoint?: string; /** 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'. */ hostingMode?: HostingMode; /** Configure this property to support the search service using either the Default Compute or Azure Confidential Compute. */ computeType?: ComputeType; /** 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. */ publicNetworkAccess?: PublicNetworkAccess; /** * 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. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly status?: SearchServiceStatus; /** * The details of the search service status. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly statusDetails?: string; /** * 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. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly provisioningState?: ProvisioningState; /** Network specific rules that determine how the Azure AI Search service may be reached. */ networkRuleSet?: NetworkRuleSet; /** A list of data exfiltration scenarios that are explicitly disallowed for the search service. Currently, the only supported value is 'All' to disable all possible data export scenarios with more fine grained controls planned for the future. */ dataExfiltrationProtections?: SearchDataExfiltrationProtection[]; /** Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. */ encryptionWithCmk?: EncryptionWithCmk; /** When set to true, calls to the search service will not be permitted to utilize API keys for authentication. This cannot be set to true if 'dataPlaneAuthOptions' are defined. */ disableLocalAuth?: boolean; /** 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. */ authOptions?: DataPlaneAuthOptions; /** Sets options that control the availability of semantic search. This configuration is only possible for certain Azure AI Search SKUs in certain locations. */ semanticSearch?: SearchSemanticSearch; /** * The list of private endpoint connections to the Azure AI Search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly privateEndpointConnections?: PrivateEndpointConnection[]; /** * The list of shared private link resources managed by the Azure AI Search service. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly sharedPrivateLinkResources?: SharedPrivateLinkResource[]; /** * A system generated property representing the service's etag that can be for optimistic concurrency control during updates. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly eTag?: string; /** Indicates if the search service has an upgrade available. */ upgradeAvailable?: UpgradeAvailable; /** * The date and time the search service was last upgraded. This field will be null until the service gets upgraded for the first time. * NOTE: This property will not be serialized. It can only be populated by the server. */ readonly serviceUpgradedAt?: Date; } /** Network security perimeter (NSP) configuration resource */ export interface NetworkSecurityPerimeterConfiguration extends ProxyResource { /** Network security configuration properties. */ properties?: NetworkSecurityPerimeterConfigurationProperties; } /** Defines headers for Services_upgrade operation. */ export interface ServicesUpgradeHeaders { location?: string; } /** Defines headers for NetworkSecurityPerimeterConfigurations_reconcile operation. */ export interface NetworkSecurityPerimeterConfigurationsReconcileHeaders { location?: string; } /** Parameter group */ export interface SearchManagementRequestOptions { /** A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request. */ clientRequestId?: string; } /** Known values of {@link Origin} that the service accepts. */ export declare enum KnownOrigin { /** User */ User = "user", /** System */ System = "system", /** UserSystem */ UserSystem = "user,system" } /** * Defines values for Origin. \ * {@link 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** */ export type Origin = string; /** Known values of {@link ActionType} that the service accepts. */ export declare enum KnownActionType { /** Internal */ Internal = "Internal" } /** * Defines values for ActionType. \ * {@link KnownActionType} can be used interchangeably with ActionType, * this enum contains the known values that the service supports. * ### Known values supported by the service * **Internal** */ export type ActionType = string; /** Known values of {@link ComputeType} that the service accepts. */ export declare enum KnownComputeType { /** Create the service with the Default Compute. */ Default = "default", /** Create the service with Azure Confidential Compute. */ Confidential = "confidential" } /** * Defines values for ComputeType. \ * {@link 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. */ export type ComputeType = string; /** Known values of {@link PublicNetworkAccess} that the service accepts. */ export declare enum KnownPublicNetworkAccess { /** The search service is accessible from traffic originating from the public internet. */ Enabled = "enabled", /** The search service is not accessible from traffic originating from the public internet. Access is only permitted over approved private endpoint connections. */ Disabled = "disabled", /** The network security perimeter configuration rules allow or disallow public network access to the resource. Requires an associated network security perimeter. */ SecuredByPerimeter = "securedByPerimeter" } /** * Defines values for PublicNetworkAccess. \ * {@link 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. */ export type PublicNetworkAccess = string; /** Known values of {@link SearchBypass} that the service accepts. */ export declare enum KnownSearchBypass { /** Indicates that no origin can bypass the rules defined in the 'ipRules' section. This is the default. */ None = "None", /** Indicates that requests originating from Azure trusted services can bypass the rules defined in the 'ipRules' section. */ AzureServices = "AzureServices" } /** * Defines values for SearchBypass. \ * {@link 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. */ export type SearchBypass = string; /** Known values of {@link SearchDataExfiltrationProtection} that the service accepts. */ export declare enum KnownSearchDataExfiltrationProtection { /** Indicates that all data exfiltration scenarios are disabled. */ BlockAll = "BlockAll" } /** * Defines values for SearchDataExfiltrationProtection. \ * {@link 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. */ export type SearchDataExfiltrationProtection = string; /** Known values of {@link SearchSemanticSearch} that the service accepts. */ export declare enum KnownSearchSemanticSearch { /** Indicates that semantic reranker is disabled for the search service. This is the default. */ Disabled = "disabled", /** 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. */ Free = "free", /** Enables semantic reranker on a search service as a billable feature, with higher throughput and volume of semantically reranked queries. */ Standard = "standard" } /** * Defines values for SearchSemanticSearch. \ * {@link 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. */ export type SearchSemanticSearch = string; /** Known values of {@link PrivateLinkServiceConnectionProvisioningState} that the service accepts. */ export declare enum KnownPrivateLinkServiceConnectionProvisioningState { /** The private link service connection is in the process of being created along with other resources for it to be fully functional. */ Updating = "Updating", /** The private link service connection is in the process of being deleted. */ Deleting = "Deleting", /** The private link service connection has failed to be provisioned or deleted. */ Failed = "Failed", /** The private link service connection has finished provisioning and is ready for approval. */ Succeeded = "Succeeded", /** Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. */ Incomplete = "Incomplete", /** Provisioning request for the private link service connection resource has been canceled. */ Canceled = "Canceled" } /** * Defines values for PrivateLinkServiceConnectionProvisioningState. \ * {@link 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. */ export type PrivateLinkServiceConnectionProvisioningState = string; /** Known values of {@link CreatedByType} that the service accepts. */ export declare enum KnownCreatedByType { /** User */ User = "User", /** Application */ Application = "Application", /** ManagedIdentity */ ManagedIdentity = "ManagedIdentity", /** Key */ Key = "Key" } /** * Defines values for CreatedByType. \ * {@link 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** */ export type CreatedByType = string; /** Known values of {@link SharedPrivateLinkResourceStatus} that the service accepts. */ export declare enum KnownSharedPrivateLinkResourceStatus { /** The shared private link resource has been created and is pending approval. */ Pending = "Pending", /** The shared private link resource is approved and is ready for use. */ Approved = "Approved", /** The shared private link resource has been rejected and cannot be used. */ Rejected = "Rejected", /** The shared private link resource has been removed from the service. */ Disconnected = "Disconnected" } /** * Defines values for SharedPrivateLinkResourceStatus. \ * {@link 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. */ export type SharedPrivateLinkResourceStatus = string; /** Known values of {@link SharedPrivateLinkResourceProvisioningState} that the service accepts. */ export declare enum KnownSharedPrivateLinkResourceProvisioningState { /** The shared private link resource is in the process of being created along with other resources for it to be fully functional. */ Updating = "Updating", /** The shared private link resource is in the process of being deleted. */ Deleting = "Deleting", /** The shared private link resource has failed to be provisioned or deleted. */ Failed = "Failed", /** The shared private link resource has finished provisioning and is ready for approval. */ Succeeded = "Succeeded", /** Provisioning request for the shared private link resource has been accepted but the process of creation has not commenced yet. */ Incomplete = "Incomplete" } /** * Defines values for SharedPrivateLinkResourceProvisioningState. \ * {@link 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. */ export type SharedPrivateLinkResourceProvisioningState = string; /** Known values of {@link UpgradeAvailable} that the service accepts. */ export declare enum KnownUpgradeAvailable { /** An upgrade is currently not available for the service. */ NotAvailable = "notAvailable", /** There is an upgrade available for the service. */ Available = "available" } /** * Defines values for UpgradeAvailable. \ * {@link 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. */ export type UpgradeAvailable = string; /** Known values of {@link SkuName} that the service accepts. */ export declare enum KnownSkuName { /** Free tier, with no SLA guarantees and a subset of the features offered on billable tiers. */ Free = "free", /** Billable tier for a dedicated service having up to 3 replicas. */ Basic = "basic", /** Billable tier for a dedicated service having up to 12 partitions and 12 replicas. */ Standard = "standard", /** Similar to 'standard', but with more capacity per search unit. */ Standard2 = "standard2", /** 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'). */ Standard3 = "standard3", /** Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions. */ StorageOptimizedL1 = "storage_optimized_l1", /** Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions. */ StorageOptimizedL2 = "storage_optimized_l2" } /** * Defines values for SkuName. \ * {@link 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. */ export type SkuName = string; /** Known values of {@link IdentityType} that the service accepts. */ export declare enum KnownIdentityType { /** Indicates that any identity associated with the search service needs to be removed. */ None = "None", /** Indicates that system-assigned identity for the search service will be enabled. */ SystemAssigned = "SystemAssigned", /** Indicates that one or more user assigned identities will be assigned to the search service. */ UserAssigned = "UserAssigned", /** Indicates that system-assigned identity for the search service will be enabled along with the assignment of one or more user assigned identities. */ SystemAssignedUserAssigned = "SystemAssigned, UserAssigned" } /** * Defines values for IdentityType. \ * {@link 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. */ export type IdentityType = string; /** Known values of {@link UnavailableNameReason} that the service accepts. */ export declare enum KnownUnavailableNameReason { /** The search service name doesn't match naming requirements. */ Invalid = "Invalid", /** The search service name is already assigned to a different search service. */ AlreadyExists = "AlreadyExists" } /** * Defines values for UnavailableNameReason. \ * {@link 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. */ export type UnavailableNameReason = string; /** Known values of {@link NetworkSecurityPerimeterConfigurationProvisioningState} that the service accepts. */ export declare enum KnownNetworkSecurityPerimeterConfigurationProvisioningState { /** Succeeded */ Succeeded = "Succeeded", /** Creating */ Creating = "Creating", /** Updating */ Updating = "Updating", /** Deleting */ Deleting = "Deleting", /** Accepted */ Accepted = "Accepted", /** Failed */ Failed = "Failed", /** Canceled */ Canceled = "Canceled" } /** * Defines values for NetworkSecurityPerimeterConfigurationProvisioningState. \ * {@link 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** */ export type NetworkSecurityPerimeterConfigurationProvisioningState = string; /** Known values of {@link IssueType} that the service accepts. */ export declare enum KnownIssueType { /** Unknown issue type */ Unknown = "Unknown", /** An error occurred while applying the network security perimeter (NSP) configuration. */ ConfigurationPropagationFailure = "ConfigurationPropagationFailure", /** 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. */ MissingPerimeterConfiguration = "MissingPerimeterConfiguration", /** 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. */ MissingIdentityConfiguration = "MissingIdentityConfiguration" } /** * Defines values for IssueType. \ * {@link 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. */ export type IssueType = string; /** Known values of {@link Severity} that the service accepts. */ export declare enum KnownSeverity { /** Warning */ Warning = "Warning", /** Error */ Error = "Error" } /** * Defines values for Severity. \ * {@link 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** */ export type Severity = string; /** Known values of {@link AccessRuleDirection} that the service accepts. */ export declare enum KnownAccessRuleDirection { /** Applies to inbound network traffic to the secured resources. */ Inbound = "Inbound", /** Applies to outbound network traffic from the secured resources */ Outbound = "Outbound" } /** * Defines values for AccessRuleDirection. \ * {@link 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 */ export type AccessRuleDirection = string; /** Known values of {@link ResourceAssociationAccessMode} that the service accepts. */ export declare enum KnownResourceAssociationAccessMode { /** Enforced access mode - traffic to the resource that failed access checks is blocked */ Enforced = "Enforced", /** Learning access mode - traffic to the resource is enabled for analysis but not blocked */ Learning = "Learning", /** Audit access mode - traffic to the resource that fails access checks is logged but not blocked */ Audit = "Audit" } /** * Defines values for ResourceAssociationAccessMode. \ * {@link 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 */ export type ResourceAssociationAccessMode = string; /** Known values of {@link SharedPrivateLinkResourceAsyncOperationResult} that the service accepts. */ export declare enum KnownSharedPrivateLinkResourceAsyncOperationResult { /** Running */ Running = "Running", /** Succeeded */ Succeeded = "Succeeded", /** Failed */ Failed = "Failed" } /** * Defines values for SharedPrivateLinkResourceAsyncOperationResult. \ * {@link 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** */ export type SharedPrivateLinkResourceAsyncOperationResult = string; /** Defines values for AdminKeyKind. */ export type AdminKeyKind = "primary" | "secondary"; /** Defines values for HostingMode. */ export type HostingMode = "default" | "highDensity"; /** Defines values for SearchServiceStatus. */ export type SearchServiceStatus = "running" | "provisioning" | "deleting" | "degraded" | "disabled" | "error" | "stopped"; /** Defines values for ProvisioningState. */ export type ProvisioningState = "succeeded" | "provisioning" | "failed"; /** Defines values for SearchEncryptionWithCmk. */ export type SearchEncryptionWithCmk = "Disabled" | "Enabled" | "Unspecified"; /** Defines values for SearchEncryptionComplianceStatus. */ export type SearchEncryptionComplianceStatus = "Compliant" | "NonCompliant"; /** Defines values for AadAuthFailureMode. */ export type AadAuthFailureMode = "http403" | "http401WithBearerChallenge"; /** Defines values for PrivateLinkServiceConnectionStatus. */ export type PrivateLinkServiceConnectionStatus = "Pending" | "Approved" | "Rejected" | "Disconnected"; /** Optional parameters. */ export interface OperationsListOptionalParams extends coreClient.OperationOptions { } /** Contains response data for the list operation. */ export type OperationsListResponse = OperationListResult; /** Optional parameters. */ export interface AdminKeysGetOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the get operation. */ export type AdminKeysGetResponse = AdminKeyResult; /** Optional parameters. */ export interface AdminKeysRegenerateOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the regenerate operation. */ export type AdminKeysRegenerateResponse = AdminKeyResult; /** Optional parameters. */ export interface QueryKeysCreateOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the create operation. */ export type QueryKeysCreateResponse = QueryKey; /** Optional parameters. */ export interface QueryKeysListBySearchServiceOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listBySearchService operation. */ export type QueryKeysListBySearchServiceResponse = ListQueryKeysResult; /** Optional parameters. */ export interface QueryKeysDeleteOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Optional parameters. */ export interface QueryKeysListBySearchServiceNextOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listBySearchServiceNext operation. */ export type QueryKeysListBySearchServiceNextResponse = ListQueryKeysResult; /** Optional parameters. */ export interface ServicesCreateOrUpdateOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; /** Delay to wait until next poll, in milliseconds. */ updateIntervalInMs?: number; /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */ resumeFrom?: string; } /** Contains response data for the createOrUpdate operation. */ export type ServicesCreateOrUpdateResponse = SearchService; /** Optional parameters. */ export interface ServicesUpdateOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the update operation. */ export type ServicesUpdateResponse = SearchService; /** Optional parameters. */ export interface ServicesGetOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the get operation. */ export type ServicesGetResponse = SearchService; /** Optional parameters. */ export interface ServicesDeleteOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Optional parameters. */ export interface ServicesListByResourceGroupOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listByResourceGroup operation. */ export type ServicesListByResourceGroupResponse = SearchServiceListResult; /** Optional parameters. */ export interface ServicesListBySubscriptionOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listBySubscription operation. */ export type ServicesListBySubscriptionResponse = SearchServiceListResult; /** Optional parameters. */ export interface ServicesCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the checkNameAvailability operation. */ export type ServicesCheckNameAvailabilityResponse = CheckNameAvailabilityOutput; /** Optional parameters. */ export interface ServicesUpgradeOptionalParams extends coreClient.OperationOptions { /** Delay to wait until next poll, in milliseconds. */ updateIntervalInMs?: number; /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */ resumeFrom?: string; } /** Contains response data for the upgrade operation. */ export type ServicesUpgradeResponse = SearchService; /** Optional parameters. */ export interface ServicesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listByResourceGroupNext operation. */ export type ServicesListByResourceGroupNextResponse = SearchServiceListResult; /** Optional parameters. */ export interface ServicesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listBySubscriptionNext operation. */ export type ServicesListBySubscriptionNextResponse = SearchServiceListResult; /** Optional parameters. */ export interface PrivateLinkResourcesListSupportedOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listSupported operation. */ export type PrivateLinkResourcesListSupportedResponse = PrivateLinkResourcesResult; /** Optional parameters. */ export interface PrivateEndpointConnectionsUpdateOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the update operation. */ export type PrivateEndpointConnectionsUpdateResponse = PrivateEndpointConnection; /** Optional parameters. */ export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the get operation. */ export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection; /** Optional parameters. */ export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the delete operation. */ export type PrivateEndpointConnectionsDeleteResponse = PrivateEndpointConnection; /** Optional parameters. */ export interface PrivateEndpointConnectionsListByServiceOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listByService operation. */ export type PrivateEndpointConnectionsListByServiceResponse = PrivateEndpointConnectionListResult; /** Optional parameters. */ export interface PrivateEndpointConnectionsListByServiceNextOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listByServiceNext operation. */ export type PrivateEndpointConnectionsListByServiceNextResponse = PrivateEndpointConnectionListResult; /** Optional parameters. */ export interface SharedPrivateLinkResourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; /** Delay to wait until next poll, in milliseconds. */ updateIntervalInMs?: number; /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */ resumeFrom?: string; } /** Contains response data for the createOrUpdate operation. */ export type SharedPrivateLinkResourcesCreateOrUpdateResponse = SharedPrivateLinkResource; /** Optional parameters. */ export interface SharedPrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the get operation. */ export type SharedPrivateLinkResourcesGetResponse = SharedPrivateLinkResource; /** Optional parameters. */ export interface SharedPrivateLinkResourcesDeleteOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; /** Delay to wait until next poll, in milliseconds. */ updateIntervalInMs?: number; /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */ resumeFrom?: string; } /** Optional parameters. */ export interface SharedPrivateLinkResourcesListByServiceOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listByService operation. */ export type SharedPrivateLinkResourcesListByServiceResponse = SharedPrivateLinkResourceListResult; /** Optional parameters. */ export interface SharedPrivateLinkResourcesListByServiceNextOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listByServiceNext operation. */ export type SharedPrivateLinkResourcesListByServiceNextResponse = SharedPrivateLinkResourceListResult; /** Optional parameters. */ export interface UsagesListBySubscriptionOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listBySubscription operation. */ export type UsagesListBySubscriptionResponse = QuotaUsagesListResult; /** Optional parameters. */ export interface UsagesListBySubscriptionNextOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the listBySubscriptionNext operation. */ export type UsagesListBySubscriptionNextResponse = QuotaUsagesListResult; /** Optional parameters. */ export interface UsageBySubscriptionSkuOptionalParams extends coreClient.OperationOptions { /** Parameter group */ searchManagementRequestOptions?: SearchManagementRequestOptions; } /** Contains response data for the usageBySubscriptionSku operation. */ export type UsageBySubscriptionSkuResponse = QuotaUsageResult; /** Optional parameters. */ export interface NetworkSecurityPerimeterConfigurationsListByServiceOptionalParams extends coreClient.OperationOptions { } /** Contains response data for the listByService operation. */ export type NetworkSecurityPerimeterConfigurationsListByServiceResponse = NetworkSecurityPerimeterConfigurationListResult; /** Optional parameters. */ export interface NetworkSecurityPerimeterConfigurationsGetOptionalParams extends coreClient.OperationOptions { } /** Contains response data for the get operation. */ export type NetworkSecurityPerimeterConfigurationsGetResponse = NetworkSecurityPerimeterConfiguration; /** Optional parameters. */ export interface NetworkSecurityPerimeterConfigurationsReconcileOptionalParams extends coreClient.OperationOptions { /** Delay to wait until next poll, in milliseconds. */ updateIntervalInMs?: number; /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */ resumeFrom?: string; } /** Contains response data for the reconcile operation. */ export type NetworkSecurityPerimeterConfigurationsReconcileResponse = NetworkSecurityPerimeterConfigurationsReconcileHeaders; /** Optional parameters. */ export interface NetworkSecurityPerimeterConfigurationsListByServiceNextOptionalParams extends coreClient.OperationOptions { } /** Contains response data for the listByServiceNext operation. */ export type NetworkSecurityPerimeterConfigurationsListByServiceNextResponse = NetworkSecurityPerimeterConfigurationListResult; /** Optional parameters. */ export interface SearchManagementClientOptionalParams extends coreClient.ServiceClientOptions { /** server parameter */ $host?: string; /** Api Version */ apiVersion?: string; /** Overrides client endpoint. */ endpoint?: string; } //# sourceMappingURL=index.d.ts.map