diff --git a/packages/@azure/arm-storage/lib/models/blobContainersMappers.ts b/packages/@azure/arm-storage/lib/models/blobContainersMappers.ts index c9fba373b834..72a8be538a41 100644 --- a/packages/@azure/arm-storage/lib/models/blobContainersMappers.ts +++ b/packages/@azure/arm-storage/lib/models/blobContainersMappers.ts @@ -1,59 +1,64 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { + ListContainerItems, + ListContainerItem, AzureEntityResource, + Resource, BaseResource, + ImmutabilityPolicyProperties, + UpdateHistoryProperty, + LegalHoldProperties, + TagProperty, + CloudError, BlobContainer, + LegalHold, + ImmutabilityPolicy, BlobContainersCreateOrUpdateImmutabilityPolicyHeaders, - BlobContainersDeleteImmutabilityPolicyHeaders, - BlobContainersExtendImmutabilityPolicyHeaders, BlobContainersGetImmutabilityPolicyHeaders, + BlobContainersDeleteImmutabilityPolicyHeaders, BlobContainersLockImmutabilityPolicyHeaders, - BlobServiceProperties, - CloudError, - CorsRule, - CorsRules, - CustomDomain, - DateAfterCreation, - DateAfterModification, - DeleteRetentionPolicy, - Encryption, - EncryptionService, - EncryptionServices, - Endpoints, - GeoReplicationStats, - Identity, - ImmutabilityPolicy, - ImmutabilityPolicyProperties, - IPRule, - KeyVaultProperties, - LegalHold, - LegalHoldProperties, - ListContainerItem, - ListContainerItems, + BlobContainersExtendImmutabilityPolicyHeaders, + LeaseContainerRequest, + LeaseContainerResponse, ManagementPolicy, + ManagementPolicySchema, + ManagementPolicyRule, + ManagementPolicyDefinition, ManagementPolicyAction, ManagementPolicyBaseBlob, - ManagementPolicyDefinition, - ManagementPolicyFilter, - ManagementPolicyRule, - ManagementPolicySchema, + DateAfterModification, ManagementPolicySnapShot, - NetworkRuleSet, + DateAfterCreation, + ManagementPolicyFilter, ProxyResource, - Resource, - Restriction, + TrackedResource, + BlobServiceProperties, + CorsRules, + CorsRule, + DeleteRetentionPolicy, + StorageAccount, Sku, SKUCapability, - StorageAccount, - TagProperty, - TrackedResource, - UpdateHistoryProperty, - VirtualNetworkRule + Restriction, + Identity, + Endpoints, + CustomDomain, + Encryption, + EncryptionServices, + EncryptionService, + KeyVaultProperties, + NetworkRuleSet, + VirtualNetworkRule, + IPRule, + GeoReplicationStats } from "../models/mappers"; + diff --git a/packages/@azure/arm-storage/lib/models/blobServicesMappers.ts b/packages/@azure/arm-storage/lib/models/blobServicesMappers.ts index 2dfd1758c9d2..d43ae9e6b394 100644 --- a/packages/@azure/arm-storage/lib/models/blobServicesMappers.ts +++ b/packages/@azure/arm-storage/lib/models/blobServicesMappers.ts @@ -1,52 +1,55 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { - AzureEntityResource, - BaseResource, - BlobContainer, BlobServiceProperties, - CloudError, - CorsRule, + Resource, + BaseResource, CorsRules, - CustomDomain, - DateAfterCreation, - DateAfterModification, + CorsRule, DeleteRetentionPolicy, - Encryption, - EncryptionService, - EncryptionServices, - Endpoints, - GeoReplicationStats, - Identity, - ImmutabilityPolicy, - ImmutabilityPolicyProperties, - IPRule, - KeyVaultProperties, - LegalHoldProperties, - ListContainerItem, + CloudError, ManagementPolicy, + ManagementPolicySchema, + ManagementPolicyRule, + ManagementPolicyDefinition, ManagementPolicyAction, ManagementPolicyBaseBlob, - ManagementPolicyDefinition, - ManagementPolicyFilter, - ManagementPolicyRule, - ManagementPolicySchema, + DateAfterModification, ManagementPolicySnapShot, - NetworkRuleSet, + DateAfterCreation, + ManagementPolicyFilter, ProxyResource, - Resource, - Restriction, - Sku, - SKUCapability, - StorageAccount, - TagProperty, TrackedResource, + AzureEntityResource, + BlobContainer, + ImmutabilityPolicyProperties, UpdateHistoryProperty, - VirtualNetworkRule + LegalHoldProperties, + TagProperty, + ImmutabilityPolicy, + ListContainerItem, + StorageAccount, + Sku, + SKUCapability, + Restriction, + Identity, + Endpoints, + CustomDomain, + Encryption, + EncryptionServices, + EncryptionService, + KeyVaultProperties, + NetworkRuleSet, + VirtualNetworkRule, + IPRule, + GeoReplicationStats } from "../models/mappers"; + diff --git a/packages/@azure/arm-storage/lib/models/index.ts b/packages/@azure/arm-storage/lib/models/index.ts index 07e43a3137d6..d2e7b520952d 100644 --- a/packages/@azure/arm-storage/lib/models/index.ts +++ b/packages/@azure/arm-storage/lib/models/index.ts @@ -1,9 +1,11 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js"; @@ -11,1637 +13,2225 @@ import * as msRest from "@azure/ms-rest-js"; export { BaseResource, CloudError }; + /** + * @interface + * An interface representing OperationDisplay. * Display metadata associated with the operation. + * */ export interface OperationDisplay { /** - * Service provider: Microsoft Storage. + * @member {string} [provider] Service provider: Microsoft Storage. */ provider?: string; /** - * Resource on which the operation is performed etc. + * @member {string} [resource] Resource on which the operation is performed + * etc. */ resource?: string; /** - * Type of operation: get, read, delete, etc. + * @member {string} [operation] Type of operation: get, read, delete, etc. */ operation?: string; /** - * Description of the operation. + * @member {string} [description] Description of the operation. */ description?: string; } /** + * @interface + * An interface representing Dimension. * Dimension of blobs, possibly be blob type or access tier. + * */ export interface Dimension { /** - * Display name of dimension. + * @member {string} [name] Display name of dimension. */ name?: string; /** - * Display name of dimension. + * @member {string} [displayName] Display name of dimension. */ displayName?: string; } /** + * @interface + * An interface representing MetricSpecification. * Metric specification of operation. + * */ export interface MetricSpecification { /** - * Name of metric specification. + * @member {string} [name] Name of metric specification. */ name?: string; /** - * Display name of metric specification. + * @member {string} [displayName] Display name of metric specification. */ displayName?: string; /** - * Display description of metric specification. + * @member {string} [displayDescription] Display description of metric + * specification. */ displayDescription?: string; /** - * Unit could be Bytes or Count. + * @member {string} [unit] Unit could be Bytes or Count. */ unit?: string; /** - * Dimensions of blobs, including blob type and access tier. + * @member {Dimension[]} [dimensions] Dimensions of blobs, including blob + * type and access tier. */ dimensions?: Dimension[]; /** - * Aggregation type could be Average. + * @member {string} [aggregationType] Aggregation type could be Average. */ aggregationType?: string; /** - * The property to decide fill gap with zero or not. + * @member {boolean} [fillGapWithZero] The property to decide fill gap with + * zero or not. */ fillGapWithZero?: boolean; /** - * The category this metric specification belong to, could be Capacity. + * @member {string} [category] The category this metric specification belong + * to, could be Capacity. */ category?: string; /** - * Account Resource Id. + * @member {string} [resourceIdDimensionNameOverride] Account Resource Id. */ resourceIdDimensionNameOverride?: string; } /** + * @interface + * An interface representing ServiceSpecification. * One property of operation, include metric specifications. + * */ export interface ServiceSpecification { /** - * Metric specifications of operation. + * @member {MetricSpecification[]} [metricSpecifications] Metric + * specifications of operation. */ metricSpecifications?: MetricSpecification[]; } /** + * @interface + * An interface representing Operation. * Storage REST API operation definition. + * */ export interface Operation { /** - * Operation name: {provider}/{resource}/{operation} + * @member {string} [name] Operation name: {provider}/{resource}/{operation} */ name?: string; /** - * Display metadata associated with the operation. + * @member {OperationDisplay} [display] Display metadata associated with the + * operation. */ display?: OperationDisplay; /** - * The origin of operations. + * @member {string} [origin] The origin of operations. */ origin?: string; /** - * One property of operation, include metric specifications. + * @member {ServiceSpecification} [serviceSpecification] One property of + * operation, include metric specifications. */ serviceSpecification?: ServiceSpecification; } /** + * @interface + * An interface representing StorageAccountCheckNameAvailabilityParameters. * The parameters used to check the availability of the storage account name. + * */ export interface StorageAccountCheckNameAvailabilityParameters { /** - * The storage account name. + * @member {string} name The storage account name. */ name: string; } /** - * The capability information in the specified SKU, including file encryption, network ACLs, change - * notification, etc. + * @interface + * An interface representing SKUCapability. + * The capability information in the specified SKU, including file encryption, + * network ACLs, change notification, etc. + * */ export interface SKUCapability { /** - * The name of capability, The capability information in the specified SKU, including file - * encryption, network ACLs, change notification, etc. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The name of capability, The capability information + * in the specified SKU, including file encryption, network ACLs, change + * notification, etc. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * A string value to indicate states of given capability. Possibly 'true' or 'false'. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [value] A string value to indicate states of given + * capability. Possibly 'true' or 'false'. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly value?: string; } /** + * @interface + * An interface representing Restriction. * The restriction because of which SKU cannot be used. + * */ export interface Restriction { /** - * The type of restrictions. As of now only possible value for this is location. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The type of restrictions. As of now only possible + * value for this is location. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; /** - * The value of restrictions. If the restriction type is set to location. This would be different - * locations where the SKU is restricted. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string[]} [values] The value of restrictions. If the restriction + * type is set to location. This would be different locations where the SKU + * is restricted. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly values?: string[]; /** - * The reason for the restriction. As of now this can be "QuotaId" or - * "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as - * the subscription does not belong to that quota. The "NotAvailableForSubscription" is related - * to capacity at DC. Possible values include: 'QuotaId', 'NotAvailableForSubscription' + * @member {ReasonCode} [reasonCode] The reason for the restriction. As of + * now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is + * set when the SKU has requiredQuotas parameter as the subscription does not + * belong to that quota. The "NotAvailableForSubscription" is related to + * capacity at DC. Possible values include: 'QuotaId', + * 'NotAvailableForSubscription' */ reasonCode?: ReasonCode; } /** + * @interface + * An interface representing Sku. * The SKU of the storage account. + * */ export interface Sku { /** - * Gets or sets the SKU name. Required for account creation; optional for update. Note that in - * older versions, SKU name was called accountType. Possible values include: 'Standard_LRS', - * 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS', 'Premium_ZRS' + * @member {SkuName} name Gets or sets the SKU name. Required for account + * creation; optional for update. Note that in older versions, SKU name was + * called accountType. Possible values include: 'Standard_LRS', + * 'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS', + * 'Premium_ZRS' */ name: SkuName; /** - * Gets the SKU tier. This is based on the SKU name. Possible values include: 'Standard', - * 'Premium' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {SkuTier} [tier] Gets the SKU tier. This is based on the SKU name. + * Possible values include: 'Standard', 'Premium' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly tier?: SkuTier; /** - * The type of the resource, usually it is 'storageAccounts'. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [resourceType] The type of the resource, usually it is + * 'storageAccounts'. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly resourceType?: string; /** - * Indicates the type of storage account. Possible values include: 'Storage', 'StorageV2', - * 'BlobStorage', 'FileStorage', 'BlockBlobStorage' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Kind} [kind] Indicates the type of storage account. Possible + * values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', + * 'BlockBlobStorage' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly kind?: Kind; /** - * The set of locations that the SKU is available. This will be supported and registered Azure - * Geo Regions (e.g. West US, East US, Southeast Asia, etc.). - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string[]} [locations] The set of locations that the SKU is + * available. This will be supported and registered Azure Geo Regions (e.g. + * West US, East US, Southeast Asia, etc.). + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly locations?: string[]; /** - * The capability information in the specified SKU, including file encryption, network ACLs, - * change notification, etc. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {SKUCapability[]} [capabilities] The capability information in the + * specified SKU, including file encryption, network ACLs, change + * notification, etc. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly capabilities?: SKUCapability[]; /** - * The restrictions because of which SKU cannot be used. This is empty if there are no - * restrictions. + * @member {Restriction[]} [restrictions] The restrictions because of which + * SKU cannot be used. This is empty if there are no restrictions. */ restrictions?: Restriction[]; } /** + * @interface + * An interface representing CheckNameAvailabilityResult. * The CheckNameAvailability operation response. + * */ export interface CheckNameAvailabilityResult { /** - * 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. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @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. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly nameAvailable?: boolean; /** - * 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' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Reason} [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' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly reason?: Reason; /** - * Gets an error message explaining the Reason value in more detail. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [message] Gets an error message explaining the Reason + * value in more detail. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly message?: string; } /** - * The custom domain assigned to this storage account. This can be set via Update. + * @interface + * An interface representing CustomDomain. + * The custom domain assigned to this storage account. This can be set via + * Update. + * */ export interface CustomDomain { /** - * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. + * @member {string} name Gets or sets the custom domain name assigned to the + * storage account. Name is the CNAME source. */ name: string; /** - * Indicates whether indirect CName validation is enabled. Default value is false. This should - * only be set on updates. + * @member {boolean} [useSubDomainName] Indicates whether indirect CName + * validation is enabled. Default value is false. This should only be set on + * updates. */ useSubDomainName?: boolean; } /** + * @interface + * An interface representing EncryptionService. * A service that allows server-side encryption to be used. + * */ export interface EncryptionService { /** - * A boolean indicating whether or not the service encrypts the data as it is stored. + * @member {boolean} [enabled] A boolean indicating whether or not the + * service encrypts the data as it is stored. */ enabled?: boolean; /** - * 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. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @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. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly lastEnabledTime?: Date; } /** + * @interface + * An interface representing EncryptionServices. * A list of services that support encryption. + * */ export interface EncryptionServices { /** - * The encryption function of the blob storage service. + * @member {EncryptionService} [blob] The encryption function of the blob + * storage service. */ blob?: EncryptionService; /** - * The encryption function of the file storage service. + * @member {EncryptionService} [file] The encryption function of the file + * storage service. */ file?: EncryptionService; /** - * The encryption function of the table storage service. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {EncryptionService} [table] The encryption function of the table + * storage service. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly table?: EncryptionService; /** - * The encryption function of the queue storage service. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {EncryptionService} [queue] The encryption function of the queue + * storage service. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly queue?: EncryptionService; } /** + * @interface + * An interface representing KeyVaultProperties. * Properties of key vault. + * */ export interface KeyVaultProperties { /** - * The name of KeyVault key. + * @member {string} [keyName] The name of KeyVault key. */ keyName?: string; /** - * The version of KeyVault key. + * @member {string} [keyVersion] The version of KeyVault key. */ keyVersion?: string; /** - * The Uri of KeyVault. + * @member {string} [keyVaultUri] The Uri of KeyVault. */ keyVaultUri?: string; } /** + * @interface + * An interface representing Encryption. * The encryption settings on the storage account. + * */ export interface Encryption { /** - * List of services which support encryption. + * @member {EncryptionServices} [services] List of services which support + * encryption. */ services?: EncryptionServices; /** - * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, - * Microsoft.Keyvault. Possible values include: 'Microsoft.Storage', 'Microsoft.Keyvault'. - * Default value: 'Microsoft.Storage'. + * @member {KeySource} keySource The encryption keySource (provider). + * Possible values (case-insensitive): Microsoft.Storage, + * Microsoft.Keyvault. Possible values include: 'Microsoft.Storage', + * 'Microsoft.Keyvault'. Default value: 'Microsoft.Storage' . */ keySource: KeySource; /** - * Properties provided by key vault. + * @member {KeyVaultProperties} [keyVaultProperties] Properties provided by + * key vault. */ keyVaultProperties?: KeyVaultProperties; } /** + * @interface + * An interface representing VirtualNetworkRule. * Virtual Network rule. + * */ export interface VirtualNetworkRule { /** - * Resource ID of a subnet, for example: + * @member {string} virtualNetworkResourceId Resource ID of a subnet, for + * example: * /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. */ virtualNetworkResourceId: string; /** - * The action of virtual network rule. Possible values include: 'Allow'. Default value: 'Allow'. + * @member {Action} [action] The action of virtual network rule. Possible + * values include: 'Allow'. Default value: 'Allow' . */ action?: Action; /** - * Gets the state of virtual network rule. Possible values include: 'provisioning', - * 'deprovisioning', 'succeeded', 'failed', 'networkSourceDeleted' + * @member {State} [state] Gets the state of virtual network rule. Possible + * values include: 'provisioning', 'deprovisioning', 'succeeded', 'failed', + * 'networkSourceDeleted' */ state?: State; } /** + * @interface + * An interface representing IPRule. * IP rule with specific IP or IP range in CIDR format. + * */ export interface IPRule { /** - * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. + * @member {string} iPAddressOrRange Specifies the IP or IP range in CIDR + * format. Only IPV4 address is allowed. */ iPAddressOrRange: string; /** - * The action of IP ACL rule. Possible values include: 'Allow'. Default value: 'Allow'. + * @member {Action} [action] The action of IP ACL rule. Possible values + * include: 'Allow'. Default value: 'Allow' . */ action?: Action; } /** + * @interface + * An interface representing NetworkRuleSet. * Network rule set + * */ export interface NetworkRuleSet { /** - * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are - * any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to - * bypass none of those traffics. Possible values include: 'None', 'Logging', 'Metrics', - * 'AzureServices'. Default value: 'AzureServices'. + * @member {Bypass} [bypass] Specifies whether traffic is bypassed for + * Logging/Metrics/AzureServices. Possible values are any combination of + * Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None + * to bypass none of those traffics. Possible values include: 'None', + * 'Logging', 'Metrics', 'AzureServices'. Default value: 'AzureServices' . */ bypass?: Bypass; /** - * Sets the virtual network rules + * @member {VirtualNetworkRule[]} [virtualNetworkRules] Sets the virtual + * network rules */ virtualNetworkRules?: VirtualNetworkRule[]; /** - * Sets the IP ACL rules + * @member {IPRule[]} [ipRules] Sets the IP ACL rules */ ipRules?: IPRule[]; /** - * Specifies the default action of allow or deny when no other rules match. Possible values - * include: 'Allow', 'Deny'. Default value: 'Allow'. + * @member {DefaultAction} defaultAction Specifies the default action of + * allow or deny when no other rules match. Possible values include: 'Allow', + * 'Deny'. Default value: 'Allow' . */ defaultAction: DefaultAction; } /** + * @interface + * An interface representing Identity. * Identity for the resource. + * */ export interface Identity { /** - * The principal ID of resource identity. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [principalId] The principal ID of resource identity. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly principalId?: string; /** - * The tenant ID of resource. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [tenantId] The tenant ID of resource. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly tenantId?: string; } /** + * @interface + * An interface representing StorageAccountCreateParameters. * The parameters used when creating a storage account. + * */ export interface StorageAccountCreateParameters { /** - * Required. Gets or sets the SKU name. + * @member {Sku} sku Required. Gets or sets the SKU name. */ sku: Sku; /** - * Required. Indicates the type of storage account. Possible values include: 'Storage', - * 'StorageV2', 'BlobStorage', 'FileStorage', 'BlockBlobStorage' + * @member {Kind} kind Required. Indicates the type of storage account. + * Possible values include: 'Storage', 'StorageV2', 'BlobStorage', + * 'FileStorage', 'BlockBlobStorage' */ kind: Kind; /** - * Required. Gets or sets the location of the resource. This will be one of the supported and - * registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of - * a resource cannot be changed once it is created, but if an identical geo region is specified - * on update, the request will succeed. + * @member {string} location Required. Gets or sets the location of the + * resource. This will be one of the supported and registered Azure Geo + * Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a + * resource cannot be changed once it is created, but if an identical geo + * region is specified on update, the request will succeed. */ location: string; /** - * Gets or sets a list of key value pairs that describe the resource. These tags can be used for - * viewing and grouping this resource (across resource groups). A maximum of 15 tags can be - * provided for a resource. Each tag must have a key with a length no greater than 128 characters - * and a value with a length no greater than 256 characters. + * @member {{ [propertyName: string]: string }} [tags] Gets or sets a list of + * key value pairs that describe the resource. These tags can be used for + * viewing and grouping this resource (across resource groups). A maximum of + * 15 tags can be provided for a resource. Each tag must have a key with a + * length no greater than 128 characters and a value with a length no greater + * than 256 characters. */ tags?: { [propertyName: string]: string }; /** - * The identity of the resource. + * @member {Identity} [identity] The identity of the resource. */ identity?: Identity; /** - * User domain assigned to the storage account. Name is the CNAME source. Only one custom domain - * is supported per storage account at this time. To clear the existing custom domain, use an + * @member {CustomDomain} [customDomain] User domain assigned to the storage + * account. Name is the CNAME source. Only one custom domain is supported per + * storage account at this time. To clear the existing custom domain, use an * empty string for the custom domain name property. */ customDomain?: CustomDomain; /** - * Provides the encryption settings on the account. If left unspecified the account encryption - * settings will remain the same. The default setting is unencrypted. + * @member {Encryption} [encryption] Provides the encryption settings on the + * account. If left unspecified the account encryption settings will remain + * the same. The default setting is unencrypted. */ encryption?: Encryption; /** - * Network rule set + * @member {NetworkRuleSet} [networkRuleSet] Network rule set */ networkRuleSet?: NetworkRuleSet; /** - * Required for storage accounts where kind = BlobStorage. The access tier used for billing. - * Possible values include: 'Hot', 'Cool' + * @member {AccessTier} [accessTier] Required for storage accounts where kind + * = BlobStorage. The access tier used for billing. Possible values include: + * 'Hot', 'Cool' */ accessTier?: AccessTier; /** - * Enables Azure Files AAD Integration for SMB if sets to true. + * @member {boolean} [enableAzureFilesAadIntegration] Enables Azure Files AAD + * Integration for SMB if sets to true. */ enableAzureFilesAadIntegration?: boolean; /** - * Allows https traffic only to storage service if sets to true. + * @member {boolean} [enableHttpsTrafficOnly] Allows https traffic only to + * storage service if sets to true. */ enableHttpsTrafficOnly?: boolean; /** - * Account HierarchicalNamespace enabled if sets to true. + * @member {boolean} [isHnsEnabled] Account HierarchicalNamespace enabled if + * sets to true. */ isHnsEnabled?: boolean; } /** - * The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. + * @interface + * An interface representing Endpoints. + * The URIs that are used to perform a retrieval of a public blob, queue, + * table, web or dfs object. + * */ export interface Endpoints { /** - * Gets the blob endpoint. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [blob] Gets the blob endpoint. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly blob?: string; /** - * Gets the queue endpoint. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [queue] Gets the queue endpoint. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly queue?: string; /** - * Gets the table endpoint. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [table] Gets the table endpoint. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly table?: string; /** - * Gets the file endpoint. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [file] Gets the file endpoint. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly file?: string; /** - * Gets the web endpoint. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [web] Gets the web endpoint. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly web?: string; /** - * Gets the dfs endpoint. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [dfs] Gets the dfs endpoint. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly dfs?: string; } /** - * Statistics related to replication for storage account's Blob, Table, Queue and File services. It - * is only available when geo-redundant replication is enabled for the storage account. + * @interface + * An interface representing GeoReplicationStats. + * Statistics related to replication for storage account's Blob, Table, Queue + * and File services. It is only available when geo-redundant replication is + * enabled for the storage account. + * */ export interface GeoReplicationStats { /** - * The status of the secondary location. Possible values are: - Live: Indicates that the - * secondary location is active and operational. - Bootstrap: Indicates initial synchronization - * from the primary location to the secondary location is in progress.This typically occurs when - * replication is first enabled. - Unavailable: Indicates that the secondary location is - * temporarily unavailable. Possible values include: 'Live', 'Bootstrap', 'Unavailable' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {GeoReplicationStatus} [status] The status of the secondary + * location. Possible values are: - Live: Indicates that the secondary + * location is active and operational. - Bootstrap: Indicates initial + * synchronization from the primary location to the secondary location is in + * progress.This typically occurs when replication is first enabled. - + * Unavailable: Indicates that the secondary location is temporarily + * unavailable. Possible values include: 'Live', 'Bootstrap', 'Unavailable' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly status?: GeoReplicationStatus; /** - * All primary writes preceding this UTC date/time value are guaranteed to be available for read - * operations. Primary writes following this point in time may or may not be available for reads. - * Element may be default value if value of LastSyncTime is not available, this can happen if - * secondary is offline or we are in bootstrap. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [lastSyncTime] All primary writes preceding this UTC + * date/time value are guaranteed to be available for read operations. + * Primary writes following this point in time may or may not be available + * for reads. Element may be default value if value of LastSyncTime is not + * available, this can happen if secondary is offline or we are in bootstrap. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly lastSyncTime?: Date; /** - * A boolean flag which indicates whether or not account failover is supported for the account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {boolean} [canFailover] A boolean flag which indicates whether or + * not account failover is supported for the account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly canFailover?: boolean; } /** + * @interface * An interface representing Resource. + * @extends BaseResource */ export interface Resource extends BaseResource { /** - * Fully qualified resource Id for the resource. Ex - + * @member {string} [id] Fully qualified resource Id for the resource. Ex - * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly id?: string; /** - * The name of the resource - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [name] The name of the resource + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: string; /** - * The type of the resource. Ex- Microsoft.Compute/virtualMachines or - * Microsoft.Storage/storageAccounts. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [type] The type of the resource. Ex- + * Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly type?: string; } /** + * @interface + * An interface representing TrackedResource. * The resource model definition for a ARM tracked top level resource + * + * @extends Resource */ export interface TrackedResource extends Resource { /** - * Resource tags. + * @member {{ [propertyName: string]: string }} [tags] Resource tags. */ tags?: { [propertyName: string]: string }; /** - * The geo-location where the resource lives + * @member {string} location The geo-location where the resource lives */ location: string; } /** + * @interface + * An interface representing StorageAccount. * The storage account. + * + * @extends TrackedResource */ export interface StorageAccount extends TrackedResource { /** - * Gets the SKU. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Sku} [sku] Gets the SKU. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly sku?: Sku; /** - * Gets the Kind. Possible values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', - * 'BlockBlobStorage' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Kind} [kind] Gets the Kind. Possible values include: 'Storage', + * 'StorageV2', 'BlobStorage', 'FileStorage', 'BlockBlobStorage' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly kind?: Kind; /** - * The identity of the resource. + * @member {Identity} [identity] The identity of the resource. */ identity?: Identity; /** - * Gets the status of the storage account at the time the operation was called. Possible values + * @member {ProvisioningState} [provisioningState] Gets the status of the + * storage account at the time the operation was called. Possible values * include: 'Creating', 'ResolvingDNS', 'Succeeded' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly provisioningState?: ProvisioningState; /** - * Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. - * Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Endpoints} [primaryEndpoints] Gets the URLs that are used to + * perform a retrieval of a public blob, queue, or table object. Note that + * Standard_ZRS and Premium_LRS accounts only return the blob endpoint. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly primaryEndpoints?: Endpoints; /** - * Gets the location of the primary data center for the storage account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [primaryLocation] Gets the location of the primary data + * center for the storage account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly primaryLocation?: string; /** - * Gets the status indicating whether the primary location of the storage account is available or + * @member {AccountStatus} [statusOfPrimary] Gets the status indicating + * whether the primary location of the storage account is available or * unavailable. Possible values include: 'available', 'unavailable' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly statusOfPrimary?: AccountStatus; /** - * Gets the timestamp of the most recent instance of a failover to the secondary location. Only - * the most recent timestamp is retained. This element is not returned if there has never been a - * failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [lastGeoFailoverTime] Gets the timestamp of the most recent + * instance of a failover to the secondary location. Only the most recent + * timestamp is retained. This element is not returned if there has never + * been a failover instance. Only available if the accountType is + * Standard_GRS or Standard_RAGRS. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly lastGeoFailoverTime?: Date; /** - * Gets the location of the geo-replicated secondary for the storage account. Only available if - * the accountType is Standard_GRS or Standard_RAGRS. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [secondaryLocation] Gets the location of the + * geo-replicated secondary for the storage account. Only available if the + * accountType is Standard_GRS or Standard_RAGRS. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly secondaryLocation?: string; /** - * Gets the status indicating whether the secondary location of the storage account is available - * or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS. Possible - * values include: 'available', 'unavailable' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {AccountStatus} [statusOfSecondary] Gets the status indicating + * whether the secondary location of the storage account is available or + * unavailable. Only available if the SKU name is Standard_GRS or + * Standard_RAGRS. Possible values include: 'available', 'unavailable' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly statusOfSecondary?: AccountStatus; /** - * Gets the creation date and time of the storage account in UTC. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [creationTime] Gets the creation date and time of the + * storage account in UTC. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly creationTime?: Date; /** - * Gets the custom domain the user assigned to this storage account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {CustomDomain} [customDomain] Gets the custom domain the user + * assigned to this storage account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly customDomain?: CustomDomain; /** - * Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object - * from the secondary location of the storage account. Only available if the SKU name is - * Standard_RAGRS. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Endpoints} [secondaryEndpoints] Gets the URLs that are used to + * perform a retrieval of a public blob, queue, or table object from the + * secondary location of the storage account. Only available if the SKU name + * is Standard_RAGRS. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly secondaryEndpoints?: Endpoints; /** - * Gets the encryption settings on the account. If unspecified, the account is unencrypted. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Encryption} [encryption] Gets the encryption settings on the + * account. If unspecified, the account is unencrypted. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly encryption?: Encryption; /** - * Required for storage accounts where kind = BlobStorage. The access tier used for billing. - * Possible values include: 'Hot', 'Cool' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {AccessTier} [accessTier] Required for storage accounts where kind + * = BlobStorage. The access tier used for billing. Possible values include: + * 'Hot', 'Cool' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly accessTier?: AccessTier; /** - * Enables Azure Files AAD Integration for SMB if sets to true. + * @member {boolean} [enableAzureFilesAadIntegration] Enables Azure Files AAD + * Integration for SMB if sets to true. */ enableAzureFilesAadIntegration?: boolean; /** - * Allows https traffic only to storage service if sets to true. + * @member {boolean} [enableHttpsTrafficOnly] Allows https traffic only to + * storage service if sets to true. */ enableHttpsTrafficOnly?: boolean; /** - * Network rule set - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {NetworkRuleSet} [networkRuleSet] Network rule set + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly networkRuleSet?: NetworkRuleSet; /** - * Account HierarchicalNamespace enabled if sets to true. + * @member {boolean} [isHnsEnabled] Account HierarchicalNamespace enabled if + * sets to true. */ isHnsEnabled?: boolean; /** - * Geo Replication Stats - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {GeoReplicationStats} [geoReplicationStats] Geo Replication Stats + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly geoReplicationStats?: GeoReplicationStats; /** - * If the failover is in progress, the value will be true, otherwise, it will be null. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {boolean} [failoverInProgress] If the failover is in progress, the + * value will be true, otherwise, it will be null. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly failoverInProgress?: boolean; } /** + * @interface + * An interface representing StorageAccountKey. * An access key for the storage account. + * */ export interface StorageAccountKey { /** - * Name of the key. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [keyName] Name of the key. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly keyName?: string; /** - * Base 64-encoded value of the key. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [value] Base 64-encoded value of the key. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly value?: string; /** - * Permissions for the key -- read-only or full permissions. Possible values include: 'Read', - * 'Full' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {KeyPermission} [permissions] Permissions for the key -- read-only + * or full permissions. Possible values include: 'Read', 'Full' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly permissions?: KeyPermission; } /** + * @interface + * An interface representing StorageAccountListKeysResult. * The response from the ListKeys operation. + * */ export interface StorageAccountListKeysResult { /** - * Gets the list of storage account keys and their properties for the specified storage account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {StorageAccountKey[]} [keys] Gets the list of storage account keys + * and their properties for the specified storage account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly keys?: StorageAccountKey[]; } /** + * @interface + * An interface representing StorageAccountRegenerateKeyParameters. * The parameters used to regenerate the storage account key. + * */ export interface StorageAccountRegenerateKeyParameters { /** - * The name of storage keys that want to be regenerated, possible values are key1, key2. + * @member {string} keyName The name of storage keys that want to be + * regenerated, possible values are key1, key2. */ keyName: string; } /** - * The parameters that can be provided when updating the storage account properties. + * @interface + * An interface representing StorageAccountUpdateParameters. + * The parameters that can be provided when updating the storage account + * properties. + * */ export interface StorageAccountUpdateParameters { /** - * Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, - * Premium_LRS or Premium_ZRS, nor can accounts of those SKU names be updated to any other value. + * @member {Sku} [sku] Gets or sets the SKU name. Note that the SKU name + * cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can + * accounts of those SKU names be updated to any other value. */ sku?: Sku; /** - * Gets or sets a list of key value pairs that describe the resource. These tags can be used in - * viewing and grouping this resource (across resource groups). A maximum of 15 tags can be - * provided for a resource. Each tag must have a key no greater in length than 128 characters and - * a value no greater in length than 256 characters. + * @member {{ [propertyName: string]: string }} [tags] Gets or sets a list of + * key value pairs that describe the resource. These tags can be used in + * viewing and grouping this resource (across resource groups). A maximum of + * 15 tags can be provided for a resource. Each tag must have a key no + * greater in length than 128 characters and a value no greater in length + * than 256 characters. */ tags?: { [propertyName: string]: string }; /** - * The identity of the resource. + * @member {Identity} [identity] The identity of the resource. */ identity?: Identity; /** - * Custom domain assigned to the storage account by the user. Name is the CNAME source. Only one - * custom domain is supported per storage account at this time. To clear the existing custom - * domain, use an empty string for the custom domain name property. + * @member {CustomDomain} [customDomain] Custom domain assigned to the + * storage account by the user. Name is the CNAME source. Only one custom + * domain is supported per storage account at this time. To clear the + * existing custom domain, use an empty string for the custom domain name + * property. */ customDomain?: CustomDomain; /** - * Provides the encryption settings on the account. The default setting is unencrypted. + * @member {Encryption} [encryption] Provides the encryption settings on the + * account. The default setting is unencrypted. */ encryption?: Encryption; /** - * Required for storage accounts where kind = BlobStorage. The access tier used for billing. - * Possible values include: 'Hot', 'Cool' + * @member {AccessTier} [accessTier] Required for storage accounts where kind + * = BlobStorage. The access tier used for billing. Possible values include: + * 'Hot', 'Cool' */ accessTier?: AccessTier; /** - * Enables Azure Files AAD Integration for SMB if sets to true. + * @member {boolean} [enableAzureFilesAadIntegration] Enables Azure Files AAD + * Integration for SMB if sets to true. */ enableAzureFilesAadIntegration?: boolean; /** - * Allows https traffic only to storage service if sets to true. + * @member {boolean} [enableHttpsTrafficOnly] Allows https traffic only to + * storage service if sets to true. */ enableHttpsTrafficOnly?: boolean; /** - * Network rule set + * @member {NetworkRuleSet} [networkRuleSet] Network rule set */ networkRuleSet?: NetworkRuleSet; /** - * Optional. Indicates the type of storage account. Currently only StorageV2 value supported by - * server. Possible values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', + * @member {Kind} [kind] Optional. Indicates the type of storage account. + * Currently only StorageV2 value supported by server. Possible values + * include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', * 'BlockBlobStorage' */ kind?: Kind; } /** + * @interface + * An interface representing UsageName. * The usage names that can be used; currently limited to StorageAccount. + * */ export interface UsageName { /** - * Gets a string describing the resource name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [value] Gets a string describing the resource name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly value?: string; /** - * Gets a localized string describing the resource name. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [localizedValue] Gets a localized string describing the + * resource name. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly localizedValue?: string; } /** + * @interface + * An interface representing Usage. * Describes Storage Resource Usage. + * */ export interface Usage { /** - * Gets the unit of measurement. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', - * 'CountsPerSecond', 'BytesPerSecond' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {UsageUnit} [unit] Gets the unit of measurement. Possible values + * include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountsPerSecond', + * 'BytesPerSecond' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly unit?: UsageUnit; /** - * Gets the current count of the allocated resources in the subscription. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [currentValue] Gets the current count of the allocated + * resources in the subscription. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly currentValue?: number; /** - * Gets the maximum count of the resources that can be allocated in the subscription. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [limit] Gets the maximum count of the resources that can + * be allocated in the subscription. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly limit?: number; /** - * Gets the name of the type of usage. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {UsageName} [name] Gets the name of the type of usage. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly name?: UsageName; } /** + * @interface + * An interface representing AccountSasParameters. * The parameters to list SAS credentials of a storage account. + * */ export interface AccountSasParameters { /** - * 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 {Services} 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' */ services: Services; /** - * 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 {SignedResourceTypes} 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' */ resourceTypes: SignedResourceTypes; /** - * 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 {Permissions} 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' */ permissions: Permissions; /** - * An IP address or a range of IP addresses from which to accept requests. + * @member {string} [iPAddressOrRange] An IP address or a range of IP + * addresses from which to accept requests. */ iPAddressOrRange?: string; /** - * The protocol permitted for a request made with the account SAS. Possible values include: - * 'https,http', 'https' + * @member {HttpProtocol} [protocols] The protocol permitted for a request + * made with the account SAS. Possible values include: 'https,http', 'https' */ protocols?: HttpProtocol; /** - * The time at which the SAS becomes valid. + * @member {Date} [sharedAccessStartTime] The time at which the SAS becomes + * valid. */ sharedAccessStartTime?: Date; /** - * The time at which the shared access signature becomes invalid. + * @member {Date} sharedAccessExpiryTime The time at which the shared access + * signature becomes invalid. */ sharedAccessExpiryTime: Date; /** - * The key to sign the account SAS token with. + * @member {string} [keyToSign] The key to sign the account SAS token with. */ keyToSign?: string; } /** + * @interface + * An interface representing ListAccountSasResponse. * The List SAS credentials operation response. + * */ export interface ListAccountSasResponse { /** - * List SAS credentials of storage account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [accountSasToken] List SAS credentials of storage + * account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly accountSasToken?: string; } /** + * @interface + * An interface representing ServiceSasParameters. * The parameters to list service SAS credentials of a specific resource. + * */ export interface ServiceSasParameters { /** - * The canonical path to the signed resource. + * @member {string} canonicalizedResource The canonical path to the signed + * resource. */ canonicalizedResource: string; /** - * The signed services accessible with the service SAS. Possible values include: Blob (b), - * Container (c), File (f), Share (s). Possible values include: 'b', 'c', 'f', 's' + * @member {SignedResource} [resource] The signed services accessible with + * the service SAS. Possible values include: Blob (b), Container (c), File + * (f), Share (s). Possible values include: 'b', 'c', 'f', 's' */ resource?: SignedResource; /** - * The signed permissions for the service 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 {Permissions} [permissions] The signed permissions for the service + * 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' */ permissions?: Permissions; /** - * An IP address or a range of IP addresses from which to accept requests. + * @member {string} [iPAddressOrRange] An IP address or a range of IP + * addresses from which to accept requests. */ iPAddressOrRange?: string; /** - * The protocol permitted for a request made with the account SAS. Possible values include: - * 'https,http', 'https' + * @member {HttpProtocol} [protocols] The protocol permitted for a request + * made with the account SAS. Possible values include: 'https,http', 'https' */ protocols?: HttpProtocol; /** - * The time at which the SAS becomes valid. + * @member {Date} [sharedAccessStartTime] The time at which the SAS becomes + * valid. */ sharedAccessStartTime?: Date; /** - * The time at which the shared access signature becomes invalid. + * @member {Date} [sharedAccessExpiryTime] The time at which the shared + * access signature becomes invalid. */ sharedAccessExpiryTime?: Date; /** - * A unique value up to 64 characters in length that correlates to an access policy specified for - * the container, queue, or table. + * @member {string} [identifier] A unique value up to 64 characters in length + * that correlates to an access policy specified for the container, queue, or + * table. */ identifier?: string; /** - * The start of partition key. + * @member {string} [partitionKeyStart] The start of partition key. */ partitionKeyStart?: string; /** - * The end of partition key. + * @member {string} [partitionKeyEnd] The end of partition key. */ partitionKeyEnd?: string; /** - * The start of row key. + * @member {string} [rowKeyStart] The start of row key. */ rowKeyStart?: string; /** - * The end of row key. + * @member {string} [rowKeyEnd] The end of row key. */ rowKeyEnd?: string; /** - * The key to sign the account SAS token with. + * @member {string} [keyToSign] The key to sign the account SAS token with. */ keyToSign?: string; /** - * The response header override for cache control. + * @member {string} [cacheControl] The response header override for cache + * control. */ cacheControl?: string; /** - * The response header override for content disposition. + * @member {string} [contentDisposition] The response header override for + * content disposition. */ contentDisposition?: string; /** - * The response header override for content encoding. + * @member {string} [contentEncoding] The response header override for + * content encoding. */ contentEncoding?: string; /** - * The response header override for content language. + * @member {string} [contentLanguage] The response header override for + * content language. */ contentLanguage?: string; /** - * The response header override for content type. + * @member {string} [contentType] The response header override for content + * type. */ contentType?: string; } /** + * @interface + * An interface representing ListServiceSasResponse. * The List service SAS credentials operation response. + * */ export interface ListServiceSasResponse { /** - * List service SAS credentials of specific resource. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [serviceSasToken] List service SAS credentials of + * specific resource. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly serviceSasToken?: string; } /** + * @interface + * An interface representing DateAfterModification. * Object to define the number of days after last modification. + * */ export interface DateAfterModification { /** - * Integer value indicating the age in days after last modification + * @member {number} daysAfterModificationGreaterThan Integer value indicating + * the age in days after last modification */ daysAfterModificationGreaterThan: number; } /** + * @interface + * An interface representing ManagementPolicyBaseBlob. * Management policy action for base blob. + * */ export interface ManagementPolicyBaseBlob { /** - * The function to tier blobs to cool storage. Support blobs currently at Hot tier + * @member {DateAfterModification} [tierToCool] The function to tier blobs to + * cool storage. Support blobs currently at Hot tier */ tierToCool?: DateAfterModification; /** - * The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier + * @member {DateAfterModification} [tierToArchive] The function to tier blobs + * to archive storage. Support blobs currently at Hot or Cool tier */ tierToArchive?: DateAfterModification; /** - * The function to delete the blob + * @member {DateAfterModification} [deleteProperty] The function to delete + * the blob */ deleteProperty?: DateAfterModification; } /** + * @interface + * An interface representing DateAfterCreation. * Object to define the number of days after creation. + * */ export interface DateAfterCreation { /** - * Integer value indicating the age in days after creation + * @member {number} daysAfterCreationGreaterThan Integer value indicating the + * age in days after creation */ daysAfterCreationGreaterThan: number; } /** + * @interface + * An interface representing ManagementPolicySnapShot. * Management policy action for snapshot. + * */ export interface ManagementPolicySnapShot { /** - * The function to delete the blob snapshot + * @member {DateAfterCreation} [deleteProperty] The function to delete the + * blob snapshot */ deleteProperty?: DateAfterCreation; } /** - * Actions are applied to the filtered blobs when the execution condition is met. + * @interface + * An interface representing ManagementPolicyAction. + * Actions are applied to the filtered blobs when the execution condition is + * met. + * */ export interface ManagementPolicyAction { /** - * The management policy action for base blob + * @member {ManagementPolicyBaseBlob} [baseBlob] The management policy action + * for base blob */ baseBlob?: ManagementPolicyBaseBlob; /** - * The management policy action for snapshot + * @member {ManagementPolicySnapShot} [snapshot] The management policy action + * for snapshot */ snapshot?: ManagementPolicySnapShot; } /** - * Filters limit rule actions to a subset of blobs within the storage account. If multiple filters - * are defined, a logical AND is performed on all filters. + * @interface + * An interface representing ManagementPolicyFilter. + * Filters limit rule actions to a subset of blobs within the storage account. + * If multiple filters are defined, a logical AND is performed on all filters. + * */ export interface ManagementPolicyFilter { /** - * An array of strings for prefixes to be match. + * @member {string[]} [prefixMatch] An array of strings for prefixes to be + * match. */ prefixMatch?: string[]; /** - * An array of predefined enum values. Only blockBlob is supported. + * @member {string[]} blobTypes An array of predefined enum values. Only + * blockBlob is supported. */ blobTypes: string[]; } /** - * An object that defines the Lifecycle rule. Each definition is made up with a filters set and an - * actions set. + * @interface + * An interface representing ManagementPolicyDefinition. + * An object that defines the Lifecycle rule. Each definition is made up with a + * filters set and an actions set. + * */ export interface ManagementPolicyDefinition { /** - * An object that defines the action set. + * @member {ManagementPolicyAction} actions An object that defines the action + * set. */ actions: ManagementPolicyAction; /** - * An object that defines the filter set. + * @member {ManagementPolicyFilter} [filters] An object that defines the + * filter set. */ filters?: ManagementPolicyFilter; } /** - * An object that wraps the Lifecycle rule. Each rule is uniquely defined by name. + * @interface + * An interface representing ManagementPolicyRule. + * An object that wraps the Lifecycle rule. Each rule is uniquely defined by + * name. + * */ export interface ManagementPolicyRule { /** - * Rule is enabled if set to true. + * @member {boolean} [enabled] Rule is enabled if set to true. */ enabled?: boolean; /** - * A rule name can contain any combination of alpha numeric characters. Rule name is - * case-sensitive. It must be unique within a policy. + * @member {string} name A rule name can contain any combination of alpha + * numeric characters. Rule name is case-sensitive. It must be unique within + * a policy. */ name: string; /** - * An object that defines the Lifecycle rule. + * @member {ManagementPolicyDefinition} definition An object that defines the + * Lifecycle rule. */ definition: ManagementPolicyDefinition; } /** + * @interface + * An interface representing ManagementPolicySchema. * The Storage Account ManagementPolicies Rules. See more details in: * https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. + * */ export interface ManagementPolicySchema { /** - * The Storage Account ManagementPolicies Rules. See more details in: + * @member {ManagementPolicyRule[]} rules The Storage Account + * ManagementPolicies Rules. See more details in: * https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. */ rules: ManagementPolicyRule[]; } /** + * @interface + * An interface representing ManagementPolicy. * The Get Storage Account ManagementPolicies operation response. + * + * @extends Resource */ export interface ManagementPolicy extends Resource { /** - * Returns the date and time the ManagementPolicies was last modified. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [lastModifiedTime] Returns the date and time the + * ManagementPolicies was last modified. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly lastModifiedTime?: Date; /** - * The Storage Account ManagementPolicy, in JSON format. See more details in: + * @member {ManagementPolicySchema} policy The Storage Account + * ManagementPolicy, in JSON format. See more details in: * https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. */ policy: ManagementPolicySchema; } /** - * The resource model definition for a ARM proxy resource. It will have everything other than - * required location and tags + * @interface + * An interface representing ProxyResource. + * The resource model definition for a ARM proxy resource. It will have + * everything other than required location and tags + * + * @extends Resource */ export interface ProxyResource extends Resource { } /** - * The resource model definition for a Azure Resource Manager resource with an etag. + * @interface + * An interface representing AzureEntityResource. + * The resource model definition for a Azure Resource Manager resource with an + * etag. + * + * @extends Resource */ export interface AzureEntityResource extends Resource { /** - * Resource Etag. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [etag] Resource Etag. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly etag?: string; } /** + * @interface + * An interface representing UpdateHistoryProperty. * An update history of the ImmutabilityPolicy of a blob container. + * */ export interface UpdateHistoryProperty { /** - * The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and + * @member {ImmutabilityPolicyUpdateType} [update] The ImmutabilityPolicy + * update type of a blob container, possible values include: put, lock and * extend. Possible values include: 'put', 'lock', 'extend' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly update?: ImmutabilityPolicyUpdateType; /** - * The immutability period for the blobs in the container since the policy creation, in days. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {number} [immutabilityPeriodSinceCreationInDays] The immutability + * period for the blobs in the container since the policy creation, in days. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly immutabilityPeriodSinceCreationInDays?: number; /** - * Returns the date and time the ImmutabilityPolicy was updated. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [timestamp] Returns the date and time the + * ImmutabilityPolicy was updated. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly timestamp?: Date; /** - * Returns the Object ID of the user who updated the ImmutabilityPolicy. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [objectIdentifier] Returns the Object ID of the user who + * updated the ImmutabilityPolicy. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly objectIdentifier?: string; /** - * Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [tenantId] Returns the Tenant ID that issued the token + * for the user who updated the ImmutabilityPolicy. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly tenantId?: string; /** - * Returns the User Principal Name of the user who updated the ImmutabilityPolicy. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [upn] Returns the User Principal Name of the user who + * updated the ImmutabilityPolicy. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly upn?: string; } /** + * @interface + * An interface representing ImmutabilityPolicyProperties. * The properties of an ImmutabilityPolicy of a blob container. + * */ export interface ImmutabilityPolicyProperties { /** - * The immutability period for the blobs in the container since the policy creation, in days. + * @member {number} immutabilityPeriodSinceCreationInDays The immutability + * period for the blobs in the container since the policy creation, in days. */ immutabilityPeriodSinceCreationInDays: number; /** - * The ImmutabilityPolicy state of a blob container, possible values include: Locked and - * Unlocked. Possible values include: 'Locked', 'Unlocked' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {ImmutabilityPolicyState} [state] The ImmutabilityPolicy state of + * a blob container, possible values include: Locked and Unlocked. Possible + * values include: 'Locked', 'Unlocked' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly state?: ImmutabilityPolicyState; /** - * ImmutabilityPolicy Etag. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [etag] ImmutabilityPolicy Etag. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly etag?: string; /** - * The ImmutabilityPolicy update history of the blob container. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {UpdateHistoryProperty[]} [updateHistory] The ImmutabilityPolicy + * update history of the blob container. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly updateHistory?: UpdateHistoryProperty[]; } /** + * @interface + * An interface representing TagProperty. * A tag of the LegalHold of a blob container. + * */ export interface TagProperty { /** - * The tag value. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [tag] The tag value. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly tag?: string; /** - * Returns the date and time the tag was added. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [timestamp] Returns the date and time the tag was added. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly timestamp?: Date; /** - * Returns the Object ID of the user who added the tag. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [objectIdentifier] Returns the Object ID of the user who + * added the tag. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly objectIdentifier?: string; /** - * Returns the Tenant ID that issued the token for the user who added the tag. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [tenantId] Returns the Tenant ID that issued the token + * for the user who added the tag. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly tenantId?: string; /** - * Returns the User Principal Name of the user who added the tag. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {string} [upn] Returns the User Principal Name of the user who + * added the tag. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly upn?: string; } /** + * @interface + * An interface representing LegalHoldProperties. * The LegalHold property of a blob container. + * */ export interface LegalHoldProperties { /** - * The hasLegalHold public property is set to true by SRP if there are at least one existing tag. - * The hasLegalHold public property is set to false by SRP if all existing legal hold tags are - * cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given - * account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {boolean} [hasLegalHold] The hasLegalHold public property is set + * to true by SRP if there are at least one existing tag. The hasLegalHold + * public property is set to false by SRP if all existing legal hold tags are + * cleared out. There can be a maximum of 1000 blob containers with + * hasLegalHold=true for a given account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly hasLegalHold?: boolean; /** - * The list of LegalHold tags of a blob container. + * @member {TagProperty[]} [tags] The list of LegalHold tags of a blob + * container. */ tags?: TagProperty[]; } /** - * Properties of the blob container, including Id, resource name, resource type, Etag. + * @interface + * An interface representing BlobContainer. + * Properties of the blob container, including Id, resource name, resource + * type, Etag. + * + * @extends AzureEntityResource */ export interface BlobContainer extends AzureEntityResource { /** - * Specifies whether data in the container may be accessed publicly and the level of access. - * Possible values include: 'Container', 'Blob', 'None' + * @member {PublicAccess} [publicAccess] Specifies whether data in the + * container may be accessed publicly and the level of access. Possible + * values include: 'Container', 'Blob', 'None' */ publicAccess?: PublicAccess; /** - * Returns the date and time the container was last modified. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [lastModifiedTime] Returns the date and time the container + * was last modified. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly lastModifiedTime?: Date; /** - * The lease status of the container. Possible values include: 'Locked', 'Unlocked' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {LeaseStatus} [leaseStatus] The lease status of the container. + * Possible values include: 'Locked', 'Unlocked' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly leaseStatus?: LeaseStatus; /** - * Lease state of the container. Possible values include: 'Available', 'Leased', 'Expired', - * 'Breaking', 'Broken' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {LeaseState} [leaseState] Lease state of the container. Possible + * values include: 'Available', 'Leased', 'Expired', 'Breaking', 'Broken' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly leaseState?: LeaseState; /** - * Specifies whether the lease on a container is of infinite or fixed duration, only when the - * container is leased. Possible values include: 'Infinite', 'Fixed' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {LeaseDuration} [leaseDuration] Specifies whether the lease on a + * container is of infinite or fixed duration, only when the container is + * leased. Possible values include: 'Infinite', 'Fixed' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly leaseDuration?: LeaseDuration; /** - * A name-value pair to associate with the container as metadata. + * @member {{ [propertyName: string]: string }} [metadata] A name-value pair + * to associate with the container as metadata. */ metadata?: { [propertyName: string]: string }; /** - * The ImmutabilityPolicy property of the container. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {ImmutabilityPolicyProperties} [immutabilityPolicy] The + * ImmutabilityPolicy property of the container. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly immutabilityPolicy?: ImmutabilityPolicyProperties; /** - * The LegalHold property of the container. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {LegalHoldProperties} [legalHold] The LegalHold property of the + * container. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly legalHold?: LegalHoldProperties; /** - * The hasLegalHold public property is set to true by SRP if there are at least one existing tag. - * The hasLegalHold public property is set to false by SRP if all existing legal hold tags are - * cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given - * account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {boolean} [hasLegalHold] The hasLegalHold public property is set + * to true by SRP if there are at least one existing tag. The hasLegalHold + * public property is set to false by SRP if all existing legal hold tags are + * cleared out. There can be a maximum of 1000 blob containers with + * hasLegalHold=true for a given account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly hasLegalHold?: boolean; /** - * The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been - * created for this container. The hasImmutabilityPolicy public property is set to false by SRP - * if ImmutabilityPolicy has not been created for this container. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {boolean} [hasImmutabilityPolicy] The hasImmutabilityPolicy public + * property is set to true by SRP if ImmutabilityPolicy has been created for + * this container. The hasImmutabilityPolicy public property is set to false + * by SRP if ImmutabilityPolicy has not been created for this container. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly hasImmutabilityPolicy?: boolean; } /** - * The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, - * Etag. + * @interface + * An interface representing ImmutabilityPolicy. + * The ImmutabilityPolicy property of a blob container, including Id, resource + * name, resource type, Etag. + * + * @extends AzureEntityResource */ export interface ImmutabilityPolicy extends AzureEntityResource { /** - * The immutability period for the blobs in the container since the policy creation, in days. + * @member {number} immutabilityPeriodSinceCreationInDays The immutability + * period for the blobs in the container since the policy creation, in days. */ immutabilityPeriodSinceCreationInDays: number; /** - * The ImmutabilityPolicy state of a blob container, possible values include: Locked and - * Unlocked. Possible values include: 'Locked', 'Unlocked' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {ImmutabilityPolicyState} [state] The ImmutabilityPolicy state of + * a blob container, possible values include: Locked and Unlocked. Possible + * values include: 'Locked', 'Unlocked' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly state?: ImmutabilityPolicyState; } /** + * @interface + * An interface representing LegalHold. * The LegalHold property of a blob container. + * */ export interface LegalHold { /** - * The hasLegalHold public property is set to true by SRP if there are at least one existing tag. - * The hasLegalHold public property is set to false by SRP if all existing legal hold tags are - * cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given - * account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {boolean} [hasLegalHold] The hasLegalHold public property is set + * to true by SRP if there are at least one existing tag. The hasLegalHold + * public property is set to false by SRP if all existing legal hold tags are + * cleared out. There can be a maximum of 1000 blob containers with + * hasLegalHold=true for a given account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly hasLegalHold?: boolean; /** - * Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP. + * @member {string[]} tags Each tag should be 3 to 23 alphanumeric characters + * and is normalized to lower case at SRP. */ tags: string[]; } /** + * @interface + * An interface representing ListContainerItem. * The blob container properties be listed out. + * + * @extends AzureEntityResource */ export interface ListContainerItem extends AzureEntityResource { /** - * Specifies whether data in the container may be accessed publicly and the level of access. - * Possible values include: 'Container', 'Blob', 'None' + * @member {PublicAccess} [publicAccess] Specifies whether data in the + * container may be accessed publicly and the level of access. Possible + * values include: 'Container', 'Blob', 'None' */ publicAccess?: PublicAccess; /** - * Returns the date and time the container was last modified. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {Date} [lastModifiedTime] Returns the date and time the container + * was last modified. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly lastModifiedTime?: Date; /** - * The lease status of the container. Possible values include: 'Locked', 'Unlocked' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {LeaseStatus} [leaseStatus] The lease status of the container. + * Possible values include: 'Locked', 'Unlocked' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly leaseStatus?: LeaseStatus; /** - * Lease state of the container. Possible values include: 'Available', 'Leased', 'Expired', - * 'Breaking', 'Broken' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {LeaseState} [leaseState] Lease state of the container. Possible + * values include: 'Available', 'Leased', 'Expired', 'Breaking', 'Broken' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly leaseState?: LeaseState; /** - * Specifies whether the lease on a container is of infinite or fixed duration, only when the - * container is leased. Possible values include: 'Infinite', 'Fixed' - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {LeaseDuration} [leaseDuration] Specifies whether the lease on a + * container is of infinite or fixed duration, only when the container is + * leased. Possible values include: 'Infinite', 'Fixed' + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly leaseDuration?: LeaseDuration; /** - * A name-value pair to associate with the container as metadata. + * @member {{ [propertyName: string]: string }} [metadata] A name-value pair + * to associate with the container as metadata. */ metadata?: { [propertyName: string]: string }; /** - * The ImmutabilityPolicy property of the container. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {ImmutabilityPolicyProperties} [immutabilityPolicy] The + * ImmutabilityPolicy property of the container. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly immutabilityPolicy?: ImmutabilityPolicyProperties; /** - * The LegalHold property of the container. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {LegalHoldProperties} [legalHold] The LegalHold property of the + * container. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly legalHold?: LegalHoldProperties; /** - * The hasLegalHold public property is set to true by SRP if there are at least one existing tag. - * The hasLegalHold public property is set to false by SRP if all existing legal hold tags are - * cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given - * account. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {boolean} [hasLegalHold] The hasLegalHold public property is set + * to true by SRP if there are at least one existing tag. The hasLegalHold + * public property is set to false by SRP if all existing legal hold tags are + * cleared out. There can be a maximum of 1000 blob containers with + * hasLegalHold=true for a given account. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly hasLegalHold?: boolean; /** - * The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been - * created for this container. The hasImmutabilityPolicy public property is set to false by SRP - * if ImmutabilityPolicy has not been created for this container. - * **NOTE: This property will not be serialized. It can only be populated by the server.** + * @member {boolean} [hasImmutabilityPolicy] The hasImmutabilityPolicy public + * property is set to true by SRP if ImmutabilityPolicy has been created for + * this container. The hasImmutabilityPolicy public property is set to false + * by SRP if ImmutabilityPolicy has not been created for this container. + * **NOTE: This property will not be serialized. It can only be populated by + * the server.** */ readonly hasImmutabilityPolicy?: boolean; } /** + * @interface + * An interface representing ListContainerItems. * The list of blob containers. + * */ export interface ListContainerItems { /** - * The list of blob containers. + * @member {ListContainerItem[]} [value] The list of blob containers. */ value?: ListContainerItem[]; } /** + * @interface + * An interface representing CorsRule. * Specifies a CORS rule for the Blob service. + * */ export interface CorsRule { /** - * Required if CorsRule element is present. A list of origin domains that will be allowed via - * CORS, or "*" to allow all domains + * @member {string[]} allowedOrigins Required if CorsRule element is present. + * A list of origin domains that will be allowed via CORS, or "*" to allow + * all domains */ allowedOrigins: string[]; /** - * Required if CorsRule element is present. A list of HTTP methods that are allowed to be - * executed by the origin. + * @member {string[]} allowedMethods Required if CorsRule element is present. + * A list of HTTP methods that are allowed to be executed by the origin. */ allowedMethods: string[]; /** - * Required if CorsRule element is present. The number of seconds that the client/browser should - * cache a preflight response. + * @member {number} maxAgeInSeconds Required if CorsRule element is present. + * The number of seconds that the client/browser should cache a preflight + * response. */ maxAgeInSeconds: number; /** - * Required if CorsRule element is present. A list of response headers to expose to CORS clients. + * @member {string[]} exposedHeaders Required if CorsRule element is present. + * A list of response headers to expose to CORS clients. */ exposedHeaders: string[]; /** - * Required if CorsRule element is present. A list of headers allowed to be part of the - * cross-origin request. + * @member {string[]} allowedHeaders Required if CorsRule element is present. + * A list of headers allowed to be part of the cross-origin request. */ allowedHeaders: string[]; } /** - * Sets the CORS rules. You can include up to five CorsRule elements in the request. + * @interface + * An interface representing CorsRules. + * Sets the CORS rules. You can include up to five CorsRule elements in the + * request. + * */ export interface CorsRules { /** - * The List of CORS rules. You can include up to five CorsRule elements in the request. + * @member {CorsRule[]} [corsRules] The List of CORS rules. You can include + * up to five CorsRule elements in the request. */ corsRules?: CorsRule[]; } /** + * @interface + * An interface representing DeleteRetentionPolicy. * The blob service properties for soft delete. + * */ export interface DeleteRetentionPolicy { /** - * Indicates whether DeleteRetentionPolicy is enabled for the Blob service. + * @member {boolean} [enabled] Indicates whether DeleteRetentionPolicy is + * enabled for the Blob service. */ enabled?: boolean; /** - * Indicates the number of days that the deleted blob should be retained. The minimum specified - * value can be 1 and the maximum value can be 365. + * @member {number} [days] Indicates the number of days that the deleted blob + * should be retained. The minimum specified value can be 1 and the maximum + * value can be 365. */ days?: number; } /** + * @interface + * An interface representing BlobServiceProperties. * The properties of a storage account’s Blob service. + * + * @extends Resource */ export interface BlobServiceProperties extends Resource { /** - * Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the - * request. If no CorsRule elements are included in the request body, all CORS rules will be - * deleted, and CORS will be disabled for the Blob service. + * @member {CorsRules} [cors] Specifies CORS rules for the Blob service. You + * can include up to five CorsRule elements in the request. If no CorsRule + * elements are included in the request body, all CORS rules will be deleted, + * and CORS will be disabled for the Blob service. */ cors?: CorsRules; /** - * DefaultServiceVersion indicates the default version to use for requests to the Blob service if - * an incoming request’s version is not specified. Possible values include version 2008-10-27 and - * all more recent versions. + * @member {string} [defaultServiceVersion] DefaultServiceVersion indicates + * the default version to use for requests to the Blob service if an incoming + * request’s version is not specified. Possible values include version + * 2008-10-27 and all more recent versions. */ defaultServiceVersion?: string; /** - * The blob service properties for soft delete. + * @member {DeleteRetentionPolicy} [deleteRetentionPolicy] The blob service + * properties for soft delete. */ deleteRetentionPolicy?: DeleteRetentionPolicy; } /** + * @interface + * An interface representing LeaseContainerRequest. + * Lease Container request schema. + * + */ +export interface LeaseContainerRequest { + /** + * @member {Action1} action Specifies the lease action. Can be one of the + * available actions. Possible values include: 'Acquire', 'Renew', 'Change', + * 'Release', 'Break' + */ + action: Action1; + /** + * @member {string} [leaseId] Identifies the lease. Can be specified in any + * valid GUID string format. + */ + leaseId?: string; + /** + * @member {number} [breakPeriod] Optional. For a break action, proposed + * duration the lease should continue before it is broken, in seconds, + * between 0 and 60. + */ + breakPeriod?: number; + /** + * @member {number} [leaseDuration] Required for acquire. Specifies the + * duration of the lease, in seconds, or negative one (-1) for a lease that + * never expires. + */ + leaseDuration?: number; + /** + * @member {string} [proposedLeaseId] Optional for acquire, required for + * change. Proposed lease ID, in a GUID string format. + */ + proposedLeaseId?: string; +} + +/** + * @interface + * An interface representing LeaseContainerResponse. + * Lease Container response schema. + * + */ +export interface LeaseContainerResponse { + /** + * @member {string} [leaseId] Returned unique lease ID that must be included + * with any request to delete the container, or to renew, change, or release + * the lease. + */ + leaseId?: string; + /** + * @member {string} [leaseTimeSeconds] Approximate time remaining in the + * lease period, in seconds. + */ + leaseTimeSeconds?: string; +} + +/** + * @interface + * An interface representing StorageAccountsGetPropertiesOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface StorageAccountsGetPropertiesOptionalParams extends msRest.RequestOptionsBase { /** - * May be used to expand the properties within account's properties. By default, data is not - * included when fetching properties. Currently we only support geoReplicationStats. Possible - * values include: 'geoReplicationStats' + * @member {StorageAccountExpand} [expand] May be used to expand the + * properties within account's properties. By default, data is not included + * when fetching properties. Currently we only support geoReplicationStats. + * Possible values include: 'geoReplicationStats' */ expand?: StorageAccountExpand; } /** + * @interface + * An interface representing BlobContainersCreateOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface BlobContainersCreateOptionalParams extends msRest.RequestOptionsBase { /** - * Specifies whether data in the container may be accessed publicly and the level of access. - * Possible values include: 'Container', 'Blob', 'None' + * @member {PublicAccess} [publicAccess] Specifies whether data in the + * container may be accessed publicly and the level of access. Possible + * values include: 'Container', 'Blob', 'None' */ publicAccess?: PublicAccess; /** - * A name-value pair to associate with the container as metadata. + * @member {{ [propertyName: string]: string }} [metadata] A name-value pair + * to associate with the container as metadata. */ metadata?: { [propertyName: string]: string }; } /** + * @interface + * An interface representing BlobContainersUpdateOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface BlobContainersUpdateOptionalParams extends msRest.RequestOptionsBase { /** - * Specifies whether data in the container may be accessed publicly and the level of access. - * Possible values include: 'Container', 'Blob', 'None' + * @member {PublicAccess} [publicAccess] Specifies whether data in the + * container may be accessed publicly and the level of access. Possible + * values include: 'Container', 'Blob', 'None' */ publicAccess?: PublicAccess; /** - * A name-value pair to associate with the container as metadata. + * @member {{ [propertyName: string]: string }} [metadata] A name-value pair + * to associate with the container as metadata. */ metadata?: { [propertyName: string]: string }; } /** + * @interface + * An interface representing BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams extends msRest.RequestOptionsBase { /** - * The entity state (ETag) version of the immutability policy to update. A value of "*" can be - * used to apply the operation only if the immutability policy already exists. If omitted, this + * @member {string} [ifMatch] The entity state (ETag) version of the + * immutability policy to update. A value of "*" can be used to apply the + * operation only if the immutability policy already exists. If omitted, this * operation will always be applied. */ ifMatch?: string; } /** + * @interface + * An interface representing BlobContainersGetImmutabilityPolicyOptionalParams. * Optional Parameters. + * + * @extends RequestOptionsBase */ export interface BlobContainersGetImmutabilityPolicyOptionalParams extends msRest.RequestOptionsBase { /** - * The entity state (ETag) version of the immutability policy to update. A value of "*" can be - * used to apply the operation only if the immutability policy already exists. If omitted, this + * @member {string} [ifMatch] The entity state (ETag) version of the + * immutability policy to update. A value of "*" can be used to apply the + * operation only if the immutability policy already exists. If omitted, this * operation will always be applied. */ ifMatch?: string; } /** + * @interface + * An interface representing BlobContainersLeaseOptionalParams. + * Optional Parameters. + * + * @extends RequestOptionsBase + */ +export interface BlobContainersLeaseOptionalParams extends msRest.RequestOptionsBase { + /** + * @member {LeaseContainerRequest} [parameters] Lease Container request body. + */ + parameters?: LeaseContainerRequest; +} + +/** + * @interface * An interface representing StorageManagementClientOptions. + * @extends AzureServiceClientOptions */ export interface StorageManagementClientOptions extends AzureServiceClientOptions { + /** + * @member {string} [baseUri] + */ baseUri?: string; } /** + * @interface + * An interface representing BlobContainersCreateOrUpdateImmutabilityPolicyHeaders. * Defines headers for CreateOrUpdateImmutabilityPolicy operation. + * */ export interface BlobContainersCreateOrUpdateImmutabilityPolicyHeaders { /** - * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the - * resource has changed between requests. In particular, you can pass the ETag to one of the - * If-Match or If-None-Match headers. + * @member {string} [eTag] The ETag HTTP response header. This is an opaque + * string. You can use it to detect whether the resource has changed between + * requests. In particular, you can pass the ETag to one of the If-Match or + * If-None-Match headers. */ eTag: string; } /** + * @interface + * An interface representing BlobContainersGetImmutabilityPolicyHeaders. * Defines headers for GetImmutabilityPolicy operation. + * */ export interface BlobContainersGetImmutabilityPolicyHeaders { /** - * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the - * resource has changed between requests. In particular, you can pass the ETag to one of the - * If-Match or If-None-Match headers. + * @member {string} [eTag] The ETag HTTP response header. This is an opaque + * string. You can use it to detect whether the resource has changed between + * requests. In particular, you can pass the ETag to one of the If-Match or + * If-None-Match headers. */ eTag: string; } /** + * @interface + * An interface representing BlobContainersDeleteImmutabilityPolicyHeaders. * Defines headers for DeleteImmutabilityPolicy operation. + * */ export interface BlobContainersDeleteImmutabilityPolicyHeaders { /** - * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the - * resource has changed between requests. In particular, you can pass the ETag to one of the - * If-Match or If-None-Match headers. + * @member {string} [eTag] The ETag HTTP response header. This is an opaque + * string. You can use it to detect whether the resource has changed between + * requests. In particular, you can pass the ETag to one of the If-Match or + * If-None-Match headers. */ eTag: string; } /** + * @interface + * An interface representing BlobContainersLockImmutabilityPolicyHeaders. * Defines headers for LockImmutabilityPolicy operation. + * */ export interface BlobContainersLockImmutabilityPolicyHeaders { /** - * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the - * resource has changed between requests. In particular, you can pass the ETag to one of the - * If-Match or If-None-Match headers. + * @member {string} [eTag] The ETag HTTP response header. This is an opaque + * string. You can use it to detect whether the resource has changed between + * requests. In particular, you can pass the ETag to one of the If-Match or + * If-None-Match headers. */ eTag: string; } /** + * @interface + * An interface representing BlobContainersExtendImmutabilityPolicyHeaders. * Defines headers for ExtendImmutabilityPolicy operation. + * */ export interface BlobContainersExtendImmutabilityPolicyHeaders { /** - * The ETag HTTP response header. This is an opaque string. You can use it to detect whether the - * resource has changed between requests. In particular, you can pass the ETag to one of the - * If-Match or If-None-Match headers. + * @member {string} [eTag] The ETag HTTP response header. This is an opaque + * string. You can use it to detect whether the resource has changed between + * requests. In particular, you can pass the ETag to one of the If-Match or + * If-None-Match headers. */ eTag: string; } + /** * @interface - * Result of the request to list Storage operations. It contains a list of operations and a URL - * link to get the next set of results. + * An interface representing the OperationListResult. + * Result of the request to list Storage operations. It contains a list of + * operations and a URL link to get the next set of results. + * * @extends Array */ export interface OperationListResult extends Array { @@ -1649,7 +2239,9 @@ export interface OperationListResult extends Array { /** * @interface + * An interface representing the StorageSkuListResult. * The response from the List Storage SKUs operation. + * * @extends Array */ export interface StorageSkuListResult extends Array { @@ -1657,7 +2249,9 @@ export interface StorageSkuListResult extends Array { /** * @interface + * An interface representing the StorageAccountListResult. * The response from the List Storage Accounts operation. + * * @extends Array */ export interface StorageAccountListResult extends Array { @@ -1665,7 +2259,9 @@ export interface StorageAccountListResult extends Array { /** * @interface + * An interface representing the UsageListResult. * The response from the List Usages operation. + * * @extends Array */ export interface UsageListResult extends Array { @@ -1899,6 +2495,14 @@ export type ImmutabilityPolicyUpdateType = 'put' | 'lock' | 'extend'; */ export type StorageAccountExpand = 'geoReplicationStats'; +/** + * Defines values for Action1. + * Possible values include: 'Acquire', 'Renew', 'Change', 'Release', 'Break' + * @readonly + * @enum {string} + */ +export type Action1 = 'Acquire' | 'Renew' | 'Change' | 'Release' | 'Break'; + /** * Contains response data for the list operation. */ @@ -1911,7 +2515,6 @@ export type OperationsListResponse = OperationListResult & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -1931,7 +2534,6 @@ export type SkusListResponse = StorageSkuListResult & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -1951,7 +2553,6 @@ export type StorageAccountsCheckNameAvailabilityResponse = CheckNameAvailability * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -1971,7 +2572,6 @@ export type StorageAccountsCreateResponse = StorageAccount & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -1991,7 +2591,6 @@ export type StorageAccountsGetPropertiesResponse = StorageAccount & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2011,7 +2610,6 @@ export type StorageAccountsUpdateResponse = StorageAccount & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2031,7 +2629,6 @@ export type StorageAccountsListResponse = StorageAccountListResult & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2051,7 +2648,6 @@ export type StorageAccountsListByResourceGroupResponse = StorageAccountListResul * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2071,7 +2667,6 @@ export type StorageAccountsListKeysResponse = StorageAccountListKeysResult & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2091,7 +2686,6 @@ export type StorageAccountsRegenerateKeyResponse = StorageAccountListKeysResult * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2111,7 +2705,6 @@ export type StorageAccountsListAccountSASResponse = ListAccountSasResponse & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2131,7 +2724,6 @@ export type StorageAccountsListServiceSASResponse = ListServiceSasResponse & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2151,7 +2743,6 @@ export type StorageAccountsBeginCreateResponse = StorageAccount & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2171,7 +2762,6 @@ export type UsagesListByLocationResponse = UsageListResult & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2191,7 +2781,6 @@ export type ManagementPoliciesGetResponse = ManagementPolicy & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2211,7 +2800,6 @@ export type ManagementPoliciesCreateOrUpdateResponse = ManagementPolicy & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2231,7 +2819,6 @@ export type BlobServicesSetServicePropertiesResponse = BlobServiceProperties & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2251,7 +2838,6 @@ export type BlobServicesGetServicePropertiesResponse = BlobServiceProperties & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2271,7 +2857,6 @@ export type BlobContainersListResponse = ListContainerItems & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2291,7 +2876,6 @@ export type BlobContainersCreateResponse = BlobContainer & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2311,7 +2895,6 @@ export type BlobContainersUpdateResponse = BlobContainer & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2331,7 +2914,6 @@ export type BlobContainersGetResponse = BlobContainer & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2351,7 +2933,6 @@ export type BlobContainersSetLegalHoldResponse = LegalHold & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2371,7 +2952,6 @@ export type BlobContainersClearLegalHoldResponse = LegalHold & { * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2391,12 +2971,10 @@ export type BlobContainersCreateOrUpdateImmutabilityPolicyResponse = Immutabilit * The parsed HTTP response headers. */ parsedHeaders: BlobContainersCreateOrUpdateImmutabilityPolicyHeaders; - /** * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2416,12 +2994,10 @@ export type BlobContainersGetImmutabilityPolicyResponse = ImmutabilityPolicy & B * The parsed HTTP response headers. */ parsedHeaders: BlobContainersGetImmutabilityPolicyHeaders; - /** * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2441,12 +3017,10 @@ export type BlobContainersDeleteImmutabilityPolicyResponse = ImmutabilityPolicy * The parsed HTTP response headers. */ parsedHeaders: BlobContainersDeleteImmutabilityPolicyHeaders; - /** * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2466,12 +3040,10 @@ export type BlobContainersLockImmutabilityPolicyResponse = ImmutabilityPolicy & * The parsed HTTP response headers. */ parsedHeaders: BlobContainersLockImmutabilityPolicyHeaders; - /** * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ @@ -2491,15 +3063,32 @@ export type BlobContainersExtendImmutabilityPolicyResponse = ImmutabilityPolicy * The parsed HTTP response headers. */ parsedHeaders: BlobContainersExtendImmutabilityPolicyHeaders; - /** * The response body as text (string format) */ bodyAsText: string; - /** * The response body as parsed JSON or XML */ parsedBody: ImmutabilityPolicy; }; }; + +/** + * Contains response data for the lease operation. + */ +export type BlobContainersLeaseResponse = LeaseContainerResponse & { + /** + * The underlying HTTP response. + */ + _response: msRest.HttpResponse & { + /** + * The response body as text (string format) + */ + bodyAsText: string; + /** + * The response body as parsed JSON or XML + */ + parsedBody: LeaseContainerResponse; + }; +}; diff --git a/packages/@azure/arm-storage/lib/models/managementPoliciesMappers.ts b/packages/@azure/arm-storage/lib/models/managementPoliciesMappers.ts index 2dfd1758c9d2..6aaffedca690 100644 --- a/packages/@azure/arm-storage/lib/models/managementPoliciesMappers.ts +++ b/packages/@azure/arm-storage/lib/models/managementPoliciesMappers.ts @@ -1,52 +1,55 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { - AzureEntityResource, + ManagementPolicy, + Resource, BaseResource, + ManagementPolicySchema, + ManagementPolicyRule, + ManagementPolicyDefinition, + ManagementPolicyAction, + ManagementPolicyBaseBlob, + DateAfterModification, + ManagementPolicySnapShot, + DateAfterCreation, + ManagementPolicyFilter, + CloudError, + ProxyResource, + TrackedResource, + AzureEntityResource, BlobContainer, + ImmutabilityPolicyProperties, + UpdateHistoryProperty, + LegalHoldProperties, + TagProperty, + ImmutabilityPolicy, + ListContainerItem, BlobServiceProperties, - CloudError, - CorsRule, CorsRules, - CustomDomain, - DateAfterCreation, - DateAfterModification, + CorsRule, DeleteRetentionPolicy, + StorageAccount, + Sku, + SKUCapability, + Restriction, + Identity, + Endpoints, + CustomDomain, Encryption, - EncryptionService, EncryptionServices, - Endpoints, - GeoReplicationStats, - Identity, - ImmutabilityPolicy, - ImmutabilityPolicyProperties, - IPRule, + EncryptionService, KeyVaultProperties, - LegalHoldProperties, - ListContainerItem, - ManagementPolicy, - ManagementPolicyAction, - ManagementPolicyBaseBlob, - ManagementPolicyDefinition, - ManagementPolicyFilter, - ManagementPolicyRule, - ManagementPolicySchema, - ManagementPolicySnapShot, NetworkRuleSet, - ProxyResource, - Resource, - Restriction, - Sku, - SKUCapability, - StorageAccount, - TagProperty, - TrackedResource, - UpdateHistoryProperty, - VirtualNetworkRule + VirtualNetworkRule, + IPRule, + GeoReplicationStats } from "../models/mappers"; + diff --git a/packages/@azure/arm-storage/lib/models/mappers.ts b/packages/@azure/arm-storage/lib/models/mappers.ts index 4b7a96c68cb0..9b3e4eef7691 100644 --- a/packages/@azure/arm-storage/lib/models/mappers.ts +++ b/packages/@azure/arm-storage/lib/models/mappers.ts @@ -1,9 +1,11 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ import { CloudErrorMapper, BaseResourceMapper } from "@azure/ms-rest-azure-js"; @@ -2467,6 +2469,69 @@ export const BlobServiceProperties: msRest.CompositeMapper = { } }; +export const LeaseContainerRequest: msRest.CompositeMapper = { + serializedName: "LeaseContainerRequest", + type: { + name: "Composite", + className: "LeaseContainerRequest", + modelProperties: { + action: { + required: true, + serializedName: "action", + type: { + name: "String" + } + }, + leaseId: { + serializedName: "leaseId", + type: { + name: "String" + } + }, + breakPeriod: { + serializedName: "breakPeriod", + type: { + name: "Number" + } + }, + leaseDuration: { + serializedName: "leaseDuration", + type: { + name: "Number" + } + }, + proposedLeaseId: { + serializedName: "proposedLeaseId", + type: { + name: "String" + } + } + } + } +}; + +export const LeaseContainerResponse: msRest.CompositeMapper = { + serializedName: "LeaseContainerResponse", + type: { + name: "Composite", + className: "LeaseContainerResponse", + modelProperties: { + leaseId: { + serializedName: "leaseId", + type: { + name: "String" + } + }, + leaseTimeSeconds: { + serializedName: "leaseTimeSeconds", + type: { + name: "String" + } + } + } + } +}; + export const BlobContainersCreateOrUpdateImmutabilityPolicyHeaders: msRest.CompositeMapper = { serializedName: "blobcontainers-createorupdateimmutabilitypolicy-headers", type: { diff --git a/packages/@azure/arm-storage/lib/models/operationsMappers.ts b/packages/@azure/arm-storage/lib/models/operationsMappers.ts index beff1bb5d45f..b0305ab29a80 100644 --- a/packages/@azure/arm-storage/lib/models/operationsMappers.ts +++ b/packages/@azure/arm-storage/lib/models/operationsMappers.ts @@ -1,17 +1,20 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { - CloudError, - Dimension, - MetricSpecification, + OperationListResult, Operation, OperationDisplay, - OperationListResult, - ServiceSpecification + ServiceSpecification, + MetricSpecification, + Dimension, + CloudError } from "../models/mappers"; + diff --git a/packages/@azure/arm-storage/lib/models/skusMappers.ts b/packages/@azure/arm-storage/lib/models/skusMappers.ts index 790ee0030531..a640f51f2e99 100644 --- a/packages/@azure/arm-storage/lib/models/skusMappers.ts +++ b/packages/@azure/arm-storage/lib/models/skusMappers.ts @@ -1,15 +1,18 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { - CloudError, - Restriction, + StorageSkuListResult, Sku, SKUCapability, - StorageSkuListResult + Restriction, + CloudError } from "../models/mappers"; + diff --git a/packages/@azure/arm-storage/lib/models/storageAccountsMappers.ts b/packages/@azure/arm-storage/lib/models/storageAccountsMappers.ts index 632ef7a59bf6..e38f54b96c86 100644 --- a/packages/@azure/arm-storage/lib/models/storageAccountsMappers.ts +++ b/packages/@azure/arm-storage/lib/models/storageAccountsMappers.ts @@ -1,64 +1,67 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { - AccountSasParameters, - AzureEntityResource, - BaseResource, - BlobContainer, - BlobServiceProperties, + StorageAccountCheckNameAvailabilityParameters, CheckNameAvailabilityResult, CloudError, - CorsRule, - CorsRules, + StorageAccountCreateParameters, + Sku, + SKUCapability, + Restriction, + Identity, CustomDomain, - DateAfterCreation, - DateAfterModification, - DeleteRetentionPolicy, Encryption, - EncryptionService, EncryptionServices, + EncryptionService, + KeyVaultProperties, + NetworkRuleSet, + VirtualNetworkRule, + IPRule, + StorageAccount, + TrackedResource, + Resource, + BaseResource, Endpoints, GeoReplicationStats, - Identity, - ImmutabilityPolicy, - ImmutabilityPolicyProperties, - IPRule, - KeyVaultProperties, - LegalHoldProperties, + StorageAccountUpdateParameters, + StorageAccountListResult, + StorageAccountListKeysResult, + StorageAccountKey, + StorageAccountRegenerateKeyParameters, + AccountSasParameters, ListAccountSasResponse, - ListContainerItem, + ServiceSasParameters, ListServiceSasResponse, ManagementPolicy, + ManagementPolicySchema, + ManagementPolicyRule, + ManagementPolicyDefinition, ManagementPolicyAction, ManagementPolicyBaseBlob, - ManagementPolicyDefinition, - ManagementPolicyFilter, - ManagementPolicyRule, - ManagementPolicySchema, + DateAfterModification, ManagementPolicySnapShot, - NetworkRuleSet, + DateAfterCreation, + ManagementPolicyFilter, ProxyResource, - Resource, - Restriction, - ServiceSasParameters, - Sku, - SKUCapability, - StorageAccount, - StorageAccountCheckNameAvailabilityParameters, - StorageAccountCreateParameters, - StorageAccountKey, - StorageAccountListKeysResult, - StorageAccountListResult, - StorageAccountRegenerateKeyParameters, - StorageAccountUpdateParameters, - TagProperty, - TrackedResource, + AzureEntityResource, + BlobContainer, + ImmutabilityPolicyProperties, UpdateHistoryProperty, - VirtualNetworkRule + LegalHoldProperties, + TagProperty, + ImmutabilityPolicy, + ListContainerItem, + BlobServiceProperties, + CorsRules, + CorsRule, + DeleteRetentionPolicy } from "../models/mappers"; + diff --git a/packages/@azure/arm-storage/lib/models/usagesMappers.ts b/packages/@azure/arm-storage/lib/models/usagesMappers.ts index 1105c1fd870f..a107336dd42c 100644 --- a/packages/@azure/arm-storage/lib/models/usagesMappers.ts +++ b/packages/@azure/arm-storage/lib/models/usagesMappers.ts @@ -1,14 +1,17 @@ /* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for license information. + * Licensed under the MIT License. See License.txt in the project root for + * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is regenerated. + * Changes may cause incorrect behavior and will be lost if the code is + * regenerated. */ export { - CloudError, - Usage, UsageListResult, - UsageName + Usage, + UsageName, + CloudError } from "../models/mappers"; + diff --git a/packages/@azure/arm-storage/lib/operations/blobContainers.ts b/packages/@azure/arm-storage/lib/operations/blobContainers.ts index d67da6da0d96..ff206f3d474a 100644 --- a/packages/@azure/arm-storage/lib/operations/blobContainers.ts +++ b/packages/@azure/arm-storage/lib/operations/blobContainers.ts @@ -733,6 +733,61 @@ export class BlobContainers { extendImmutabilityPolicyOperationSpec, callback) as Promise; } + + /** + * The Lease Container operation establishes and manages a lock on a container for delete + * operations. The lock duration can be 15 to 60 seconds, or can be infinite. + * @param resourceGroupName The name of the resource group within the user's subscription. The name + * is case insensitive. + * @param accountName The name of the storage account within the specified resource group. Storage + * account names must be between 3 and 24 characters in length and use numbers and lower-case + * letters only. + * @param containerName The name of the blob container within the specified storage account. Blob + * container names must be between 3 and 63 characters in length and use numbers, lower-case + * letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by + * a letter or number. + * @param [options] The optional parameters + * @returns Promise + */ + lease(resourceGroupName: string, accountName: string, containerName: string, options?: Models.BlobContainersLeaseOptionalParams): Promise; + /** + * @param resourceGroupName The name of the resource group within the user's subscription. The name + * is case insensitive. + * @param accountName The name of the storage account within the specified resource group. Storage + * account names must be between 3 and 24 characters in length and use numbers and lower-case + * letters only. + * @param containerName The name of the blob container within the specified storage account. Blob + * container names must be between 3 and 63 characters in length and use numbers, lower-case + * letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by + * a letter or number. + * @param callback The callback + */ + lease(resourceGroupName: string, accountName: string, containerName: string, callback: msRest.ServiceCallback): void; + /** + * @param resourceGroupName The name of the resource group within the user's subscription. The name + * is case insensitive. + * @param accountName The name of the storage account within the specified resource group. Storage + * account names must be between 3 and 24 characters in length and use numbers and lower-case + * letters only. + * @param containerName The name of the blob container within the specified storage account. Blob + * container names must be between 3 and 63 characters in length and use numbers, lower-case + * letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by + * a letter or number. + * @param options The optional parameters + * @param callback The callback + */ + lease(resourceGroupName: string, accountName: string, containerName: string, options: Models.BlobContainersLeaseOptionalParams, callback: msRest.ServiceCallback): void; + lease(resourceGroupName: string, accountName: string, containerName: string, options?: Models.BlobContainersLeaseOptionalParams | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { + return this.client.sendOperationRequest( + { + resourceGroupName, + accountName, + containerName, + options + }, + leaseOperationSpec, + callback) as Promise; + } } // Operation Specifications @@ -794,6 +849,9 @@ const createOperationSpec: msRest.OperationSpec = { } }, responses: { + 200: { + bodyMapper: Mappers.BlobContainer + }, 201: { bodyMapper: Mappers.BlobContainer }, @@ -1121,3 +1179,36 @@ const extendImmutabilityPolicyOperationSpec: msRest.OperationSpec = { }, serializer }; + +const leaseOperationSpec: msRest.OperationSpec = { + httpMethod: "POST", + path: "subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/lease", + urlParameters: [ + Parameters.resourceGroupName, + Parameters.accountName, + Parameters.containerName, + Parameters.subscriptionId + ], + queryParameters: [ + Parameters.apiVersion + ], + headerParameters: [ + Parameters.acceptLanguage + ], + requestBody: { + parameterPath: [ + "options", + "parameters" + ], + mapper: Mappers.LeaseContainerRequest + }, + responses: { + 200: { + bodyMapper: Mappers.LeaseContainerResponse + }, + default: { + bodyMapper: Mappers.CloudError + } + }, + serializer +}; diff --git a/packages/@azure/arm-storage/lib/operations/storageAccounts.ts b/packages/@azure/arm-storage/lib/operations/storageAccounts.ts index bd1d217fb299..23f30a744e05 100644 --- a/packages/@azure/arm-storage/lib/operations/storageAccounts.ts +++ b/packages/@azure/arm-storage/lib/operations/storageAccounts.ts @@ -463,6 +463,47 @@ export class StorageAccounts { .then(lroPoller => lroPoller.pollUntilFinished()); } + /** + * Revoke user delegation keys. + * @param resourceGroupName The name of the resource group within the user's subscription. The name + * is case insensitive. + * @param accountName The name of the storage account within the specified resource group. Storage + * account names must be between 3 and 24 characters in length and use numbers and lower-case + * letters only. + * @param [options] The optional parameters + * @returns Promise + */ + revokeUserDelegationKeys(resourceGroupName: string, accountName: string, options?: msRest.RequestOptionsBase): Promise; + /** + * @param resourceGroupName The name of the resource group within the user's subscription. The name + * is case insensitive. + * @param accountName The name of the storage account within the specified resource group. Storage + * account names must be between 3 and 24 characters in length and use numbers and lower-case + * letters only. + * @param callback The callback + */ + revokeUserDelegationKeys(resourceGroupName: string, accountName: string, callback: msRest.ServiceCallback): void; + /** + * @param resourceGroupName The name of the resource group within the user's subscription. The name + * is case insensitive. + * @param accountName The name of the storage account within the specified resource group. Storage + * account names must be between 3 and 24 characters in length and use numbers and lower-case + * letters only. + * @param options The optional parameters + * @param callback The callback + */ + revokeUserDelegationKeys(resourceGroupName: string, accountName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback): void; + revokeUserDelegationKeys(resourceGroupName: string, accountName: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { + return this.client.sendOperationRequest( + { + resourceGroupName, + accountName, + options + }, + revokeUserDelegationKeysOperationSpec, + callback); + } + /** * Asynchronously creates a new storage account with the specified parameters. If an account is * already created and a subsequent create request is issued with different properties, the account @@ -799,6 +840,29 @@ const listServiceSASOperationSpec: msRest.OperationSpec = { serializer }; +const revokeUserDelegationKeysOperationSpec: msRest.OperationSpec = { + httpMethod: "POST", + path: "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/revokeUserDelegationKeys", + urlParameters: [ + Parameters.resourceGroupName, + Parameters.accountName, + Parameters.subscriptionId + ], + queryParameters: [ + Parameters.apiVersion + ], + headerParameters: [ + Parameters.acceptLanguage + ], + responses: { + 200: {}, + default: { + bodyMapper: Mappers.CloudError + } + }, + serializer +}; + const beginCreateOperationSpec: msRest.OperationSpec = { httpMethod: "PUT", path: "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}", diff --git a/packages/@azure/arm-storage/lib/storageManagementClientContext.ts b/packages/@azure/arm-storage/lib/storageManagementClientContext.ts index a779f4afe0a2..6b276ea40ab7 100644 --- a/packages/@azure/arm-storage/lib/storageManagementClientContext.ts +++ b/packages/@azure/arm-storage/lib/storageManagementClientContext.ts @@ -13,7 +13,7 @@ import * as msRest from "@azure/ms-rest-js"; import * as msRestAzure from "@azure/ms-rest-azure-js"; const packageName = "@azure/arm-storage"; -const packageVersion = "7.0.1"; +const packageVersion = "8.0.0"; export class StorageManagementClientContext extends msRestAzure.AzureServiceClient { credentials: msRest.ServiceClientCredentials; diff --git a/packages/@azure/arm-storage/package.json b/packages/@azure/arm-storage/package.json index 6ae6124414da..fe35bee861c4 100644 --- a/packages/@azure/arm-storage/package.json +++ b/packages/@azure/arm-storage/package.json @@ -4,8 +4,8 @@ "description": "StorageManagementClient Library with typescript type definitions for node.js and browser.", "version": "8.0.0", "dependencies": { - "@azure/ms-rest-azure-js": "^1.3.2", - "@azure/ms-rest-js": "^1.6.0", + "@azure/ms-rest-azure-js": "^1.2.0", + "@azure/ms-rest-js": "^1.2.0", "tslib": "^1.9.3" }, "keywords": [ @@ -44,7 +44,6 @@ "esm/**/*.d.ts", "esm/**/*.d.ts.map", "lib/**/*.ts", - "README.md", "rollup.config.js", "tsconfig.json" ], @@ -53,6 +52,5 @@ "minify": "uglifyjs -c -m --comments --source-map \"content='./dist/arm-storage.js.map'\" -o ./dist/arm-storage.min.js ./dist/arm-storage.js", "prepack": "npm install && npm run build" }, - "sideEffects": false, - "autoPublish": true + "sideEffects": false }