Package com.azure.resourcemanager.apimanagement.models

Class ApiManagementServiceBackupRestoreParameters

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiManagementServiceBackupRestoreParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiManagementServiceBackupRestoreParameters>
public final class ApiManagementServiceBackupRestoreParameters extends Object implements com.azure.json.JsonSerializable<ApiManagementServiceBackupRestoreParameters>
Parameters supplied to the Backup/Restore of an API Management service operation.

  • Constructor Details

    • ApiManagementServiceBackupRestoreParameters

      public ApiManagementServiceBackupRestoreParameters()
      Creates an instance of ApiManagementServiceBackupRestoreParameters class.

  • Method Details

    • storageAccount

      public String storageAccount()
      Get the storageAccount property: The name of the Azure storage account (used to place/retrieve the backup).
      Returns:
      the storageAccount value.

    • withStorageAccount

      public ApiManagementServiceBackupRestoreParameters withStorageAccount(String storageAccount)
      Set the storageAccount property: The name of the Azure storage account (used to place/retrieve the backup).
      Parameters:
      storageAccount - the storageAccount value to set.
      Returns:
      the ApiManagementServiceBackupRestoreParameters object itself.

    • containerName

      public String containerName()
      Get the containerName property: The name of the blob container (used to place/retrieve the backup).
      Returns:
      the containerName value.

    • withContainerName

      public ApiManagementServiceBackupRestoreParameters withContainerName(String containerName)
      Set the containerName property: The name of the blob container (used to place/retrieve the backup).
      Parameters:
      containerName - the containerName value to set.
      Returns:
      the ApiManagementServiceBackupRestoreParameters object itself.

    • backupName

      public String backupName()
      Get the backupName property: The name of the backup file to create/retrieve.
      Returns:
      the backupName value.

    • withBackupName

      public ApiManagementServiceBackupRestoreParameters withBackupName(String backupName)
      Set the backupName property: The name of the backup file to create/retrieve.
      Parameters:
      backupName - the backupName value to set.
      Returns:
      the ApiManagementServiceBackupRestoreParameters object itself.

    • accessType

      public AccessType accessType()
      Get the accessType property: The type of access to be used for the storage account.
      Returns:
      the accessType value.

    • withAccessType

      public ApiManagementServiceBackupRestoreParameters withAccessType(AccessType accessType)
      Set the accessType property: The type of access to be used for the storage account.
      Parameters:
      accessType - the accessType value to set.
      Returns:
      the ApiManagementServiceBackupRestoreParameters object itself.

    • accessKey

      public String accessKey()
      Get the accessKey property: Storage account access key. Required only if `accessType` is set to `AccessKey`.
      Returns:
      the accessKey value.

    • withAccessKey

      public ApiManagementServiceBackupRestoreParameters withAccessKey(String accessKey)
      Set the accessKey property: Storage account access key. Required only if `accessType` is set to `AccessKey`.
      Parameters:
      accessKey - the accessKey value to set.
      Returns:
      the ApiManagementServiceBackupRestoreParameters object itself.

    • clientId

      public String clientId()
      Get the clientId property: The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`.
      Returns:
      the clientId value.

    • withClientId

      public ApiManagementServiceBackupRestoreParameters withClientId(String clientId)
      Set the clientId property: The Client ID of user assigned managed identity. Required only if `accessType` is set to `UserAssignedManagedIdentity`.
      Parameters:
      clientId - the clientId value to set.
      Returns:
      the ApiManagementServiceBackupRestoreParameters object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ApiManagementServiceBackupRestoreParameters>
      Throws:
      IOException

    • fromJson

      public static ApiManagementServiceBackupRestoreParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ApiManagementServiceBackupRestoreParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ApiManagementServiceBackupRestoreParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the ApiManagementServiceBackupRestoreParameters.