Skip to content

Commit ad9a8ba

Browse files
TaojunshenTaojunshen
authored
Merge pull request MicrosoftDocs#262 from MicrosoftDocs/master
CI Update
2 parents d2bd951 + 76f1dd9 commit ad9a8ba

29 files changed

+4298
-4
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ _themes*/
66
node_modules/
77
src/
88
_dependentPackages/
9+
.DS_Store
910

1011
.openpublishing.buildcore.ps1

‎docs-ref-autogen/azure-storage/BlobService.yml

+74-3
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ items:
4949
- 'azure-storage.BlobService#getBlobToStream'
5050
- 'azure-storage.BlobService#getBlobToText'
5151
- 'azure-storage.BlobService#deleteBlob'
52+
- 'azure-storage.BlobService#undeleteBlob'
5253
- 'azure-storage.BlobService#doesBlobExist'
5354
- 'azure-storage.BlobService#deleteBlobIfExists'
5455
- 'azure-storage.BlobService#createBlobSnapshot'
@@ -253,7 +254,7 @@ items:
253254
id: 'azure-storage.BlobService#setServiceProperties'
254255
parent: azure-storage.BlobService
255256
name: 'setServiceProperties(serviceProperties, options, callback)'
256-
summary: "Sets the properties of a storage account's Blob service, including Azure Storage Analytics.\rYou can also use this operation to set the default request version for all incoming requests that do not have a version specified."
257+
summary: "Sets the properties of a storage account's Blob service, including Azure Storage Analytics.\rYou can also use this operation to set the default request version for all incoming requests that do not have a version specified.\rWhen you set blob service properties (such as enabling soft delete), it may take up to 30 seconds to take effect."
257258
fullName: >-
258259
azure-storage.BlobService.setServiceProperties(serviceProperties, options,
259260
callback)
@@ -1472,7 +1473,7 @@ items:
14721473
- id: options.include
14731474
type:
14741475
- string
1475-
description: "Specifies that the response should include one or more of the following subsets: '', 'metadata', 'snapshots', 'uncommittedblobs', 'copy'). \r Please find these values in BlobUtilities.BlobListingDetails. Multiple values can be added separated with a comma (,).\r **Note** that all metadata names returned from the server will be converted to lower case by NodeJS itself as metadata is set via HTTP headers and HTTP header names are case insensitive."
1476+
description: "Specifies that the response should include one or more of the following subsets: '', 'metadata', 'snapshots', 'uncommittedblobs', 'copy', 'deleted'). \r Please find these values in BlobUtilities.BlobListingDetails. Multiple values can be added separated with a comma (,).\r **Note** that all metadata names returned from the server will be converted to lower case by NodeJS itself as metadata is set via HTTP headers and HTTP header names are case insensitive."
14761477
optional: true
14771478
- id: options.locationMode
14781479
type:
@@ -1567,7 +1568,7 @@ items:
15671568
- id: options.include
15681569
type:
15691570
- string
1570-
description: "Specifies that the response should include one or more of the following subsets: '', 'metadata', 'snapshots', 'uncommittedblobs', 'copy').\r Please find these values in BlobUtilities.BlobListingDetails. Multiple values can be added separated with a comma (,).\r **Note** that all metadata names returned from the server will be converted to lower case by NodeJS itself as metadata is set via HTTP headers and HTTP header names are case insensitive."
1571+
description: "Specifies that the response should include one or more of the following subsets: '', 'metadata', 'snapshots', 'uncommittedblobs', 'copy', 'deleted').\r Please find these values in BlobUtilities.BlobListingDetails. Multiple values can be added separated with a comma (,).\r **Note** that all metadata names returned from the server will be converted to lower case by NodeJS itself as metadata is set via HTTP headers and HTTP header names are case insensitive."
15711572
optional: true
15721573
- id: options.locationMode
15731574
type:
@@ -2805,6 +2806,76 @@ items:
28052806
content: 'function deleteBlob(container, blob, options, callback)'
28062807
langs:
28072808
- js
2809+
- uid: 'azure-storage.BlobService#undeleteBlob'
2810+
id: 'azure-storage.BlobService#undeleteBlob'
2811+
parent: azure-storage.BlobService
2812+
name: 'undeleteBlob(container, blob, options, callback)'
2813+
summary: "The undelete Blob operation restores the contents and metadata of soft deleted blob or snapshot.\rAttempting to undelete a blob or snapshot that is not soft deleted will succeed without any changes."
2814+
fullName: 'azure-storage.BlobService.undeleteBlob(container, blob, options, callback)'
2815+
type: Function
2816+
syntax:
2817+
parameters:
2818+
- id: container
2819+
type:
2820+
- string
2821+
description: The container name.
2822+
- id: blob
2823+
type:
2824+
- string
2825+
description: The blob name.
2826+
- id: options
2827+
type:
2828+
- object
2829+
description: The request options.
2830+
optional: true
2831+
- id: options.accessConditions
2832+
type:
2833+
- azure-storage.AccessConditions
2834+
description: The access conditions.
2835+
optional: true
2836+
- id: options.locationMode
2837+
type:
2838+
- azure-storage.LocationMode
2839+
description: "Specifies the location mode used to decide which location the request should be sent to. \r Please see StorageUtilities.LocationMode for the possible values."
2840+
optional: true
2841+
- id: options.timeoutIntervalInMs
2842+
type:
2843+
- azure-storage.int
2844+
description: >-
2845+
The server timeout interval, in milliseconds, to use for the
2846+
request.
2847+
optional: true
2848+
- id: options.clientRequestTimeoutInMs
2849+
type:
2850+
- azure-storage.int
2851+
description: >-
2852+
The timeout of client requests, in milliseconds, to use for the
2853+
request.
2854+
optional: true
2855+
- id: options.maximumExecutionTimeInMs
2856+
type:
2857+
- azure-storage.int
2858+
description: "The maximum execution time, in milliseconds, across all potential retries, to use when making this request.\r The maximum execution time interval begins at the time that the client begins building the request. The maximum\r execution time is checked intermittently while performing requests, and before executing retries."
2859+
optional: true
2860+
- id: options.clientRequestId
2861+
type:
2862+
- string
2863+
description: >-
2864+
A string that represents the client request ID with a 1KB character
2865+
limit.
2866+
optional: true
2867+
- id: options.useNagleAlgorithm
2868+
type:
2869+
- azure-storage.bool
2870+
description: "Determines whether the Nagle algorithm is used; true to use the Nagle algorithm; otherwise, false.\r The default value is false."
2871+
optional: true
2872+
- id: callback
2873+
type:
2874+
- azure-storage.errorOrResponse
2875+
description: "`error` will contain information\r if an error occurs; `response` will contain information related to this operation."
2876+
content: 'function undeleteBlob(container, blob, options, callback)'
2877+
langs:
2878+
- js
28082879
- uid: 'azure-storage.BlobService#doesBlobExist'
28092880
id: 'azure-storage.BlobService#doesBlobExist'
28102881
parent: azure-storage.BlobService

‎docs-ref-autogen/ms-rest-azure/ApplicationTokenCredentials.yml

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
### YamlMime:UniversalReference
2+
items:
3+
- uid: ms-rest-azure.ApplicationTokenCredentials
4+
id: ms-rest-azure.ApplicationTokenCredentials
5+
name: ApplicationTokenCredentials
6+
summary: "Creates a new ApplicationTokenCredentials object.\rSee [Active Directory Quickstart for .Net](https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/) \rfor detailed instructions on creating an Azure Active Directory application."
7+
fullName: ms-rest-azure.ApplicationTokenCredentials
8+
source:
9+
id: ms-rest-azure.ApplicationTokenCredentials
10+
path: runtime\ms-rest-azure\lib\credentials\applicationTokenCredentials.js
11+
startLine: 65
12+
remote:
13+
branch: jsdoc
14+
path: runtime\ms-rest-azure\lib\credentials\applicationTokenCredentials.js
15+
repo: 'https://github.com/Azure/azure-sdk-for-node.git'
16+
type: Class
17+
children:
18+
- 'ms-rest-azure.ApplicationTokenCredentials.#ctor'
19+
- 'ms-rest-azure.ApplicationTokenCredentials#getToken'
20+
- 'ms-rest-azure.ApplicationTokenCredentials#signRequest'
21+
langs:
22+
- js
23+
- id: 'ms-rest-azure.ApplicationTokenCredentials.#ctor'
24+
uid: 'ms-rest-azure.ApplicationTokenCredentials.#ctor'
25+
parent: ms-rest-azure.ApplicationTokenCredentials
26+
name: 'ApplicationTokenCredentials(clientId, domain, secret, options)'
27+
fullName: >-
28+
ms-rest-azure.ApplicationTokenCredentials.ApplicationTokenCredentials(clientId,
29+
domain, secret, options)
30+
summary: ''
31+
type: Constructor
32+
syntax:
33+
parameters:
34+
- id: clientId
35+
type:
36+
- string
37+
description: The active directory application client id.
38+
- id: domain
39+
type:
40+
- string
41+
description: The domain or tenant id containing this application.
42+
- id: secret
43+
type:
44+
- string
45+
description: The authentication secret for the application.
46+
- id: options
47+
type:
48+
- object
49+
description: Object representing optional parameters.
50+
optional: true
51+
- id: options.tokenAudience
52+
type:
53+
- string
54+
description: "The audience for which the token is requested. Valid value is 'graph'. If tokenAudience is provided \rthen domain should also be provided its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format)."
55+
optional: true
56+
- id: options.environment
57+
type:
58+
- undefinedAzureEnvironment
59+
description: The azure environment to authenticate with.
60+
optional: true
61+
- id: options.authorizationScheme
62+
type:
63+
- string
64+
description: The authorization scheme. Default value is 'bearer'.
65+
optional: true
66+
- id: options.tokenCache
67+
type:
68+
- object
69+
description: The token cache. Default value is the MemoryCache object from adal.
70+
optional: true
71+
content: 'new ApplicationTokenCredentials(clientId, domain, secret, options)'
72+
langs:
73+
- js
74+
- uid: 'ms-rest-azure.ApplicationTokenCredentials#getToken'
75+
id: 'ms-rest-azure.ApplicationTokenCredentials#getToken'
76+
parent: ms-rest-azure.ApplicationTokenCredentials
77+
name: getToken(callback)
78+
summary: >-
79+
Tries to get the token from cache initially. If that is unsuccessfull then
80+
it tries to get the token from ADAL.
81+
fullName: ms-rest-azure.ApplicationTokenCredentials.getToken(callback)
82+
type: Function
83+
syntax:
84+
parameters:
85+
- id: callback
86+
type:
87+
- function
88+
description: 'The callback in the form (err, result)'
89+
return:
90+
type:
91+
- function
92+
description: "callback\r {Error} [err] The error if any\r {object} [tokenResponse] The tokenResponse (tokenType and accessToken are the two important properties)."
93+
content: function getToken(callback)
94+
langs:
95+
- js
96+
- uid: 'ms-rest-azure.ApplicationTokenCredentials#signRequest'
97+
id: 'ms-rest-azure.ApplicationTokenCredentials#signRequest'
98+
parent: ms-rest-azure.ApplicationTokenCredentials
99+
name: 'signRequest(The, callback)'
100+
summary: Signs a request with the Authentication header.
101+
fullName: 'ms-rest-azure.ApplicationTokenCredentials.signRequest(The, callback)'
102+
type: Function
103+
syntax:
104+
parameters:
105+
- id: The
106+
type:
107+
- ms-rest-azure.webResource
108+
description: WebResource to be signed.
109+
- id: callback
110+
type:
111+
- function
112+
description: The callback function.
113+
return:
114+
type:
115+
- undefined
116+
description: ''
117+
content: 'function signRequest(The, callback)'
118+
langs:
119+
- js

0 commit comments

Comments
 (0)