@azure-rest/maps-search 2.0.0-alpha.20241213.3 → 2.0.0-alpha.20241217.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,9 +8,9 @@ Key links:
|
|
|
8
8
|
|
|
9
9
|
- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/maps/maps-search-rest)
|
|
10
10
|
- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/maps-search)
|
|
11
|
-
- [API reference documentation](https://
|
|
11
|
+
- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/maps-search?view=azure-node-preview)
|
|
12
12
|
- [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/maps/maps-search-rest/samples)
|
|
13
|
-
- [Product Information](https://
|
|
13
|
+
- [Product Information](https://learn.microsoft.com/rest/api/maps/search)
|
|
14
14
|
|
|
15
15
|
| Package Version | Service Version |
|
|
16
16
|
| --------------- | --------------- |
|
|
@@ -27,9 +27,9 @@ Key links:
|
|
|
27
27
|
### Prerequisites
|
|
28
28
|
|
|
29
29
|
- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
|
|
30
|
-
- An [Azure Maps account](https://
|
|
30
|
+
- An [Azure Maps account](https://learn.microsoft.com/azure/azure-maps/how-to-manage-account-keys). You can create the resource via the [Azure Portal](https://portal.azure.com), the [Azure PowerShell](https://learn.microsoft.com/powershell/module/az.maps/new-azmapsaccount), or the [Azure CLI](https://learn.microsoft.com/cli/azure).
|
|
31
31
|
|
|
32
|
-
If you use Azure CLI, replace `<resource-group-name>` and `<map-account-name>` of your choice, and select a proper [pricing tier](https://
|
|
32
|
+
If you use Azure CLI, replace `<resource-group-name>` and `<map-account-name>` of your choice, and select a proper [pricing tier](https://learn.microsoft.com/azure/azure-maps/choose-pricing-tier) based on your needs via the `<sku-name>` parameter. Please refer to [this page](https://learn.microsoft.com/cli/azure/maps/account?view=azure-cli-latest#az_maps_account_create) for more details.
|
|
33
33
|
|
|
34
34
|
```bash
|
|
35
35
|
az maps account create --resource-group <resource-group-name> --name <map-account-name> --sku <sku-name>
|
|
@@ -55,12 +55,12 @@ You can authenticate with Microsoft Entra ID using the [Azure Identity library](
|
|
|
55
55
|
npm install @azure/identity
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
You will also need to register a new Microsoft Entra ID application and grant access to Azure Maps by assigning the suitable role to your service principal. Please refer to the [Manage authentication](https://
|
|
58
|
+
You will also need to register a new Microsoft Entra ID application and grant access to Azure Maps by assigning the suitable role to your service principal. Please refer to the [Manage authentication](https://learn.microsoft.com/azure/azure-maps/how-to-manage-authentication) page.
|
|
59
59
|
|
|
60
60
|
Set the values of the client ID, tenant ID, and client secret of the Microsoft Entra ID application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.
|
|
61
61
|
|
|
62
62
|
You will also need to specify the Azure Maps resource you intend to use by specifying the `clientId` in the client options.
|
|
63
|
-
The Azure Maps resource client id can be found in the Authentication sections in the Azure Maps resource. Please refer to the [documentation](https://
|
|
63
|
+
The Azure Maps resource client id can be found in the Authentication sections in the Azure Maps resource. Please refer to the [documentation](https://learn.microsoft.com/azure/azure-maps/how-to-manage-authentication#view-authentication-details) on how to find it.
|
|
64
64
|
|
|
65
65
|
```javascript
|
|
66
66
|
const MapsSearch = require("@azure-rest/maps-search").default;
|
package/package.json
CHANGED