Skip to content

Commit 8064cd9

Browse files
committed
Update docs metadata
1 parent c21ca69 commit 8064cd9

File tree

2 files changed

+135
-0
lines changed

2 files changed

+135
-0
lines changed
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
title: Azure Service client library for JavaScript
3+
keywords: Azure, javascript, SDK, API, @azure/arm-scvmm, scvmm
4+
author: xirzec
5+
ms.author: jeffish
6+
ms.date: 04/28/2022
7+
ms.topic: reference
8+
ms.devlang: javascript
9+
ms.service: scvmm
10+
---
11+
# Azure Service client library for JavaScript - Version 1.0.0-beta.1
12+
13+
14+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Service client.
15+
16+
The Microsoft.ScVmm Rest API spec.
17+
18+
[Source code](https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-scvmm_1.0.0-beta.1/sdk/scvmm/arm-scvmm) |
19+
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-scvmm) |
20+
[API reference documentation](/javascript/api/@azure/arm-scvmm?view=azure-node-preview) |
21+
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)
22+
23+
## Getting started
24+
25+
### Currently supported environments
26+
27+
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
28+
- Latest versions of Safari, Chrome, Edge and Firefox.
29+
30+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/@azure/arm-scvmm_1.0.0-beta.1/SUPPORT.md) for more details.
31+
32+
### Prerequisites
33+
34+
- An [Azure subscription][azure_sub].
35+
36+
### Install the `@azure/arm-scvmm` package
37+
38+
Install the Azure Service client library for JavaScript with `npm`:
39+
40+
```bash
41+
npm install @azure/arm-scvmm
42+
```
43+
44+
### Create and authenticate a `Scvmm`
45+
46+
To create a client object to access the Azure Service API, you will need the `endpoint` of your Azure Service resource and a `credential`. The Azure Service client can use Azure Active Directory credentials to authenticate.
47+
You can find the endpoint for your Azure Service resource in the [Azure Portal][azure_portal].
48+
49+
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-scvmm_1.0.0-beta.1/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).
50+
51+
To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the `@azure/identity` package:
52+
53+
```bash
54+
npm install @azure/identity
55+
```
56+
57+
You will also need to **register a new AAD application and grant access to Azure Service** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
58+
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`.
59+
60+
For more information about how to create an Azure AD Application check out [this guide](/azure/active-directory/develop/howto-create-service-principal-portal).
61+
62+
```javascript
63+
const { Scvmm } = require("@azure/arm-scvmm");
64+
const { DefaultAzureCredential } = require("@azure/identity");
65+
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
66+
67+
const subscriptionId = "00000000-0000-0000-0000-000000000000";
68+
const client = new Scvmm(new DefaultAzureCredential(), subscriptionId);
69+
70+
// For client-side applications running in the browser, use this code instead:
71+
// const credential = new InteractiveBrowserCredential({
72+
// tenantId: "<YOUR_TENANT_ID>",
73+
// clientId: "<YOUR_CLIENT_ID>"
74+
// });
75+
// const client = new Scvmm(credential, subscriptionId);
76+
```
77+
78+
79+
### JavaScript Bundle
80+
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).
81+
82+
## Key concepts
83+
84+
### Scvmm
85+
86+
`Scvmm` is the primary interface for developers using the Azure Service client library. Explore the methods on this client object to understand the different features of the Azure Service service that you can access.
87+
88+
## Troubleshooting
89+
90+
### Logging
91+
92+
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`:
93+
94+
```javascript
95+
const { setLogLevel } = require("@azure/logger");
96+
setLogLevel("info");
97+
```
98+
99+
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-scvmm_1.0.0-beta.1/sdk/core/logger).
100+
101+
## Next steps
102+
103+
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.
104+
105+
## Contributing
106+
107+
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-scvmm_1.0.0-beta.1/CONTRIBUTING.md) to learn more about how to build and test the code.
108+
109+
## Related projects
110+
111+
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
112+
113+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fscvmm%2Farm-scvmm%2FREADME.png)
114+
115+
[azure_cli]: /cli/azure
116+
[azure_sub]: https://azure.microsoft.com/free/
117+
[azure_sub]: https://azure.microsoft.com/free/
118+
[azure_portal]: https://portal.azure.com
119+
[azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-scvmm_1.0.0-beta.1/sdk/identity/identity
120+
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/@azure/arm-scvmm_1.0.0-beta.1/sdk/identity/identity#defaultazurecredential
121+

metadata/preview/azure-arm-scvmm.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"Name": "@azure/arm-scvmm",
3+
"Version": "1.0.0-beta.1",
4+
"DevVersion": null,
5+
"DirectoryPath": "sdk/scvmm/arm-scvmm",
6+
"ServiceDirectory": "scvmm",
7+
"ReadMePath": "sdk/scvmm/arm-scvmm/README.md",
8+
"ChangeLogPath": "sdk/scvmm/arm-scvmm/CHANGELOG.md",
9+
"Group": null,
10+
"SdkType": "mgmt",
11+
"IsNewSdk": true,
12+
"ArtifactName": "azure-arm-scvmm",
13+
"ReleaseStatus": "2022-04-27"
14+
}

0 commit comments

Comments
 (0)