@azure-rest/maps-route
Version:
A client library for Azure Maps maps-route
53 lines • 2.34 kB
TypeScript
import type { ClientOptions } from "@azure-rest/core-client";
import type { AzureKeyCredential, AzureSASCredential, TokenCredential } from "@azure/core-auth";
import type { MapsRouteClient } from "./generated/index.js";
/**
* Creates an instance of MapsRouteClient from a subscription key.
*
* @example
* ```ts snippet:ReadmeSampleCreateClient_SubscriptionKey
* import { AzureKeyCredential } from "@azure/core-auth";
* import MapsRoute from "@azure-rest/maps-route";
*
* const credential = new AzureKeyCredential("<subscription-key>");
* const client = MapsRoute(credential);
*```
*
* @param credential - An AzureKeyCredential instance used to authenticate requests to the service
* @param options - Options used to configure the Route Client
*/
export default function MapsRoute(credential: AzureKeyCredential, options?: ClientOptions): MapsRouteClient;
/**
* Creates an instance of MapsRoute from an Azure Identity `TokenCredential`.
*
* @example
* ```ts snippet:ReadmeSampleCreateClient_TokenCredential
* import { DefaultAzureCredential } from "@azure/identity";
* import MapsRoute from "@azure-rest/maps-route";
*
* const credential = new DefaultAzureCredential();
* const client = MapsRoute(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 Route Client
*/
export default function MapsRoute(credential: TokenCredential, mapsAccountClientId: string, options?: ClientOptions): MapsRouteClient;
/**
* Creates an instance of MapsRoute from an Azure Identity `AzureSASCredential`.
*
* @example
* ```ts snippet:ReadmeSampleCreateClient_SASToken
* import { AzureSASCredential } from "@azure/core-auth";
* import MapsRoute from "@azure-rest/maps-route";
*
* const credential = new AzureSASCredential("<SAS Token>");
* const client = MapsRoute(credential);
* ```
*
* @param credential - An AzureSASCredential instance used to authenticate requests to the service
* @param options - Options used to configure the Route Client
*/
export default function MapsRoute(credential: AzureSASCredential, options?: ClientOptions): MapsRouteClient;
//# sourceMappingURL=mapsRoute.d.ts.map