Skip to content

Commit

Permalink
Update docs metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
azure-sdk committed Mar 22, 2023
1 parent a876cf2 commit 7f1e5fe
Show file tree
Hide file tree
Showing 2 changed files with 135 additions and 0 deletions.
121 changes: 121 additions & 0 deletions docs-ref-services/latest/arm-desktopvirtualization-readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
title: Azure Desktop Virtualization API client library for JavaScript
keywords: Azure, javascript, SDK, API, @azure/arm-desktopvirtualization, desktopvirtualization
author: xirzec
ms.author: jeffish
ms.date: 03/22/2023
ms.topic: reference
ms.devlang: javascript
ms.service: desktopvirtualization
---
# Azure Desktop Virtualization API client library for JavaScript - version 1.0.0


This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Desktop Virtualization API client.



[Source code](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-desktopvirtualization_1.0.0/sdk/desktopvirtualization/arm-desktopvirtualization) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-desktopvirtualization) |
[API reference documentation](/javascript/api/@azure/arm-desktopvirtualization) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started

### Currently supported environments

- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
- Latest versions of Safari, Chrome, Edge and Firefox.

See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-desktopvirtualization_1.0.0/SUPPORT.md) for more details.

### Prerequisites

- An [Azure subscription][azure_sub].

### Install the `@azure/arm-desktopvirtualization` package

Install the Azure Desktop Virtualization API client library for JavaScript with `npm`:

```bash
npm install @azure/arm-desktopvirtualization
```

### Create and authenticate a `DesktopVirtualizationAPIClient`

To create a client object to access the Azure Desktop Virtualization API API, you will need the `endpoint` of your Azure Desktop Virtualization API resource and a `credential`. The Azure Desktop Virtualization API client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Desktop Virtualization API resource in the [Azure Portal][azure_portal].

You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-desktopvirtualization_1.0.0/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).

To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:

```bash
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure Desktop Virtualization API** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.

For more information about how to create an Azure AD Application check out [this guide](/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { DesktopVirtualizationAPIClient } = require("@azure/arm-desktopvirtualization");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new DesktopVirtualizationAPIClient(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new DesktopVirtualizationAPIClient(credential, subscriptionId);
```


### JavaScript Bundle
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts

### DesktopVirtualizationAPIClient

`DesktopVirtualizationAPIClient` is the primary interface for developers using the Azure Desktop Virtualization API client library. Explore the methods on this client object to understand the different features of the Azure Desktop Virtualization API service that you can access.

## Troubleshooting

### Logging

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:

```javascript
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
```

For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-desktopvirtualization_1.0.0/sdk/core/logger).

## Next steps

Please take a look at the [samples](https://github.com/Azure-Samples/azure-samples-js-management) directory for detailed examples on how to use this library.

## Contributing

If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-desktopvirtualization_1.0.0/CONTRIBUTING.md) to learn more about how to build and test the code.

## Related projects

- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fdesktopvirtualization%2Farm-desktopvirtualization%2FREADME.png)

[azure_cli]: /cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
[azure_portal]: https://portal.azure.com
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-desktopvirtualization_1.0.0/sdk/identity/identity
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-desktopvirtualization_1.0.0/sdk/identity/identity#defaultazurecredential

14 changes: 14 additions & 0 deletions metadata/latest/azure-arm-desktopvirtualization.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"Name": "@azure/arm-desktopvirtualization",
"Version": "1.0.0",
"DevVersion": null,
"DirectoryPath": "sdk/desktopvirtualization/arm-desktopvirtualization",
"ServiceDirectory": "desktopvirtualization",
"ReadMePath": "sdk/desktopvirtualization/arm-desktopvirtualization/README.md",
"ChangeLogPath": "sdk/desktopvirtualization/arm-desktopvirtualization/CHANGELOG.md",
"Group": null,
"SdkType": "mgmt",
"IsNewSdk": true,
"ArtifactName": "azure-arm-desktopvirtualization",
"ReleaseStatus": "2023-03-09"
}

0 comments on commit 7f1e5fe

Please sign in to comment.