SearchManagementClient class

Package:

@azure/arm-search

Extends

ServiceClient

Constructors

SearchManagementClient(TokenCredential, string, SearchManagementClientOptionalParams)

Initializes a new instance of the SearchManagementClient class.

Properties

$host
adminKeys
apiVersion
operations
privateEndpointConnections
privateLinkResources
queryKeys
services
sharedPrivateLinkResources
subscriptionId
usages

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

usageBySubscriptionSku(string, string, UsageBySubscriptionSkuOptionalParams)

Gets the quota usage for a search sku in the given subscription.

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)	Send the provided httpRequest.

Constructor Details

SearchManagementClient(TokenCredential, string, SearchManagementClientOptionalParams)

Initializes a new instance of the SearchManagementClient class.

new SearchManagementClient(credentials: TokenCredential, subscriptionId: string, options?: SearchManagementClientOptionalParams)

Parameters

credentials

TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.

options

SearchManagementClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

adminKeys

adminKeys: AdminKeys

Property Value

AdminKeys

apiVersion

apiVersion: string

Property Value

string

operations

operations: Operations

Property Value

Operations

privateEndpointConnections

privateEndpointConnections: PrivateEndpointConnections

Property Value

PrivateEndpointConnections

privateLinkResources

privateLinkResources: PrivateLinkResources

Property Value

PrivateLinkResources

queryKeys

queryKeys: QueryKeys

Property Value

QueryKeys

services

services: Services

Property Value

Services

sharedPrivateLinkResources

sharedPrivateLinkResources: SharedPrivateLinkResources

Property Value

SharedPrivateLinkResources

subscriptionId

subscriptionId: string

Property Value

string

usages

usages: Usages

Property Value

Usages

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Method Details

usageBySubscriptionSku(string, string, UsageBySubscriptionSkuOptionalParams)

Gets the quota usage for a search sku in the given subscription.

function usageBySubscriptionSku(location: string, skuName: string, options?: UsageBySubscriptionSkuOptionalParams): Promise<QuotaUsageResult>

Parameters

location

string

The unique location name for a Microsoft Azure geographic region.

skuName

string

The unique search service sku name supported by Azure Cognitive Search.

options

UsageBySubscriptionSkuOptionalParams

The options parameters.

Returns

Promise<QuotaUsageResult>

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request

PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest