Package version:

Interface EncryptionScopes

Interface representing a EncryptionScopes.

interface EncryptionScopes {
    get(resourceGroupName: string, accountName: string, encryptionScopeName: string, options?: EncryptionScopesGetOptionalParams): Promise<EncryptionScope>;
    list(resourceGroupName: string, accountName: string, options?: EncryptionScopesListOptionalParams): PagedAsyncIterableIterator<EncryptionScope>;
    patch(resourceGroupName: string, accountName: string, encryptionScopeName: string, encryptionScope: EncryptionScope, options?: EncryptionScopesPatchOptionalParams): Promise<EncryptionScope>;
    put(resourceGroupName: string, accountName: string, encryptionScopeName: string, encryptionScope: EncryptionScope, options?: EncryptionScopesPutOptionalParams): Promise<EncryptionScope>;
}

Methods

get(resourceGroupName, accountName, encryptionScopeName, options?): Promise<EncryptionScope>
Returns the properties for the specified encryption scope.
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.
- Optionaloptions: EncryptionScopesGetOptionalParams
  The options parameters.
Returns Promise<EncryptionScope>
- Defined in operationsInterfaces/encryptionScopes.ts:96

list(resourceGroupName, accountName, options?): PagedAsyncIterableIterator<EncryptionScope>
Lists all the encryption scopes available under the specified storage account.
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.
- Optionaloptions: EncryptionScopesListOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<EncryptionScope>
- Defined in operationsInterfaces/encryptionScopes.ts:33

patch(resourceGroupName, accountName, encryptionScopeName, encryptionScope, options?): Promise<EncryptionScope>
Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
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.
- Optionaloptions: EncryptionScopesPatchOptionalParams
  The options parameters.
Returns Promise<EncryptionScope>
- Defined in operationsInterfaces/encryptionScopes.ts:76

put(resourceGroupName, accountName, encryptionScopeName, encryptionScope, options?): 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.
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.
- Optionaloptions: EncryptionScopesPutOptionalParams
  The options parameters.
Returns Promise<EncryptionScope>
- Defined in operationsInterfaces/encryptionScopes.ts:54