-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Generated from 2415f868e5abc7d5b2a56c16233826e680bd2032 (#659)
typo: data-plane/Microsoft.KeyVault - workign -> working - renawal -> renewal - encypt -> encrypt - Setsecret -> SetSecret - ceritifcate -> certificate - addresss -> address - defintions -> definitions - priveleged -> privileged
- Loading branch information
1 parent
60cc241
commit 0856421
Showing
9 changed files
with
104 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,102 +1,83 @@ | ||
## Azure KeyVaultClient SDK for JavaScript | ||
|
||
This package contains an isomorphic SDK for KeyVaultClient. | ||
|
||
### Currently supported environments | ||
|
||
- Node.js version 6.x.x or higher | ||
- Browser JavaScript | ||
|
||
### How to Install | ||
|
||
``` | ||
npm install @azure/keyvault | ||
``` | ||
|
||
### How to use | ||
|
||
#### nodejs - Authentication, client creation and getKey as an example written in TypeScript. | ||
|
||
##### Install @azure/ms-rest-nodeauth | ||
|
||
``` | ||
npm install @azure/ms-rest-nodeauth | ||
``` | ||
|
||
##### Sample code | ||
|
||
```ts | ||
import * as msRest from "@azure/ms-rest-js"; | ||
import * as msRestAzure from "@azure/ms-rest-azure-js"; | ||
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; | ||
import { KeyVaultClient, KeyVaultModels, KeyVaultMappers } from "@azure/keyvault"; | ||
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; | ||
|
||
msRestNodeAuth.interactiveLogin().then((creds) => { | ||
const client = new KeyVaultClient(creds, subscriptionId); | ||
const vaultBaseUrl = "testvaultBaseUrl"; | ||
const keyName = "testkeyName"; | ||
const keyVersion = "testkeyVersion"; | ||
client.getKey(vaultBaseUrl, keyName, keyVersion).then((result) => { | ||
console.log("The result is:"); | ||
console.log(result); | ||
}); | ||
}).catch((err) => { | ||
console.error(err); | ||
}); | ||
``` | ||
|
||
#### browser - Authentication, client creation and getKey as an example written in JavaScript. | ||
|
||
##### Install @azure/ms-rest-browserauth | ||
|
||
``` | ||
npm install @azure/ms-rest-browserauth | ||
``` | ||
|
||
##### Sample code | ||
|
||
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. | ||
|
||
- index.html | ||
```html | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<title>@azure/keyvault sample</title> | ||
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script> | ||
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script> | ||
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script> | ||
<script src="node_modules/@azure/keyvault/dist/keyvault.js"></script> | ||
<script type="text/javascript"> | ||
const subscriptionId = "<Subscription_Id>"; | ||
const authManager = new msAuth.AuthManager({ | ||
clientId: "<client id for your Azure AD app>", | ||
tenant: "<optional tenant for your organization>" | ||
}); | ||
authManager.finalizeLogin().then((res) => { | ||
if (!res.isLoggedIn) { | ||
// may cause redirects | ||
authManager.login(); | ||
} | ||
const client = new Azure.Keyvault.KeyVaultClient(res.creds, subscriptionId); | ||
const vaultBaseUrl = "testvaultBaseUrl"; | ||
const keyName = "testkeyName"; | ||
const keyVersion = "testkeyVersion"; | ||
client.getKey(vaultBaseUrl, keyName, keyVersion).then((result) => { | ||
console.log("The result is:"); | ||
console.log(result); | ||
}).catch((err) => { | ||
console.log("An error occurred:"); | ||
console.error(err); | ||
}); | ||
}); | ||
</script> | ||
</head> | ||
<body></body> | ||
</html> | ||
``` | ||
|
||
## Related projects | ||
|
||
- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) | ||
# Azure KeyVaultClient SDK for JavaScript | ||
This package contains an isomorphic SDK for KeyVaultClient. | ||
|
||
## Currently supported environments | ||
- Node.js version 6.x.x or higher | ||
- Browser JavaScript | ||
|
||
## How to Install | ||
``` | ||
npm install @azure/keyvault | ||
``` | ||
|
||
|
||
## How to use | ||
|
||
### nodejs - Authentication, client creation and getKey as an example written in TypeScript. | ||
|
||
```ts | ||
import * as msRest from "ms-rest-js"; | ||
import * as msRestAzure from "ms-rest-azure-js"; | ||
import * as msRestNodeAuth from "ms-rest-nodeauth"; | ||
import { KeyVaultClient, KeyVaultModels, KeyVaultMappers } from "@azure/keyvault"; | ||
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; | ||
|
||
msRestNodeAuth.interactiveLogin().then((creds) => { | ||
const client = new KeyVaultClient(creds, subscriptionId); | ||
const vaultBaseUrl = "testvaultBaseUrl"; | ||
const keyName = "testkeyName"; | ||
const keyVersion = "testkeyVersion"; | ||
client.getKey(vaultBaseUrl, keyName, keyVersion).then((result) => { | ||
console.log("The result is:"); | ||
console.log(result); | ||
}); | ||
}).catch((err) => { | ||
console.error(err); | ||
}); | ||
``` | ||
|
||
### browser - Authentication, client creation and getKey as an example written in JavaScript. | ||
See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. | ||
|
||
- index.html | ||
```html | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<title>@azure/keyvault sample</title> | ||
<script src="node_modules/ms-rest-js/dist/msRest.browser.js"></script> | ||
<script src="node_modules/ms-rest-azure-js/dist/msRestAzure.js"></script> | ||
<script src="node_modules/ms-rest-browserauth/dist/msAuth.js"></script> | ||
<script src="node_modules/@azure/keyvault/dist/keyvault.js"></script> | ||
<script> | ||
const subscriptionId = "<Subscription_Id>"; | ||
const authManager = new msAuth.AuthManager({ | ||
clientId: "<client id for your Azure AD app>", | ||
tenant: "<optional tenant for your organization>" | ||
}); | ||
authManager.finalizeLogin().then((res) => { | ||
if (!res.isLoggedIn) { | ||
// may cause redirects | ||
authManager.login(); | ||
} | ||
const client = new Azure.Keyvault.KeyVaultClient(res.creds, subscriptionId); | ||
const vaultBaseUrl = "testvaultBaseUrl"; | ||
const keyName = "testkeyName"; | ||
const keyVersion = "testkeyVersion"; | ||
client.getKey(vaultBaseUrl, keyName, keyVersion).then((result) => { | ||
console.log("The result is:"); | ||
console.log(result); | ||
}).catch((err) => { | ||
console.log("An error occurred:"); | ||
console.error(err); | ||
}); | ||
}); | ||
</script> | ||
</head> | ||
<body> | ||
</body> | ||
</html> | ||
``` | ||
|
||
# Related projects | ||
- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters