Skip to content

Adding docs for App Configuration #1

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

Closed
richardpark-msft wants to merge 2 commits into from
Closed

Adding docs for App Configuration #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f9cbc4
Adding documentation for appconfig
richardpark-msft Sep 5, 2019
551affc
running npm run format
richardpark-msft Sep 5, 2019
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
10 changes: 1 addition & 9 deletions sdk/appconfiguration/app-configuration/review/app-configuration.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,16 @@ export type AddConfigurationSettingOptions = ModelConfigurationClientCreateOrUpd
// @public (undocumented)
export type AddConfigurationSettingsResponse = ModelCreateOrUpdateConfigurationSettingResponse;

// @public (undocumented)
// @public
export class AppConfigurationClient {
constructor(connectionString: string);
constructor(uri: string, credential: TokenCredential);
// (undocumented)
addConfigurationSetting(key: string, configSettings: AddConfigurationSettingConfig, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingsResponse>;
// (undocumented)
deleteConfigurationSetting(key: string, options: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>;
// (undocumented)
getConfigurationSetting(key: string, options?: GetConfigurationSettingOptions): Promise<GetConfigurationSettingResponse>;
// (undocumented)
listConfigurationSettings(options?: ListConfigurationSettingsOptions): Promise<ListConfigurationSettingsResponse>;
// (undocumented)
listRevisions(options?: ListRevisionsOptions): Promise<ListRevisionsResponse>;
// (undocumented)
setConfigurationSetting(key: string, configSettings: SetConfigurationSettingConfig, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>;
// (undocumented)
updateConfigurationSetting(key: string, configSettings: UpdateConfigurationSettingConfig, options?: UpdateConfigurationSettingOptions): Promise<UpdateConfigurationSettingResponse>;
}

Expand All @@ -50,7 +43,6 @@ export type DeleteConfigurationSettingResponse = ModelDeleteConfigurationSetting

// @public (undocumented)
export interface ETagOption {
// (undocumented)
etag?: string;
}

Expand Down
31 changes: 22 additions & 9 deletions sdk/appconfiguration/app-configuration/src/appConfigCredential.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import * as crypto from "crypto";
import { ServiceClientCredentials, WebResource, URLBuilder } from "@azure/core-http";

/**
* @internal
* @ignore
*/
export class AppConfigCredential implements ServiceClientCredentials {
private credential: string;
private secret: string;
Expand All @@ -10,31 +14,40 @@ export class AppConfigCredential implements ServiceClientCredentials {
this.secret = secret;
}

/**
* Signs a request with the values provided in the credential and secret parameter.
*
* @param {WebResource} webResource The WebResource to be signed.
* @returns {Promise<WebResource>} The signed request object.
Comment thread
richardpark-msft marked this conversation as resolved.
Outdated
*/
signRequest(webResource: WebResource): Promise<WebResource> {
const verb = webResource.method.toUpperCase()
const verb = webResource.method.toUpperCase();
const utcNow = new Date().toUTCString();
const contentHash =
crypto.createHash("sha256")
.update(webResource.body || "")
.digest("base64");
const contentHash = crypto
.createHash("sha256")
.update(webResource.body || "")
.digest("base64");

const signedHeaders = "x-ms-date;host;x-ms-content-sha256";

const url = URLBuilder.parse(webResource.url);
const query = url.getQuery();
const urlPathAndQuery = `${url.getPath()}${ query ? "?" + query : "" }`
const urlPathAndQuery = `${url.getPath()}${query ? "?" + query : ""}`;

const stringToSign = `${verb}\n${urlPathAndQuery}\n${utcNow};${url.getHost()};${contentHash}`;

const decodedSecret = Buffer.from(this.secret, "base64");
var signature =
crypto.createHmac("sha256", decodedSecret)
var signature = crypto
.createHmac("sha256", decodedSecret)
.update(stringToSign)
.digest("base64");

webResource.headers.set("x-ms-date", utcNow);
webResource.headers.set("x-ms-content-sha256", contentHash);
webResource.headers.set("Authorization", `HMAC-SHA256 Credential=${this.credential}, SignedHeaders=${signedHeaders}, Signature=${signature}`);
webResource.headers.set(
"Authorization",
`HMAC-SHA256 Credential=${this.credential}, SignedHeaders=${signedHeaders}, Signature=${signature}`
);

return Promise.resolve(webResource);
}
Expand Down
Loading