azure.mgmt.netapp.models module¶
-
class
azure.mgmt.netapp.models.
ActiveDirectory
(*, active_directory_id: str = None, username: str = None, password: str = None, domain: str = None, dns: str = None, status: str = None, smb_server_name: str = None, organizational_unit: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Active Directory.
- Parameters
active_directory_id (str) – Id of the Active Directory
username (str) – Username of Active Directory domain administrator
password (str) – Plain text password of Active Directory domain administrator
domain (str) – Name of the Active Directory domain
dns (str) – Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain
status (str) – Status of the Active Directory
smb_server_name (str) – NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes
organizational_unit (str) – The Organizational Unit (OU) within the Windows Active Directory
-
class
azure.mgmt.netapp.models.
AuthorizeRequest
(*, remote_volume_resource_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Authorize request.
- Parameters
remote_volume_resource_id (str) – Resource id
-
class
azure.mgmt.netapp.models.
CapacityPool
(*, location: str, size: int, tags=None, service_level='Premium', **kwargs)[source]¶ Bases:
msrest.serialization.Model
Capacity pool resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
location (str) – Required. Resource location
tags (dict[str, str]) – Resource tags
size (long) – Required. size. Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).
service_level (str or ServiceLevel) – Required. serviceLevel. The service level of the file system. Possible values include: ‘Standard’, ‘Premium’, ‘Ultra’. Default value: “Premium” .
- Variables
-
class
azure.mgmt.netapp.models.
CapacityPoolPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
CapacityPool
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.netapp.models.
CapacityPoolPatch
(*, location: str = None, tags=None, size: int = 4398046511104, service_level='Premium', **kwargs)[source]¶ Bases:
msrest.serialization.Model
Capacity pool patch resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
location (str) – Resource location
tags (dict[str, str]) – Resource tags
size (long) – size. Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104). Default value: 4398046511104 .
service_level (str or ServiceLevel) – serviceLevel. The service level of the file system. Possible values include: ‘Standard’, ‘Premium’, ‘Ultra’. Default value: “Premium” .
- Variables
-
class
azure.mgmt.netapp.models.
CheckNameResourceTypes
(value)[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
microsoft_net_appnet_app_accounts
= 'Microsoft.NetApp/netAppAccounts'¶
-
microsoft_net_appnet_app_accountscapacity_pools
= 'Microsoft.NetApp/netAppAccounts/capacityPools'¶
-
microsoft_net_appnet_app_accountscapacity_poolsvolumes
= 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes'¶
-
microsoft_net_appnet_app_accountscapacity_poolsvolumessnapshots
= 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots'¶
-
-
class
azure.mgmt.netapp.models.
Dimension
(*, name: str = None, display_name: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Dimension of blobs, possibly be blob type or access tier.
- Parameters
name (str) – Display name of dimension.
display_name (str) – Display name of dimension.
-
class
azure.mgmt.netapp.models.
EndpointType
(value)[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
dst
= 'dst'¶
-
src
= 'src'¶
-
-
class
azure.mgmt.netapp.models.
ExportPolicyRule
(*, rule_index: int = None, unix_read_only: bool = None, unix_read_write: bool = None, cifs: bool = None, nfsv3: bool = None, nfsv41: bool = None, allowed_clients: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Volume Export Policy Rule.
- Parameters
rule_index (int) – Order index
unix_read_only (bool) – Read only access
unix_read_write (bool) – Read and write access
cifs (bool) – Allows CIFS protocol
nfsv3 (bool) – Allows NFSv3 protocol
nfsv41 (bool) – Allows NFSv4.1 protocol
allowed_clients (str) – Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
-
class
azure.mgmt.netapp.models.
InAvailabilityReasonType
(value)[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
already_exists
= 'AlreadyExists'¶
-
invalid
= 'Invalid'¶
-
-
class
azure.mgmt.netapp.models.
MetricSpecification
(*, name: str = None, display_name: str = None, display_description: str = None, unit: str = None, dimensions=None, aggregation_type: str = None, fill_gap_with_zero: bool = None, category: str = None, resource_id_dimension_name_override: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Metric specification of operation.
- Parameters
name (str) – Name of metric specification.
display_name (str) – Display name of metric specification.
display_description (str) – Display description of metric specification.
unit (str) – Unit could be Bytes or Count.
dimensions (list[Dimension]) – Dimensions of blobs, including blob type and access tier.
aggregation_type (str) – Aggregation type could be Average.
fill_gap_with_zero (bool) – The property to decide fill gap with zero or not.
category (str) – The category this metric specification belong to, could be Capacity.
resource_id_dimension_name_override (str) – Account Resource Id.
-
class
azure.mgmt.netapp.models.
MirrorState
(value)[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
broken
= 'Broken'¶
-
mirrored
= 'Mirrored'¶
-
uninitialized
= 'Uninitialized'¶
-
-
class
azure.mgmt.netapp.models.
MountTarget
(*, location: str, file_system_id: str, tags=None, subnet: str = None, start_ip: str = None, end_ip: str = None, gateway: str = None, netmask: str = None, smb_server_fqdn: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Mount Target.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
location (str) – Required. Resource location
tags (dict[str, str]) – Resource tags
file_system_id (str) – Required. fileSystemId. UUID v4 used to identify the MountTarget
subnet (str) – subnet. The subnet
start_ip (str) – startIp. The start of IPv4 address range to use when creating a new mount target
end_ip (str) – endIp. The end of IPv4 address range to use when creating a new mount target
gateway (str) – gateway. The gateway of the IPv4 address range to use when creating a new mount target
netmask (str) – netmask. The netmask of the IPv4 address range to use when creating a new mount target
smb_server_fqdn (str) – smbServerFQDN. The SMB server’s Fully Qualified Domain Name, FQDN
- Variables
-
class
azure.mgmt.netapp.models.
MountTargetPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
MountTarget
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.netapp.models.
NetAppAccount
(*, location: str, tags=None, active_directories=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
NetApp account resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
location (str) – Required. Resource location
tags (dict[str, str]) – Resource tags
active_directories (list[ActiveDirectory]) – Active Directories
- Variables
-
class
azure.mgmt.netapp.models.
NetAppAccountPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
NetAppAccount
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.netapp.models.
NetAppAccountPatch
(*, location: str = None, tags=None, active_directories=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
NetApp account patch resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
location (str) – Resource location
tags (dict[str, str]) – Resource tags
active_directories (list[ActiveDirectory]) – Active Directories
- Variables
-
class
azure.mgmt.netapp.models.
Operation
(*, name: str = None, display=None, origin: str = None, service_specification=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Microsoft.NetApp REST API operation definition.
- Parameters
name (str) – Operation name: {provider}/{resource}/{operation}
display (OperationDisplay) – Display metadata associated with the operation.
origin (str) – The origin of operations.
service_specification (ServiceSpecification) – One property of operation, include metric specifications.
-
class
azure.mgmt.netapp.models.
OperationDisplay
(*, provider: str = None, resource: str = None, operation: str = None, description: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Display metadata associated with the operation.
- Parameters
provider (str) – Service provider: Microsoft NetApp.
resource (str) – Resource on which the operation is performed etc.
operation (str) – Type of operation: get, read, delete, etc.
description (str) – Operation description.
-
class
azure.mgmt.netapp.models.
OperationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Operation
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.netapp.models.
RelationshipStatus
(value)[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
idle
= 'Idle'¶
-
transferring
= 'Transferring'¶
-
-
class
azure.mgmt.netapp.models.
ReplicationObject
(*, replication_schedule, remote_volume_resource_id: str, replication_id: str = None, endpoint_type=None, remote_volume_region: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Replication properties.
All required parameters must be populated in order to send to Azure.
- Parameters
replication_id (str) – Id
endpoint_type (str or EndpointType) – Indicates whether the local volume is the source or destination for the Volume Replication. Possible values include: ‘src’, ‘dst’
replication_schedule (str or ReplicationSchedule) – Required. Schedule. Possible values include: ‘_10minutely’, ‘hourly’, ‘daily’, ‘weekly’, ‘monthly’
remote_volume_resource_id (str) – Required. The resource ID of the remote volume.
remote_volume_region (str) – The remote region for the other end of the Volume Replication.
-
class
azure.mgmt.netapp.models.
ReplicationSchedule
(value)[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
daily
= 'daily'¶
-
hourly
= 'hourly'¶
-
monthly
= 'monthly'¶
-
weekly
= 'weekly'¶
-
-
class
azure.mgmt.netapp.models.
ReplicationStatus
(*, healthy: bool = None, relationship_status=None, mirror_state=None, total_progress: str = None, error_message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Replication status.
- Parameters
healthy (bool) – Replication health check
relationship_status (str or RelationshipStatus) – Status of the mirror relationship. Possible values include: ‘Idle’, ‘Transferring’
mirror_state (str or MirrorState) – The status of the replication. Possible values include: ‘Uninitialized’, ‘Mirrored’, ‘Broken’
total_progress (str) – The progress of the replication
error_message (str) – Displays error message if the replication is in an error state
-
class
azure.mgmt.netapp.models.
ResourceNameAvailability
(*, is_available: bool = None, reason=None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Information regarding availability of a resource name.
- Parameters
is_available (bool) – <code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.
reason (str or InAvailabilityReasonType) – <code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable. Possible values include: ‘Invalid’, ‘AlreadyExists’
message (str) – If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.
-
class
azure.mgmt.netapp.models.
ResourceNameAvailabilityRequest
(*, name: str, type, resource_group: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Resource name availability request content.
All required parameters must be populated in order to send to Azure.
- Parameters
name (str) – Required. Resource name to verify.
type (str or CheckNameResourceTypes) – Required. Resource type used for verification. Possible values include: ‘Microsoft.NetApp/netAppAccounts’, ‘Microsoft.NetApp/netAppAccounts/capacityPools’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes’, ‘Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots’
resource_group (str) – Required. Resource group name.
-
class
azure.mgmt.netapp.models.
ServiceLevel
(value)[source]¶ Bases:
str
,enum.Enum
An enumeration.
Premium service level
-
standard
= 'Standard'¶ Standard service level
-
ultra
= 'Ultra'¶ Ultra service level
-
class
azure.mgmt.netapp.models.
ServiceSpecification
(*, metric_specifications=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
One property of operation, include metric specifications.
- Parameters
metric_specifications (list[MetricSpecification]) – Metric specifications of operation.
-
class
azure.mgmt.netapp.models.
Snapshot
(*, location: str, tags=None, file_system_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Snapshot of a Volume.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
location (str) – Required. Resource location
tags (dict[str, str]) – Resource tags
file_system_id (str) – fileSystemId. UUID v4 used to identify the FileSystem
- Variables
-
class
azure.mgmt.netapp.models.
SnapshotPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Snapshot
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.netapp.models.
SnapshotPatch
(*, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Snapshot patch.
- Parameters
tags (dict[str, str]) – Resource tags
-
class
azure.mgmt.netapp.models.
Volume
(*, location: str, creation_token: str, subnet_id: str, tags=None, service_level='Premium', usage_threshold: int = 107374182400, export_policy=None, protocol_types=None, snapshot_id: str = None, mount_targets=None, volume_type: str = None, data_protection=None, is_restoring: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Volume resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Parameters
location (str) – Required. Resource location
tags (dict[str, str]) – Resource tags
creation_token (str) – Required. Creation Token or File Path. A unique file path for the volume. Used when creating mount targets
service_level (str or ServiceLevel) – serviceLevel. The service level of the file system. Possible values include: ‘Standard’, ‘Premium’, ‘Ultra’. Default value: “Premium” .
usage_threshold (long) – Required. usageThreshold. Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes. Default value: 107374182400 .
export_policy (VolumePropertiesExportPolicy) – exportPolicy. Set of export policy rules
protocol_types (list[str]) – protocolTypes. Set of protocol types
snapshot_id (str) – Snapshot ID. UUID v4 or resource identifier used to identify the Snapshot.
subnet_id (str) – Required. The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
mount_targets (object) – mountTargets. List of mount targets
volume_type (str) – What type of volume is this
data_protection (VolumePropertiesDataProtection) – DataProtection. DataProtection type volumes include an object containing details of the replication
is_restoring (bool) – Restoring
- Variables
-
class
azure.mgmt.netapp.models.
VolumePaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Volume
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.netapp.models.
VolumePatch
(*, location: str = None, tags=None, service_level='Premium', usage_threshold: int = 107374182400, export_policy=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Volume patch resource.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
location (str) – Resource location
tags (dict[str, str]) – Resource tags
service_level (str or ServiceLevel) – serviceLevel. The service level of the file system. Possible values include: ‘Standard’, ‘Premium’, ‘Ultra’. Default value: “Premium” .
usage_threshold (long) – usageThreshold. Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes. Default value: 107374182400 .
export_policy (VolumePatchPropertiesExportPolicy) – exportPolicy. Set of export policy rules
- Variables
-
class
azure.mgmt.netapp.models.
VolumePatchPropertiesExportPolicy
(*, rules=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
exportPolicy.
Set of export policy rules.
- Parameters
rules (list[ExportPolicyRule]) – Export policy rule. Export policy rule
-
class
azure.mgmt.netapp.models.
VolumePropertiesDataProtection
(*, replication=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
DataProtection.
DataProtection type volumes include an object containing details of the replication.
- Parameters
replication (ReplicationObject) – Replication. Replication properties
-
class
azure.mgmt.netapp.models.
VolumePropertiesExportPolicy
(*, rules=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
exportPolicy.
Set of export policy rules.
- Parameters
rules (list[ExportPolicyRule]) – Export policy rule. Export policy rule