Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AdminKeys

Package version

Class representing a AdminKeys.

Hierarchy

  • AdminKeys

Index

Constructors

Methods

Constructors

constructor

Methods

get

  • get(resourceGroupName: string, searchServiceName: string, options?: Models.AdminKeysGetOptionalParams): Promise<Models.AdminKeysGetResponse>
  • get(resourceGroupName: string, searchServiceName: string, callback: msRest.ServiceCallback<AdminKeyResult>): void
  • get(resourceGroupName: string, searchServiceName: string, options: AdminKeysGetOptionalParams, callback: msRest.ServiceCallback<AdminKeyResult>): void

  • Gets the primary and secondary admin API keys for the specified 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.AdminKeysGetOptionalParams

    Returns Promise<Models.AdminKeysGetResponse>

    Promise<Models.AdminKeysGetResponse>

  • 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<AdminKeyResult>

      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: AdminKeysGetOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<AdminKeyResult>

      The callback

    Returns void

regenerate

  • regenerate(resourceGroupName: string, searchServiceName: string, keyKind: Models.AdminKeyKind, options?: Models.AdminKeysRegenerateOptionalParams): Promise<Models.AdminKeysRegenerateResponse>
  • regenerate(resourceGroupName: string, searchServiceName: string, keyKind: Models.AdminKeyKind, callback: msRest.ServiceCallback<AdminKeyResult>): void
  • regenerate(resourceGroupName: string, searchServiceName: string, keyKind: Models.AdminKeyKind, options: AdminKeysRegenerateOptionalParams, callback: msRest.ServiceCallback<AdminKeyResult>): void

  • Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

    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.

    • keyKind: Models.AdminKeyKind

      Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Possible values include: 'primary', 'secondary'

    • Optional options: Models.AdminKeysRegenerateOptionalParams

    Returns Promise<Models.AdminKeysRegenerateResponse>

    Promise<Models.AdminKeysRegenerateResponse>

  • 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.

    • keyKind: Models.AdminKeyKind

      Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Possible values include: 'primary', 'secondary'

    • callback: msRest.ServiceCallback<AdminKeyResult>

      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.

    • keyKind: Models.AdminKeyKind

      Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Possible values include: 'primary', 'secondary'

    • options: AdminKeysRegenerateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<AdminKeyResult>

      The callback

    Returns void

Generated using TypeDoc