@azure/arm-storage 17.0.1-alpha.20220208.1 → 17.1.0

package/src/storageManagementClient.ts

@@ -19,6 +19,7 @@ import {
   PrivateEndpointConnectionsImpl,
   PrivateLinkResourcesImpl,
   ObjectReplicationPoliciesOperationsImpl,
+  LocalUsersOperationsImpl,
   EncryptionScopesImpl,
   BlobServicesImpl,
   BlobContainersImpl,
@@ -40,6 +41,7 @@ import {
   PrivateEndpointConnections,
   PrivateLinkResources,
   ObjectReplicationPoliciesOperations,
+  LocalUsersOperations,
   EncryptionScopes,
   BlobServices,
   BlobContainers,
@@ -84,7 +86,7 @@ export class StorageManagementClient extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-storage/17.0.0`;
+    const packageDetails = `azsdk-js-arm-storage/17.1.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -107,7 +109,7 @@ export class StorageManagementClient extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2021-06-01";
+    this.apiVersion = options.apiVersion || "2021-08-01";
     this.operations = new OperationsImpl(this);
     this.skus = new SkusImpl(this);
     this.storageAccounts = new StorageAccountsImpl(this);
@@ -120,6 +122,7 @@ export class StorageManagementClient extends coreClient.ServiceClient {
     this.objectReplicationPoliciesOperations = new ObjectReplicationPoliciesOperationsImpl(
       this
     );
+    this.localUsersOperations = new LocalUsersOperationsImpl(this);
     this.encryptionScopes = new EncryptionScopesImpl(this);
     this.blobServices = new BlobServicesImpl(this);
     this.blobContainers = new BlobContainersImpl(this);
@@ -141,6 +144,7 @@ export class StorageManagementClient extends coreClient.ServiceClient {
   privateEndpointConnections: PrivateEndpointConnections;
   privateLinkResources: PrivateLinkResources;
   objectReplicationPoliciesOperations: ObjectReplicationPoliciesOperations;
+  localUsersOperations: LocalUsersOperations;
   encryptionScopes: EncryptionScopes;
   blobServices: BlobServices;
   blobContainers: BlobContainers;

package/tsconfig.json

@@ -9,11 +9,24 @@
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
     "forceConsistentCasingInFileNames": true,
-    "lib": ["es6", "dom"],
+    "lib": [
+      "es6",
+      "dom"
+    ],
     "declaration": true,
     "outDir": "./dist-esm",
-    "importHelpers": true
+    "importHelpers": true,
+    "paths": {
+      "@azure/arm-storage": [
+        "./src/index"
+      ]
+    }
   },
-  "include": ["./src/**/*.ts", "./test/**/*.ts"],
-  "exclude": ["node_modules"]
-}
+  "include": [
+    "./src/**/*.ts",
+    "./test/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

package/types/arm-storage.d.ts

@@ -74,8 +74,32 @@ export declare interface ActiveDirectoryProperties {
     domainSid: string;
     /** Specifies the security identifier (SID) for Azure Storage. */
     azureStorageSid: string;
+    /** Specifies the Active Directory SAMAccountName for Azure Storage. */
+    samAccountName?: string;
+    /** Specifies the Active Directory account type for Azure Storage. */
+    accountType?: ActiveDirectoryPropertiesAccountType;
 }
 
+/**
+ * Defines values for ActiveDirectoryPropertiesAccountType. \
+ * {@link KnownActiveDirectoryPropertiesAccountType} can be used interchangeably with ActiveDirectoryPropertiesAccountType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User** \
+ * **Computer**
+ */
+export declare type ActiveDirectoryPropertiesAccountType = string;
+
+/**
+ * Defines values for AllowedCopyScope. \
+ * {@link KnownAllowedCopyScope} can be used interchangeably with AllowedCopyScope,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **PrivateLink** \
+ * **AAD**
+ */
+export declare type AllowedCopyScope = string;
+
 /** The resource model definition for an Azure Resource Manager resource with an etag. */
 export declare type AzureEntityResource = Resource & {
     /**
@@ -912,12 +936,6 @@ export declare interface CloudError {
     error?: CloudErrorBody;
 }
 
-/** An error response from the Storage service. */
-export declare interface CloudErrorAutoGenerated {
-    /** An error response from the Storage service. */
-    error?: CloudErrorBodyAutoGenerated;
-}
-
 /** An error response from the Storage service. */
 export declare interface CloudErrorBody {
     /** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
@@ -930,18 +948,6 @@ export declare interface CloudErrorBody {
     details?: CloudErrorBody[];
 }
 
-/** An error response from the Storage service. */
-export declare interface CloudErrorBodyAutoGenerated {
-    /** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
-    code?: string;
-    /** A message describing the error, intended to be suitable for display in a user interface. */
-    message?: string;
-    /** The target of the particular error. For example, the name of the property in error. */
-    target?: string;
-    /** A list of additional details about the error. */
-    details?: CloudErrorBodyAutoGenerated[];
-}
-
 /** Specifies a CORS rule for the Blob service. */
 export declare interface CorsRule {
     /** Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains */
@@ -1169,6 +1175,8 @@ export declare interface Encryption {
 export declare interface EncryptionIdentity {
     /** Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. */
     encryptionUserAssignedIdentity?: string;
+    /** ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. */
+    encryptionFederatedIdentityClientId?: string;
 }
 
 /** The Encryption Scope resource. */
@@ -1341,10 +1349,10 @@ export declare type EncryptionScopeState = string;
 
 /** A service that allows server-side encryption to be used. */
 export declare interface EncryptionService {
-    /** A boolean indicating whether or not the service encrypts the data as it is stored. */
+    /** A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. */
     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.
+     * Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly lastEnabledTime?: Date;
@@ -2128,6 +2136,18 @@ export declare enum KnownAccountImmutabilityPolicyState {
     Disabled = "Disabled"
 }
 
+/** Known values of {@link ActiveDirectoryPropertiesAccountType} that the service accepts. */
+export declare enum KnownActiveDirectoryPropertiesAccountType {
+    User = "User",
+    Computer = "Computer"
+}
+
+/** Known values of {@link AllowedCopyScope} that the service accepts. */
+export declare enum KnownAllowedCopyScope {
+    PrivateLink = "PrivateLink",
+    AAD = "AAD"
+}
+
 /** Known values of {@link BlobInventoryPolicyName} that the service accepts. */
 export declare enum KnownBlobInventoryPolicyName {
     Default = "default"
@@ -2796,6 +2816,172 @@ export declare interface ListTableServices {
     readonly value?: TableServiceProperties[];
 }
 
+/** The local user associated with the storage accounts. */
+export declare type LocalUser = Resource & {
+    /**
+     * Metadata pertaining to creation and last modification of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+    /** The permission scopes of the local user. */
+    permissionScopes?: PermissionScope[];
+    /** Optional, local user home directory. */
+    homeDirectory?: string;
+    /** Optional, local user ssh authorized keys for SFTP. */
+    sshAuthorizedKeys?: SshPublicKey[];
+    /**
+     * A unique Security Identifier that is generated by the server.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly sid?: string;
+    /** Indicates whether shared key exists. Set it to false to remove existing shared key. */
+    hasSharedKey?: boolean;
+    /** Indicates whether ssh key exists. Set it to false to remove existing SSH key. */
+    hasSshKey?: boolean;
+    /** Indicates whether ssh password exists. Set it to false to remove existing SSH password. */
+    hasSshPassword?: boolean;
+};
+
+/** The Storage Account Local User keys. */
+export declare interface LocalUserKeys {
+    /** Optional, local user ssh authorized keys for SFTP. */
+    sshAuthorizedKeys?: SshPublicKey[];
+    /**
+     * Auto generated by the server for SMB authentication.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly sharedKey?: string;
+}
+
+/** The secrets of Storage Account Local User. */
+export declare interface LocalUserRegeneratePasswordResult {
+    /**
+     * Auto generated password by the server for SSH authentication if hasSshPassword is set to true on the creation of local user.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly sshPassword?: string;
+}
+
+/** List storage account local users. */
+export declare interface LocalUsers {
+    /** The local users associated with the storage account. */
+    value?: LocalUser[];
+}
+
+/** Optional parameters. */
+export declare interface LocalUsersCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type LocalUsersCreateOrUpdateResponse = LocalUser;
+
+/** Optional parameters. */
+export declare interface LocalUsersDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface LocalUsersGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type LocalUsersGetResponse = LocalUser;
+
+/** Optional parameters. */
+export declare interface LocalUsersListKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listKeys operation. */
+export declare type LocalUsersListKeysResponse = LocalUserKeys;
+
+/** Optional parameters. */
+export declare interface LocalUsersListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type LocalUsersListResponse = LocalUsers;
+
+/** Interface representing a LocalUsersOperations. */
+export declare interface LocalUsersOperations {
+    /**
+     * List the local users associated with the storage account.
+     * @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 options parameters.
+     */
+    list(resourceGroupName: string, accountName: string, options?: LocalUsersListOptionalParams): PagedAsyncIterableIterator<LocalUser>;
+    /**
+     * Get the local user of the storage account by username.
+     * @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 username The name of local user. The username must contain lowercase letters and numbers
+     *                 only. It must be unique only within the storage account.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersGetOptionalParams): Promise<LocalUsersGetResponse>;
+    /**
+     * Create or update the properties of a local user associated with the storage account
+     * @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 username The name of local user. The username must contain lowercase letters and numbers
+     *                 only. It must be unique only within the storage account.
+     * @param properties The local user associated with a storage account.
+     * @param options The options parameters.
+     */
+    createOrUpdate(resourceGroupName: string, accountName: string, username: string, properties: LocalUser, options?: LocalUsersCreateOrUpdateOptionalParams): Promise<LocalUsersCreateOrUpdateResponse>;
+    /**
+     * Deletes the local user associated with the specified storage account.
+     * @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 username The name of local user. The username must contain lowercase letters and numbers
+     *                 only. It must be unique only within the storage account.
+     * @param options The options parameters.
+     */
+    delete(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersDeleteOptionalParams): Promise<void>;
+    /**
+     * List SSH authorized keys and shared key of the local user.
+     * @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 username The name of local user. The username must contain lowercase letters and numbers
+     *                 only. It must be unique only within the storage account.
+     * @param options The options parameters.
+     */
+    listKeys(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersListKeysOptionalParams): Promise<LocalUsersListKeysResponse>;
+    /**
+     * Regenerate the local user SSH password.
+     * @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 username The name of local user. The username must contain lowercase letters and numbers
+     *                 only. It must be unique only within the storage account.
+     * @param options The options parameters.
+     */
+    regeneratePassword(resourceGroupName: string, accountName: string, username: string, options?: LocalUsersRegeneratePasswordOptionalParams): Promise<LocalUsersRegeneratePasswordResponse>;
+}
+
+/** Optional parameters. */
+export declare interface LocalUsersRegeneratePasswordOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the regeneratePassword operation. */
+export declare type LocalUsersRegeneratePasswordResponse = LocalUserRegeneratePasswordResult;
+
 /** Interface representing a ManagementPolicies. */
 export declare interface ManagementPolicies {
     /**
@@ -3227,6 +3413,15 @@ export declare type OperationsListResponse = OperationListResult;
 declare type Permissions_2 = string;
 export { Permissions_2 as Permissions }
 
+export declare interface PermissionScope {
+    /** The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c). */
+    permissions: string;
+    /** The service used by the local user, e.g. blob, file. */
+    service: string;
+    /** The name of resource, normally the container name or the file share name, used by the local user. */
+    resourceName: string;
+}
+
 /** The Private Endpoint resource. */
 export declare interface PrivateEndpoint {
     /**
@@ -3962,6 +4157,13 @@ export declare interface SmbSetting {
     channelEncryption?: string;
 }
 
+export declare interface SshPublicKey {
+    /** Optional. It is used to store the function/usage of the key */
+    description?: string;
+    /** Ssh public key base64 encoded. The format should be: '<keyType> <keyData>', e.g. ssh-rsa AAAABBBB */
+    key?: string;
+}
+
 /**
  * Defines values for State. \
  * {@link KnownState} can be used interchangeably with State,
@@ -4057,7 +4259,7 @@ export declare type StorageAccount = TrackedResource & {
      */
     readonly secondaryEndpoints?: Endpoints;
     /**
-     * Gets the encryption settings on the account. If unspecified, the account is unencrypted.
+     * Encryption settings to be used for server-side encryption for the storage account.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly encryption?: Encryption;
@@ -4075,6 +4277,10 @@ export declare type StorageAccount = TrackedResource & {
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly networkRuleSet?: NetworkRuleSet;
+    /** Enables Secure File Transfer Protocol, if set to true */
+    isSftpEnabled?: boolean;
+    /** Enables local users feature, if set to true */
+    isLocalUserEnabled?: boolean;
     /** Account HierarchicalNamespace enabled if sets to true. */
     isHnsEnabled?: boolean;
     /**
@@ -4117,6 +4323,8 @@ export declare type StorageAccount = TrackedResource & {
     publicNetworkAccess?: PublicNetworkAccess;
     /** The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. */
     immutableStorageWithVersioning?: ImmutableStorageAccount;
+    /** Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. */
+    allowedCopyScope?: AllowedCopyScope;
 };
 
 /** The parameters used to check the availability of the storage account name. */
@@ -4143,6 +4351,8 @@ export declare interface StorageAccountCreateParameters {
     };
     /** The identity of the resource. */
     identity?: Identity;
+    /** Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. */
+    allowedCopyScope?: AllowedCopyScope;
     /** Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. */
     publicNetworkAccess?: PublicNetworkAccess;
     /** SasPolicy assigned to the storage account. */
@@ -4151,7 +4361,7 @@ export declare interface StorageAccountCreateParameters {
     keyPolicy?: KeyPolicy;
     /** 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;
-    /** Not applicable. Azure Storage encryption is enabled for all storage accounts and cannot be disabled. */
+    /** Encryption settings to be used for server-side encryption for the storage account. */
     encryption?: Encryption;
     /** Network rule set */
     networkRuleSet?: NetworkRuleSet;
@@ -4161,6 +4371,10 @@ export declare interface StorageAccountCreateParameters {
     azureFilesIdentityBasedAuthentication?: AzureFilesIdentityBasedAuthentication;
     /** Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. */
     enableHttpsTrafficOnly?: boolean;
+    /** Enables Secure File Transfer Protocol, if set to true */
+    isSftpEnabled?: boolean;
+    /** Enables local users feature, if set to true */
+    isLocalUserEnabled?: boolean;
     /** Account HierarchicalNamespace enabled if sets to true. */
     isHnsEnabled?: boolean;
     /** Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. */
@@ -4685,7 +4899,7 @@ export declare interface StorageAccountUpdateParameters {
     kind?: Kind;
     /** 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. */
+    /** Not applicable. Azure Storage encryption at rest is enabled by default for all storage accounts and cannot be disabled. */
     encryption?: Encryption;
     /** SasPolicy assigned to the storage account. */
     sasPolicy?: SasPolicy;
@@ -4697,6 +4911,10 @@ export declare interface StorageAccountUpdateParameters {
     azureFilesIdentityBasedAuthentication?: AzureFilesIdentityBasedAuthentication;
     /** Allows https traffic only to storage service if sets to true. */
     enableHttpsTrafficOnly?: boolean;
+    /** Enables Secure File Transfer Protocol, if set to true */
+    isSftpEnabled?: boolean;
+    /** Enables local users feature, if set to true */
+    isLocalUserEnabled?: boolean;
     /** Network rule set */
     networkRuleSet?: NetworkRuleSet;
     /** Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. */
@@ -4717,6 +4935,8 @@ export declare interface StorageAccountUpdateParameters {
     publicNetworkAccess?: PublicNetworkAccess;
     /** The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. */
     immutableStorageWithVersioning?: ImmutableStorageAccount;
+    /** Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. */
+    allowedCopyScope?: AllowedCopyScope;
 }
 
 export declare class StorageManagementClient extends coreClient.ServiceClient {
@@ -4740,6 +4960,7 @@ export declare class StorageManagementClient extends coreClient.ServiceClient {
     privateEndpointConnections: PrivateEndpointConnections;
     privateLinkResources: PrivateLinkResources;
     objectReplicationPoliciesOperations: ObjectReplicationPoliciesOperations;
+    localUsersOperations: LocalUsersOperations;
     encryptionScopes: EncryptionScopes;
     blobServices: BlobServices;
     blobContainers: BlobContainers;