Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.
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
56 changes: 24 additions & 32 deletions lib/services/storageManagement2/lib/models/accountSasParameters.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,42 +11,34 @@
'use strict';

/**
* @class
* Initializes a new instance of the AccountSasParameters class.
* @constructor
* The parameters to list SAS credentials of a storage account.
*
* @member {string} services The signed services accessible with the account
* SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
* Possible values include: 'b', 'q', 't', 'f'
*
* @member {string} resourceTypes The signed resource types that are accessible
* with the account SAS. Service (s): Access to service-level APIs; Container
* (c): Access to container-level APIs; Object (o): Access to object-level APIs
* for blobs, queue messages, table entities, and files. Possible values
* include: 's', 'c', 'o'
*
* @member {string} permissions The signed permissions for the account SAS.
* Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a),
* Create (c), Update (u) and Process (p). Possible values include: 'r', 'd',
* 'w', 'l', 'a', 'c', 'u', 'p'
*
* @member {string} [iPAddressOrRange] An IP address or a range of IP addresses
* from which to accept requests.
*
* @member {string} [protocols] The protocol permitted for a request made with
* the account SAS. Possible values include: 'https,http', 'https'
*
* @member {date} [sharedAccessStartTime] The time at which the SAS becomes
* valid.
*
* @member {date} sharedAccessExpiryTime The time at which the shared access
* signature becomes invalid.
*
* @member {string} [keyToSign] The key to sign the account SAS token with.
*
*/
class AccountSasParameters {
/**
* Create a AccountSasParameters.
* @member {string} services The signed services accessible with the account
* SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
* Possible values include: 'b', 'q', 't', 'f'
* @member {string} resourceTypes The signed resource types that are
* accessible with the account SAS. Service (s): Access to service-level
* APIs; Container (c): Access to container-level APIs; Object (o): Access to
* object-level APIs for blobs, queue messages, table entities, and files.
* Possible values include: 's', 'c', 'o'
* @member {string} permissions The signed permissions for the account SAS.
* Possible values include: Read (r), Write (w), Delete (d), List (l), Add
* (a), Create (c), Update (u) and Process (p). Possible values include: 'r',
* 'd', 'w', 'l', 'a', 'c', 'u', 'p'
* @member {string} [iPAddressOrRange] An IP address or a range of IP
* addresses from which to accept requests.
* @member {string} [protocols] The protocol permitted for a request made
* with the account SAS. Possible values include: 'https,http', 'https'
* @member {date} [sharedAccessStartTime] The time at which the SAS becomes
* valid.
* @member {date} sharedAccessExpiryTime The time at which the shared access
* signature becomes invalid.
* @member {string} [keyToSign] The key to sign the account SAS token with.
*/
constructor() {
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,22 @@
'use strict';

/**
* @class
* Initializes a new instance of the CheckNameAvailabilityResult class.
* @constructor
* The CheckNameAvailability operation response.
*
* @member {boolean} [nameAvailable] Gets a boolean value that indicates
* whether the name is available for you to use. If true, the name is
* available. If false, the name has already been taken or is invalid and
* cannot be used.
*
* @member {string} [reason] Gets the reason that a storage account name could
* not be used. The Reason element is only returned if NameAvailable is false.
* Possible values include: 'AccountNameInvalid', 'AlreadyExists'
*
* @member {string} [message] Gets an error message explaining the Reason value
* in more detail.
*
*/
class CheckNameAvailabilityResult {
/**
* Create a CheckNameAvailabilityResult.
* @member {boolean} [nameAvailable] Gets a boolean value that indicates
* whether the name is available for you to use. If true, the name is
* available. If false, the name has already been taken or is invalid and
* cannot be used.
* @member {string} [reason] Gets the reason that a storage account name
* could not be used. The Reason element is only returned if NameAvailable is
* false. Possible values include: 'AccountNameInvalid', 'AlreadyExists'
* @member {string} [message] Gets an error message explaining the Reason
* value in more detail.
*/
constructor() {
}

Expand Down
17 changes: 8 additions & 9 deletions lib/services/storageManagement2/lib/models/customDomain.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,19 @@
'use strict';

/**
* @class
* Initializes a new instance of the CustomDomain class.
* @constructor
* The custom domain assigned to this storage account. This can be set via
* Update.
*
* @member {string} name Gets or sets the custom domain name assigned to the
* storage account. Name is the CNAME source.
*
* @member {boolean} [useSubDomain] Indicates whether indirect CName validation
* is enabled. Default value is false. This should only be set on updates.
*
*/
class CustomDomain {
/**
* Create a CustomDomain.
* @member {string} name Gets or sets the custom domain name assigned to the
* storage account. Name is the CNAME source.
* @member {boolean} [useSubDomain] Indicates whether indirect CName
* validation is enabled. Default value is false. This should only be set on
* updates.
*/
constructor() {
}

Expand Down
14 changes: 6 additions & 8 deletions lib/services/storageManagement2/lib/models/dimension.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,15 @@
'use strict';

/**
* @class
* Initializes a new instance of the Dimension class.
* @constructor
* Dimensions.
*
* @member {string} [name] Display name of dimension.
*
* @member {string} [displayName] Display name of dimension.
* Dimension of blobs, possiblly be blob type or access tier.
*
*/
class Dimension {
/**
* Create a Dimension.
* @member {string} [name] Display name of dimension.
* @member {string} [displayName] Display name of dimension.
*/
constructor() {
}

Expand Down
108 changes: 45 additions & 63 deletions lib/services/storageManagement2/lib/models/encryption.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,73 +13,55 @@
const models = require('./index');

/**
* @class
* Initializes a new instance of the Encryption class.
* @constructor
* The encryption settings on the storage account.
*
* @member {object} [services] List of services which support encryption.
*
* @member {object} [services.blob] The encryption function of the blob storage
* service.
*
* @member {boolean} [services.blob.enabled] A boolean indicating whether or
* not the service encrypts the data as it is stored.
*
* @member {date} [services.blob.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*
* @member {object} [services.file] The encryption function of the file storage
* service.
*
* @member {boolean} [services.file.enabled] A boolean indicating whether or
* not the service encrypts the data as it is stored.
*
* @member {date} [services.file.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*
* @member {object} [services.table] The encryption function of the table
* storage service.
*
* @member {boolean} [services.table.enabled] A boolean indicating whether or
* not the service encrypts the data as it is stored.
*
* @member {date} [services.table.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*
* @member {object} [services.queue] The encryption function of the queue
* storage service.
*
* @member {boolean} [services.queue.enabled] A boolean indicating whether or
* not the service encrypts the data as it is stored.
*
* @member {date} [services.queue.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*
* @member {string} keySource The encryption keySource (provider). Possible
* values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. Possible
* values include: 'Microsoft.Storage', 'Microsoft.Keyvault'. Default value:
* 'Microsoft.Storage' .
*
* @member {object} [keyVaultProperties] Properties provided by key vault.
*
* @member {string} [keyVaultProperties.keyName] The name of KeyVault key.
*
* @member {string} [keyVaultProperties.keyVersion] The version of KeyVault
* key.
*
* @member {string} [keyVaultProperties.keyVaultUri] The Uri of KeyVault.
*
*/
class Encryption {
/**
* Create a Encryption.
* @member {object} [services] List of services which support encryption.
* @member {object} [services.blob] The encryption function of the blob
* storage service.
* @member {boolean} [services.blob.enabled] A boolean indicating whether or
* not the service encrypts the data as it is stored.
* @member {date} [services.blob.lastEnabledTime] Gets a rough estimate of
* the date/time when the encryption was last enabled by the user. Only
* returned when encryption is enabled. There might be some unencrypted blobs
* which were written after this time, as it is just a rough estimate.
* @member {object} [services.file] The encryption function of the file
* storage service.
* @member {boolean} [services.file.enabled] A boolean indicating whether or
* not the service encrypts the data as it is stored.
* @member {date} [services.file.lastEnabledTime] Gets a rough estimate of
* the date/time when the encryption was last enabled by the user. Only
* returned when encryption is enabled. There might be some unencrypted blobs
* which were written after this time, as it is just a rough estimate.
* @member {object} [services.table] The encryption function of the table
* storage service.
* @member {boolean} [services.table.enabled] A boolean indicating whether or
* not the service encrypts the data as it is stored.
* @member {date} [services.table.lastEnabledTime] Gets a rough estimate of
* the date/time when the encryption was last enabled by the user. Only
* returned when encryption is enabled. There might be some unencrypted blobs
* which were written after this time, as it is just a rough estimate.
* @member {object} [services.queue] The encryption function of the queue
* storage service.
* @member {boolean} [services.queue.enabled] A boolean indicating whether or
* not the service encrypts the data as it is stored.
* @member {date} [services.queue.lastEnabledTime] Gets a rough estimate of
* the date/time when the encryption was last enabled by the user. Only
* returned when encryption is enabled. There might be some unencrypted blobs
* which were written after this time, as it is just a rough estimate.
* @member {string} keySource The encryption keySource (provider). Possible
* values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.
* Possible values include: 'Microsoft.Storage', 'Microsoft.Keyvault'.
* Default value: 'Microsoft.Storage' .
* @member {object} [keyVaultProperties] Properties provided by key vault.
* @member {string} [keyVaultProperties.keyName] The name of KeyVault key.
* @member {string} [keyVaultProperties.keyVersion] The version of KeyVault
* key.
* @member {string} [keyVaultProperties.keyVaultUri] The Uri of KeyVault.
*/
constructor() {
}

Expand Down
20 changes: 9 additions & 11 deletions lib/services/storageManagement2/lib/models/encryptionService.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,19 @@
'use strict';

/**
* @class
* Initializes a new instance of the EncryptionService class.
* @constructor
* A service that allows server-side encryption to be used.
*
* @member {boolean} [enabled] A boolean indicating whether or not the service
* encrypts the data as it is stored.
*
* @member {date} [lastEnabledTime] Gets a rough estimate of the date/time when
* the encryption was last enabled by the user. Only returned when encryption
* is enabled. There might be some unencrypted blobs which were written after
* this time, as it is just a rough estimate.
*
*/
class EncryptionService {
/**
* Create a EncryptionService.
* @member {boolean} [enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
* @member {date} [lastEnabledTime] Gets a rough estimate of the date/time
* when the encryption was last enabled by the user. Only returned when
* encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*/
constructor() {
}

Expand Down
80 changes: 35 additions & 45 deletions lib/services/storageManagement2/lib/models/encryptionServices.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,55 +13,45 @@
const models = require('./index');

/**
* @class
* Initializes a new instance of the EncryptionServices class.
* @constructor
* A list of services that support encryption.
*
* @member {object} [blob] The encryption function of the blob storage service.
*
* @member {boolean} [blob.enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
*
* @member {date} [blob.lastEnabledTime] Gets a rough estimate of the date/time
* when the encryption was last enabled by the user. Only returned when
* encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*
* @member {object} [file] The encryption function of the file storage service.
*
* @member {boolean} [file.enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
*
* @member {date} [file.lastEnabledTime] Gets a rough estimate of the date/time
* when the encryption was last enabled by the user. Only returned when
* encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*
* @member {object} [table] The encryption function of the table storage
* service.
*
* @member {boolean} [table.enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
*
* @member {date} [table.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*
* @member {object} [queue] The encryption function of the queue storage
* service.
*
* @member {boolean} [queue.enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
*
* @member {date} [queue.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which were
* written after this time, as it is just a rough estimate.
*
*/
class EncryptionServices {
/**
* Create a EncryptionServices.
* @member {object} [blob] The encryption function of the blob storage
* service.
* @member {boolean} [blob.enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
* @member {date} [blob.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which
* were written after this time, as it is just a rough estimate.
* @member {object} [file] The encryption function of the file storage
* service.
* @member {boolean} [file.enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
* @member {date} [file.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which
* were written after this time, as it is just a rough estimate.
* @member {object} [table] The encryption function of the table storage
* service.
* @member {boolean} [table.enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
* @member {date} [table.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which
* were written after this time, as it is just a rough estimate.
* @member {object} [queue] The encryption function of the queue storage
* service.
* @member {boolean} [queue.enabled] A boolean indicating whether or not the
* service encrypts the data as it is stored.
* @member {date} [queue.lastEnabledTime] Gets a rough estimate of the
* date/time when the encryption was last enabled by the user. Only returned
* when encryption is enabled. There might be some unencrypted blobs which
* were written after this time, as it is just a rough estimate.
*/
constructor() {
}

Expand Down
Loading