EncryptionScopes interface
Interface representing a EncryptionScopes.
get(string, string, string, Encryption |
Returns the properties for the specified encryption scope. |
list(string, string, Encryption |
Lists all the encryption scopes available under the specified storage account. |
patch(string, string, string, Encryption |
Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist. |
put(string, string, string, Encryption |
Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request. |
Returns the properties for the specified encryption scope.
function get(resourceGroupName: string, accountName: string, encryptionScopeName: string, options?: EncryptionScopesGetOptionalParams): Promise<EncryptionScope>
Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
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.
- encryptionScopeName
-
string
The name of the encryption scope within the specified storage account. Encryption scope 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.
The options parameters.
Returns
Promise<EncryptionScope>
Lists all the encryption scopes available under the specified storage account.
function list(resourceGroupName: string, accountName: string, options?: EncryptionScopesListOptionalParams): PagedAsyncIterableIterator<EncryptionScope, EncryptionScope[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
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.
The options parameters.
Returns
Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
function patch(resourceGroupName: string, accountName: string, encryptionScopeName: string, encryptionScope: EncryptionScope, options?: EncryptionScopesPatchOptionalParams): Promise<EncryptionScope>
Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
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.
- encryptionScopeName
-
string
The name of the encryption scope within the specified storage account. Encryption scope 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.
- encryptionScope
- EncryptionScope
Encryption scope properties to be used for the update.
The options parameters.
Returns
Promise<EncryptionScope>
Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request.
function put(resourceGroupName: string, accountName: string, encryptionScopeName: string, encryptionScope: EncryptionScope, options?: EncryptionScopesPutOptionalParams): Promise<EncryptionScope>
Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
-
string
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.
- encryptionScopeName
-
string
The name of the encryption scope within the specified storage account. Encryption scope 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.
- encryptionScope
- EncryptionScope
Encryption scope properties to be used for the create or update.
The options parameters.
Returns
Promise<EncryptionScope>