@azure/arm-search package

Classes

SearchManagementClient

Interfaces

AdminKeyResult	Response containing the primary and secondary admin API keys for a given Azure Cognitive Search service.
AdminKeys	Interface representing a AdminKeys.
AdminKeysGetOptionalParams	Optional parameters.
AdminKeysRegenerateOptionalParams	Optional parameters.
AsyncOperationResult	The details of a long running asynchronous shared private link resource operation
CheckNameAvailabilityInput	Input of check name availability API.
CheckNameAvailabilityOutput	Output of check name availability API.
CloudError	Contains information about an API error.
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.
Identity	Identity for the resource.
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.
NetworkRuleSet	Network specific rules that determine how the Azure Cognitive Search service may be reached.
Operation	Describes a REST API operation.
OperationDisplay	The object that describes the operation.
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.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
PrivateEndpointConnection	Describes an existing Private Endpoint connection to the Azure Cognitive Search service.
PrivateEndpointConnectionListResult	Response containing a list of Private Endpoint connections.
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.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByServiceNextOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByServiceOptionalParams	Optional parameters.
PrivateEndpointConnectionsUpdateOptionalParams	Optional parameters.
PrivateLinkResource	Describes a supported private link resource for the Azure Cognitive Search service.
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.
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesListSupportedOptionalParams	Optional parameters.
PrivateLinkResourcesResult	Response containing a list of supported Private Link Resources.
QueryKey	Describes an API key for a given Azure Cognitive Search service that has permissions for query operations only.
QueryKeys	Interface representing a QueryKeys.
QueryKeysCreateOptionalParams	Optional parameters.
QueryKeysDeleteOptionalParams	Optional parameters.
QueryKeysListBySearchServiceNextOptionalParams	Optional parameters.
QueryKeysListBySearchServiceOptionalParams	Optional parameters.
QuotaUsageResult	Describes the quota usage for a particular sku supported by Azure Cognitive Search.
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.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
SearchManagementClientOptionalParams	Optional parameters.
SearchManagementRequestOptions	Parameter group
SearchService	Describes an Azure Cognitive Search service and its current state.
SearchServiceListResult	Response containing a list of Azure Cognitive Search services.
SearchServiceUpdate	The parameters used to update an Azure Cognitive Search service.
Services	Interface representing a Services.
ServicesCheckNameAvailabilityOptionalParams	Optional parameters.
ServicesCreateOrUpdateOptionalParams	Optional parameters.
ServicesDeleteOptionalParams	Optional parameters.
ServicesGetOptionalParams	Optional parameters.
ServicesListByResourceGroupNextOptionalParams	Optional parameters.
ServicesListByResourceGroupOptionalParams	Optional parameters.
ServicesListBySubscriptionNextOptionalParams	Optional parameters.
ServicesListBySubscriptionOptionalParams	Optional parameters.
ServicesUpdateOptionalParams	Optional parameters.
ShareablePrivateLinkResourceProperties	Describes the properties of a resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
ShareablePrivateLinkResourceType	Describes an resource type that has been onboarded to private link service, supported by Azure Cognitive Search.
SharedPrivateLinkResource	Describes a Shared Private Link Resource managed by the Azure Cognitive Search service.
SharedPrivateLinkResourceListResult	Response containing a list of Shared Private Link Resources.
SharedPrivateLinkResourceProperties	Describes the properties of an existing Shared Private Link Resource managed by the Azure Cognitive Search service.
SharedPrivateLinkResources	Interface representing a SharedPrivateLinkResources.
SharedPrivateLinkResourcesCreateOrUpdateOptionalParams	Optional parameters.
SharedPrivateLinkResourcesDeleteOptionalParams	Optional parameters.
SharedPrivateLinkResourcesGetOptionalParams	Optional parameters.
SharedPrivateLinkResourcesListByServiceNextOptionalParams	Optional parameters.
SharedPrivateLinkResourcesListByServiceOptionalParams	Optional parameters.
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'
UsageBySubscriptionSkuOptionalParams	Optional parameters.
Usages	Interface representing a Usages.
UsagesListBySubscriptionNextOptionalParams	Optional parameters.
UsagesListBySubscriptionOptionalParams	Optional parameters.

Type Aliases

AadAuthFailureMode	Defines values for AadAuthFailureMode.
AdminKeyKind	Defines values for AdminKeyKind.
AdminKeysGetResponse	Contains response data for the get operation.
AdminKeysRegenerateResponse	Contains response data for the regenerate operation.
HostingMode	Defines values for HostingMode.
IdentityType	Defines values for IdentityType.
OperationsListResponse	Contains response data for the list operation.
PrivateEndpointConnectionsDeleteResponse	Contains response data for the delete operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByServiceNextResponse	Contains response data for the listByServiceNext operation.
PrivateEndpointConnectionsListByServiceResponse	Contains response data for the listByService operation.
PrivateEndpointConnectionsUpdateResponse	Contains response data for the update operation.
PrivateLinkResourcesListSupportedResponse	Contains response data for the listSupported operation.
PrivateLinkServiceConnectionProvisioningState	Defines values for PrivateLinkServiceConnectionProvisioningState. KnownPrivateLinkServiceConnectionProvisioningState can be used interchangeably with PrivateLinkServiceConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Updating: The private link service connection is in the process of being created along with other resources for it to be fully functional. Deleting: The private link service connection is in the process of being deleted. Failed: The private link service connection has failed to be provisioned or deleted. Succeeded: The private link service connection has finished provisioning and is ready for approval. Incomplete: Provisioning request for the private link service connection resource has been accepted but the process of creation has not commenced yet. Canceled: Provisioning request for the private link service connection resource has been canceled
PrivateLinkServiceConnectionStatus	Defines values for PrivateLinkServiceConnectionStatus.
ProvisioningState	Defines values for ProvisioningState.
PublicNetworkAccess	Defines values for PublicNetworkAccess.
QueryKeysCreateResponse	Contains response data for the create operation.
QueryKeysListBySearchServiceNextResponse	Contains response data for the listBySearchServiceNext operation.
QueryKeysListBySearchServiceResponse	Contains response data for the listBySearchService operation.
SearchEncryptionComplianceStatus	Defines values for SearchEncryptionComplianceStatus.
SearchEncryptionWithCmk	Defines values for SearchEncryptionWithCmk.
SearchSemanticSearch	Defines values for SearchSemanticSearch. KnownSearchSemanticSearch can be used interchangeably with SearchSemanticSearch, this enum contains the known values that the service supports. Known values supported by the service disabled: Indicates that semantic search is disabled for the search service. free: Enables semantic search on a search service and indicates that it is to be used within the limits of the free tier. This would cap the volume of semantic search requests and is offered at no extra charge. This is the default for newly provisioned search services. standard: Enables semantic search on a search service as a billable feature, with higher throughput and volume of semantic search queries.
SearchServiceStatus	Defines values for SearchServiceStatus.
ServicesCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
ServicesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ServicesGetResponse	Contains response data for the get operation.
ServicesListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ServicesListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ServicesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
ServicesListBySubscriptionResponse	Contains response data for the listBySubscription operation.
ServicesUpdateResponse	Contains response data for the update operation.
SharedPrivateLinkResourceAsyncOperationResult	Defines values for SharedPrivateLinkResourceAsyncOperationResult. KnownSharedPrivateLinkResourceAsyncOperationResult can be used interchangeably with SharedPrivateLinkResourceAsyncOperationResult, this enum contains the known values that the service supports. Known values supported by the service Running Succeeded Failed
SharedPrivateLinkResourceProvisioningState	Defines values for SharedPrivateLinkResourceProvisioningState.
SharedPrivateLinkResourceStatus	Defines values for SharedPrivateLinkResourceStatus.
SharedPrivateLinkResourcesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
SharedPrivateLinkResourcesGetResponse	Contains response data for the get operation.
SharedPrivateLinkResourcesListByServiceNextResponse	Contains response data for the listByServiceNext operation.
SharedPrivateLinkResourcesListByServiceResponse	Contains response data for the listByService operation.
SkuName	Defines values for SkuName.
UnavailableNameReason	Defines values for UnavailableNameReason. KnownUnavailableNameReason can be used interchangeably with UnavailableNameReason, this enum contains the known values that the service supports. Known values supported by the service Invalid: The search service name does not match naming requirements. AlreadyExists: The search service name is already assigned to a different search service.
UsageBySubscriptionSkuResponse	Contains response data for the usageBySubscriptionSku operation.
UsagesListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
UsagesListBySubscriptionResponse	Contains response data for the listBySubscription operation.

Enums

KnownPrivateLinkServiceConnectionProvisioningState	Known values of PrivateLinkServiceConnectionProvisioningState that the service accepts.
KnownSearchSemanticSearch	Known values of SearchSemanticSearch that the service accepts.
KnownSharedPrivateLinkResourceAsyncOperationResult	Known values of SharedPrivateLinkResourceAsyncOperationResult that the service accepts.
KnownUnavailableNameReason	Known values of UnavailableNameReason that the service accepts.

Functions

getContinuationToken(unknown)

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

Function Details

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.