UNPKG

@azure-rest/maps-search

Version:
53 lines 2.36 kB
import type { ClientOptions } from "@azure-rest/core-client"; import type { AzureKeyCredential, AzureSASCredential, TokenCredential } from "@azure/core-auth"; import type { MapsSearchClient } from "./generated/index.js"; /** * Creates an instance of MapsSearchClient from a subscription key. * * @example * ```ts snippet:ReadmeSampleCreateClient_SubscriptionKey * import { AzureKeyCredential } from "@azure/core-auth"; * import MapsSearch from "@azure-rest/maps-search"; * * const credential = new AzureKeyCredential("<subscription-key>"); * const client = MapsSearch(credential); *``` * * @param credential - An AzureKeyCredential instance used to authenticate requests to the service * @param options - Options used to configure the Search Client */ export default function MapsSearch(credential: AzureKeyCredential, options?: ClientOptions): MapsSearchClient; /** * Creates an instance of MapsSearch from an Azure Identity `TokenCredential`. * * @example * ```ts snippet:ReadmeSampleCreateClient_TokenCredential * import { DefaultAzureCredential } from "@azure/identity"; * import MapsSearch from "@azure-rest/maps-search"; * * const credential = new DefaultAzureCredential(); * const client = MapsSearch(credential, "<maps-account-client-id>"); *``` * * @param credential - An TokenCredential instance used to authenticate requests to the service * @param mapsAccountClientId - The Azure Maps client id of a specific map resource * @param options - Options used to configure the Search Client */ export default function MapsSearch(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsSearchClient; /** * Creates an instance of MapsSearch from an Azure Identity `AzureSASCredential`. * * @example * ```ts snippet:ReadmeSampleCreateClient_SASToken * import { AzureSASCredential } from "@azure/core-auth"; * import MapsSearch from "@azure-rest/maps-search"; * * const credential = new AzureSASCredential("<SAS Token>"); * const client = MapsSearch(credential); * ``` * * @param credential - An AzureSASCredential instance used to authenticate requests to the service * @param options - Options used to configure the Search Client */ export default function MapsSearch(credential: AzureSASCredential, options?: ClientOptions): MapsSearchClient; //# sourceMappingURL=MapsSearch.d.ts.map