Interface EncryptionScopesClient


public interface EncryptionScopesClient
An instance of this class provides access to all the operations defined in EncryptionScopesClient.
  • Method Details

    • putWithResponseAsync

      Mono<com.azure.core.http.rest.Response<EncryptionScopeInner>> putWithResponseAsync(String resourceGroupName, String accountName, String encryptionScopeName, EncryptionScopeInner 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 - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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 - Encryption scope properties to be used for the create or update.
      Returns:
      the Encryption Scope resource along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • putAsync

      Mono<EncryptionScopeInner> putAsync(String resourceGroupName, String accountName, String encryptionScopeName, EncryptionScopeInner 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 - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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 - Encryption scope properties to be used for the create or update.
      Returns:
      the Encryption Scope resource on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • putWithResponse

      com.azure.core.http.rest.Response<EncryptionScopeInner> putWithResponse(String resourceGroupName, String accountName, String encryptionScopeName, EncryptionScopeInner encryptionScope, com.azure.core.util.Context context)
      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 - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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 - Encryption scope properties to be used for the create or update.
      context - The context to associate with this operation.
      Returns:
      the Encryption Scope resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • put

      EncryptionScopeInner put(String resourceGroupName, String accountName, String encryptionScopeName, EncryptionScopeInner 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 - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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 - Encryption scope properties to be used for the create or update.
      Returns:
      the Encryption Scope resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • patchWithResponseAsync

      Mono<com.azure.core.http.rest.Response<EncryptionScopeInner>> patchWithResponseAsync(String resourceGroupName, String accountName, String encryptionScopeName, EncryptionScopeInner encryptionScope)
      Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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 - Encryption scope properties to be used for the update.
      Returns:
      the Encryption Scope resource along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • patchAsync

      Mono<EncryptionScopeInner> patchAsync(String resourceGroupName, String accountName, String encryptionScopeName, EncryptionScopeInner encryptionScope)
      Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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 - Encryption scope properties to be used for the update.
      Returns:
      the Encryption Scope resource on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • patchWithResponse

      com.azure.core.http.rest.Response<EncryptionScopeInner> patchWithResponse(String resourceGroupName, String accountName, String encryptionScopeName, EncryptionScopeInner encryptionScope, com.azure.core.util.Context context)
      Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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 - Encryption scope properties to be used for the update.
      context - The context to associate with this operation.
      Returns:
      the Encryption Scope resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • patch

      EncryptionScopeInner patch(String resourceGroupName, String accountName, String encryptionScopeName, EncryptionScopeInner encryptionScope)
      Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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 - Encryption scope properties to be used for the update.
      Returns:
      the Encryption Scope resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<EncryptionScopeInner>> getWithResponseAsync(String resourceGroupName, String accountName, String encryptionScopeName)
      Returns the properties for the specified encryption scope.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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.
      Returns:
      the Encryption Scope resource along with Response on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getAsync

      Mono<EncryptionScopeInner> getAsync(String resourceGroupName, String accountName, String encryptionScopeName)
      Returns the properties for the specified encryption scope.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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.
      Returns:
      the Encryption Scope resource on successful completion of Mono.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getWithResponse

      com.azure.core.http.rest.Response<EncryptionScopeInner> getWithResponse(String resourceGroupName, String accountName, String encryptionScopeName, com.azure.core.util.Context context)
      Returns the properties for the specified encryption scope.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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.
      context - The context to associate with this operation.
      Returns:
      the Encryption Scope resource along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • get

      EncryptionScopeInner get(String resourceGroupName, String accountName, String encryptionScopeName)
      Returns the properties for the specified encryption scope.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      encryptionScopeName - 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.
      Returns:
      the Encryption Scope resource.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listAsync

      com.azure.core.http.rest.PagedFlux<EncryptionScopeInner> listAsync(String resourceGroupName, String accountName, Integer maxpagesize, String filter, ListEncryptionScopesInclude include)
      Lists all the encryption scopes available under the specified storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      maxpagesize - Optional, specifies the maximum number of encryption scopes that will be included in the list response.
      filter - Optional. When specified, only encryption scope names starting with the filter will be listed.
      include - Optional, when specified, will list encryption scopes with the specific state. Defaults to All.
      Returns:
      list of encryption scopes requested, and if paging is required, a URL to the next page of encryption scopes as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • listAsync

      com.azure.core.http.rest.PagedFlux<EncryptionScopeInner> listAsync(String resourceGroupName, String accountName)
      Lists all the encryption scopes available under the specified storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      Returns:
      list of encryption scopes requested, and if paging is required, a URL to the next page of encryption scopes as paginated response with PagedFlux.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • list

      com.azure.core.http.rest.PagedIterable<EncryptionScopeInner> list(String resourceGroupName, String accountName)
      Lists all the encryption scopes available under the specified storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      Returns:
      list of encryption scopes requested, and if paging is required, a URL to the next page of encryption scopes as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • list

      com.azure.core.http.rest.PagedIterable<EncryptionScopeInner> list(String resourceGroupName, String accountName, Integer maxpagesize, String filter, ListEncryptionScopesInclude include, com.azure.core.util.Context context)
      Lists all the encryption scopes available under the specified storage account.
      Parameters:
      resourceGroupName - The name of the resource group within the user's subscription. The name is case insensitive.
      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.
      maxpagesize - Optional, specifies the maximum number of encryption scopes that will be included in the list response.
      filter - Optional. When specified, only encryption scope names starting with the filter will be listed.
      include - Optional, when specified, will list encryption scopes with the specific state. Defaults to All.
      context - The context to associate with this operation.
      Returns:
      list of encryption scopes requested, and if paging is required, a URL to the next page of encryption scopes as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.