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.

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

[AutoPR keyvault/data-plane] typo: data-plane/Microsoft.KeyVault #659

Merged
merged 1 commit into from
Dec 3, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
185 changes: 83 additions & 102 deletions packages/@azure/keyvault/README.md
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)
6 changes: 3 additions & 3 deletions packages/@azure/keyvault/lib/keyVaultClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
* regenerated.
*/

import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRest from "ms-rest-js";
import * as msRestAzure from "ms-rest-azure-js";
import * as Models from "./models";
import * as Mappers from "./models/mappers";
import * as Parameters from "./models/parameters";
Expand Down Expand Up @@ -384,7 +384,7 @@ class KeyVaultClient extends KeyVaultClientContext {
* protection with an asymmetric key can be performed using public portion of the key. This
* operation is supported for asymmetric keys as a convenience for callers that have a
* key-reference but do not have access to the public key material. This operation requires the
* keys/encypt permission.
* keys/encrypt permission.
* @summary Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key
* vault.
* @param vaultBaseUrl The vault name, for example https://myvault.vault.azure.net.
Expand Down
4 changes: 2 additions & 2 deletions packages/@azure/keyvault/lib/keyVaultClientContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
* regenerated.
*/

import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRest from "ms-rest-js";
import * as msRestAzure from "ms-rest-azure-js";

const packageName = "@azure/keyvault";
const packageVersion = "0.1.0";
Expand Down
13 changes: 7 additions & 6 deletions packages/@azure/keyvault/lib/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
* regenerated.
*/

import { BaseResource, CloudError } from "@azure/ms-rest-azure-js";
import * as msRest from "@azure/ms-rest-js";
import { BaseResource, CloudError } from "ms-rest-azure-js";
import * as msRest from "ms-rest-js";

export { BaseResource, CloudError };

Expand Down Expand Up @@ -612,7 +612,7 @@ export interface X509CertificateProperties {
*/
keyUsage?: KeyUsageType[];
/**
* @member {number} [validityInMonths] The duration that the ceritifcate is
* @member {number} [validityInMonths] The duration that the certificate is
* valid in months.
*/
validityInMonths?: number;
Expand Down Expand Up @@ -968,7 +968,7 @@ export interface AdministratorDetails {
*/
lastName?: string;
/**
* @member {string} [emailAddress] Email addresss.
* @member {string} [emailAddress] Email address.
*/
emailAddress?: string;
/**
Expand Down Expand Up @@ -1061,7 +1061,7 @@ export interface IssuerBundle {
*/
export interface Contact {
/**
* @member {string} [emailAddress] Email addresss.
* @member {string} [emailAddress] Email address.
*/
emailAddress?: string;
/**
Expand Down Expand Up @@ -2943,7 +2943,8 @@ export interface DeletedStorageListResult extends Array<DeletedStorageAccountIte
*/
export interface SasDefinitionListResult extends Array<SasDefinitionItem> {
/**
* @member {string} [nextLink] The URL to get the next set of SAS defintions.
* @member {string} [nextLink] The URL to get the next set of SAS
* definitions.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/@azure/keyvault/lib/models/mappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
* regenerated.
*/

import { CloudErrorMapper, BaseResourceMapper } from "@azure/ms-rest-azure-js";
import * as msRest from "@azure/ms-rest-js";
import { CloudErrorMapper, BaseResourceMapper } from "ms-rest-azure-js";
import * as msRest from "ms-rest-js";

export const CloudError = CloudErrorMapper;
export const BaseResource = BaseResourceMapper;
Expand Down
2 changes: 1 addition & 1 deletion packages/@azure/keyvault/lib/models/parameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* regenerated.
*/

import * as msRest from "@azure/ms-rest-js";
import * as msRest from "ms-rest-js";

export const acceptLanguage: msRest.OperationParameter = {
parameterPath: "acceptLanguage",
Expand Down
4 changes: 2 additions & 2 deletions packages/@azure/keyvault/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"description": "KeyVaultClient Library with typescript type definitions for node.js and browser.",
"version": "0.1.0",
"dependencies": {
"@azure/ms-rest-azure-js": "^1.1.0",
"@azure/ms-rest-js": "^1.1.0",
"ms-rest-azure-js": "^1.0.181",
"ms-rest-js": "^1.0.460",
"tslib": "^1.9.3"
},
"keywords": [
Expand Down
6 changes: 3 additions & 3 deletions packages/@azure/keyvault/rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ import nodeResolve from "rollup-plugin-node-resolve";
*/
const config = {
input: './esm/keyVaultClient.js',
external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
external: ["ms-rest-js", "ms-rest-azure-js"],
output: {
file: "./dist/keyvault.js",
format: "umd",
name: "Azure.Keyvault",
sourcemap: true,
globals: {
"@azure/ms-rest-js": "msRest",
"@azure/ms-rest-azure-js": "msRestAzure"
"ms-rest-js": "msRest",
"ms-rest-azure-js": "msRestAzure"
},
banner: `/*
* Copyright (c) Microsoft Corporation. All rights reserved.
Expand Down
2 changes: 1 addition & 1 deletion packages/@azure/keyvault/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
"outDir": "./esm",
"importHelpers": true
},
"include": ["./lib/**/*.ts"],
"include": ["./lib/**/*"],
"exclude": ["node_modules"]
}