Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryKeys

Package version

Class representing a QueryKeys.

Hierarchy

  • QueryKeys

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • create(resourceGroupName: string, searchServiceName: string, name: string, options?: Models.QueryKeysCreateOptionalParams): Promise<Models.QueryKeysCreateResponse>
  • create(resourceGroupName: string, searchServiceName: string, name: string, callback: msRest.ServiceCallback<QueryKey>): void
  • create(resourceGroupName: string, searchServiceName: string, name: string, options: QueryKeysCreateOptionalParams, callback: msRest.ServiceCallback<QueryKey>): void

  • Generates a new query key for the specified Search service. You can create up to 50 query keys per service.

    Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • name: string

      The name of the new query API key.

    • Optional options: Models.QueryKeysCreateOptionalParams

    Returns Promise<Models.QueryKeysCreateResponse>

    Promise<Models.QueryKeysCreateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • name: string

      The name of the new query API key.

    • callback: msRest.ServiceCallback<QueryKey>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • name: string

      The name of the new query API key.

    • options: QueryKeysCreateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<QueryKey>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, searchServiceName: string, key: string, options?: Models.QueryKeysDeleteMethodOptionalParams): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, searchServiceName: string, key: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, searchServiceName: string, key: string, options: QueryKeysDeleteMethodOptionalParams, callback: msRest.ServiceCallback<void>): void

  • Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

    Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • key: string

      The query key to be deleted. Query keys are identified by value, not by name.

    • Optional options: Models.QueryKeysDeleteMethodOptionalParams

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • key: string

      The query key to be deleted. Query keys are identified by value, not by name.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • key: string

      The query key to be deleted. Query keys are identified by value, not by name.

    • options: QueryKeysDeleteMethodOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

listBySearchService

  • listBySearchService(resourceGroupName: string, searchServiceName: string, options?: Models.QueryKeysListBySearchServiceOptionalParams): Promise<Models.QueryKeysListBySearchServiceResponse>
  • listBySearchService(resourceGroupName: string, searchServiceName: string, callback: msRest.ServiceCallback<ListQueryKeysResult>): void
  • listBySearchService(resourceGroupName: string, searchServiceName: string, options: QueryKeysListBySearchServiceOptionalParams, callback: msRest.ServiceCallback<ListQueryKeysResult>): void

  • Returns the list of query API keys for the given Azure Search service.

    Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • Optional options: Models.QueryKeysListBySearchServiceOptionalParams

    Returns Promise<Models.QueryKeysListBySearchServiceResponse>

    Promise<Models.QueryKeysListBySearchServiceResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • callback: msRest.ServiceCallback<ListQueryKeysResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

    • searchServiceName: string

      The name of the Azure Search service associated with the specified resource group.

    • options: QueryKeysListBySearchServiceOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<ListQueryKeysResult>

      The callback

    Returns void

Generated using TypeDoc