Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update-documentation-use.md #20485

Closed
wants to merge 3 commits into from
Closed

update-documentation-use.md #20485

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b586ed
update-documentation-use.md
colawwj Feb 22, 2022
8b23948
Update documentation/how-to-use.md
qiaozha Mar 11, 2022
1da6c65
Apply suggestions from code review
qiaozha Mar 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions documentation/how-to-use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ In this document, we will give a brief introduction on how to use the JavaScript

1. Install dependencies.
```
// install the nodeauth packages to do the authentication work.
npm install @azure/ms-rest-nodeauth
// or install @azure/identity, if you would like to use @azure/identity to do the authentication work.
// install the @azure/identity packages to do the authentication work.
npm install @azure/identity

// Then install your target try out package, you can install the latest published with
Expand All @@ -35,24 +33,25 @@ In this document, we will give a brief introduction on how to use the JavaScript
1. Create a ts file (free name and copy follow code into this file) eg: test_1.ts
eg：
```
const msRestNodeAuth = require("@azure/ms-rest-nodeauth");
const DefaultAzureCredential = require("@azure/identity");
qiaozha marked this conversation as resolved.
Show resolved Hide resolved
const { TargetManagementClient } = require("@azure/arm-target"); // must same as dependencies
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new TargetManagementClient(creds, subscriptionId);
client.operations.list().then((result) => { // you can test that you need test operation
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
async function main(){
const credentials = new DefaultAzureCredential();
const client = new TargetManagementClient(credentials,subscriptionId); // must same as dependencies
for await (const item of client.operations.list()){ // you can test that you need test operation
console.log(item)
}
}
main().catch(err => {
console.log(err);
});
```
A few points, you need to pay attention here:
In the example, we are using msRestNodeAuth.interactiveLogin, you can also try other way such as Service Principal
In the example, we are using DefaultAzureCredential, you can also try other way such as InteractiveBrowserCredential
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep the Service Principal way

colawwj marked this conversation as resolved.
Show resolved Hide resolved
```
const credentials = await msRestNodeAuth.loginWithServicePrincipalSecret(clientID, clientSecret, tenantID);
const credentials = new DefaultAzureCredential();;
qiaozha marked this conversation as resolved.
Show resolved Hide resolved
```
In the example, we only add client.operations.list(), you may change them into other resources CURD function per your need.
for example：
Expand Down