models.azure_protection_source module¶
-
class
models.azure_protection_source.
AzureProtectionSource
(application_id=None, application_key=None, azure_type=None, host_type=None, ip_addresses=None, is_managed_vm=None, location=None, memory_mbytes=None, name=None, num_cores=None, physical_source_id=None, resource_id=None, restore_task_id=None, subscription_id=None, subscription_type=None, tenant_id=None, mtype=None)[source]¶ Bases:
object
Implementation of the ‘AzureProtectionSource’ model.
Specifies a Protection Source in Azure environment.
- Attributes:
- application_id (string): Specifies Application Id of the active
directory of Azure account.
- application_key (string): Specifies Application key of the active
directory of Azure account.
- azure_type (AzureTypeEnum): Specifies the entity type such as
‘kSubscription’ if the environment is kAzure. Specifies the type of an Azure source entity. ‘kSubscription’ indicates a billing unit within Azure account. ‘kResourceGroup’ indicates a container that holds related resources. ‘kVirtualMachine’ indicates a Virtual Machine in Azure environment. ‘kStorageAccount’ represents a collection of storage containers. ‘kStorageKey’ indicates a key required to access the storage account. ‘kStorageContainer’ represents a storage container within a storage account. ‘kStorageBlob’ represents a storage blog within a storage container. ‘kStorageResourceGroup’ indicates a container that holds related storage resources. ‘kNetworkSecurityGroup’ represents a network security group. ‘kVirtualNetwork’ represents a virtual network. ‘kNetworkResourceGroup’ indicates a container that holds related network resources. ‘kSubnet’ represents a subnet within the virtual network. ‘kComputeOptions’ indicates the number of CPU cores and memory size available for a type of a Virtual Machine.
- host_type (HostTypeEnum): Specifies the OS type of the Protection
Source of type ‘kVirtualMachine’ such as ‘kWindows’ or ‘kLinux’. overrideDescription: true ‘kLinux’ indicates the Linux operating system. ‘kWindows’ indicates the Microsoft Windows operating system. ‘kAix’ indicates the IBM AIX operating system. ‘kSolaris’ indicates the Oracle Solaris operating system. ‘kSapHana’ indicates the Sap Hana database system developed by SAP SE. ‘kOther’ indicates the other types of operating system.
- ip_addresses (list of string): Specifies a list of IP addresses for
entities of type ‘kVirtualMachine’.
- is_managed_vm (bool): Specifies whether VM is managed or not for
entities of type ‘kVirtualMachine’.
- location (string): Specifies the physical location of the resource
group.
- memory_mbytes (long|int): Specifies the amount of memory in MegaBytes
of the Azure resource of type ‘kComputeOptions’.
- name (string): Specifies the name of the Object set by the Cloud
Provider. If the provider did not set a name for the object, this field is not set.
- num_cores (int): Specifies the number of CPU cores of the Azure
resource of type ‘kComputeOptions’.
- physical_source_id (long|int): Specifies the Protection Source id of
the registered Physical Host. If the cloud entity is protected using a Physical Agent, it must be registered as a physical host.
- resource_id (string): Specifies the unique Id of the resource given by
the cloud provider.
- restore_task_id (long|int): Specifies the id of the “convert and
deploy” restore task that created the entity in the cloud. It is required to support the DR-to-cloud usecase where we replicate an on-prem entity to a cluster running in cloud, bring it up using “convert and deploy” mechanism, protect it using a cloud job that uses physical adapter, and convert it back to the on-prem format before replication. Before replicating, we need to update the backup task state of the backed up entity using the on-prem entity and on-prem entity’s parent. The id is used to lookup the restore entity that contains details about the on-prem entity. It is set at the time of refreshing the cloud entity hierarchy if all the following conditions are met: Name of the current entity matches with name of any cloud entity deployed using the “convert and deploy” restore task. Restore entity associated with the above matched cloud entity has ‘failed_over’ flag set to true in its cloud extension.
- subscription_id (string): Specifies Subscription id inside a
customer’s Azure account. It represents sub-section within the Azure account where a customer allows us to create VMs, storage account etc.
- subscription_type (SubscriptionTypeAzureProtectionSourceEnum):
Specifies the subscription type of Azure such as ‘kAzureCommercial’, ‘kAzureGovCloud’ or ‘kAzureStackCommercial’ Specifies the subscription type of an Azure source entity. ‘kAzureCommercial’ indicates a standard Azure subscription. ‘kAzureGovCloud’ indicates a govt Azure subscription. ‘kAzureStackCommercial’ indicates a stack commercial Azure
subscription.
- tenant_id (string): Specifies Tenant Id of the active directory of
Azure account.
- mtype (TypeAzureProtectionSourceEnum): Specifies the type of an Azure
Protection Source Object such as ‘kStorageContainer’, ‘kVirtualMachine’, ‘kVirtualNetwork’, etc. Specifies the type of an Azure source entity. ‘kSubscription’ indicates a billing unit within Azure account. ‘kResourceGroup’ indicates a container that holds related resources. ‘kVirtualMachine’ indicates a Virtual Machine in Azure environment. ‘kStorageAccount’ represents a collection of storage containers. ‘kStorageKey’ indicates a key required to access the storage account. ‘kStorageContainer’ represents a storage container within a storage account. ‘kStorageBlob’ represents a storage blog within a storage container. ‘kStorageResourceGroup’ indicates a container that holds related storage resources. ‘kNetworkSecurityGroup’ represents a network security group. ‘kVirtualNetwork’ represents a virtual network. ‘kNetworkResourceGroup’ indicates a container that holds related network resources. ‘kSubnet’ represents a subnet within the virtual network. ‘kComputeOptions’ indicates the number of CPU cores and memory size available for a type of a Virtual Machine.
-
classmethod
from_dictionary
(dictionary)[source]¶ Creates an instance of this model from a dictionary
- Args:
dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.
- Returns:
object: An instance of this structure class.