models Package
Classes
AccessPolicy |
AccessPolicy. |
AccountImmutabilityPolicyProperties |
This defines account-level immutability policy properties. |
AccountSasParameters |
The parameters to list SAS credentials of a storage account. All required parameters must be populated in order to send to server. |
ActiveDirectoryProperties |
Settings properties for Active Directory (AD). All required parameters must be populated in order to send to server. |
AzureEntityResource |
The resource model definition for an Azure Resource Manager resource with an etag. Variables are only populated by the server, and will be ignored when sending a request. |
AzureFilesIdentityBasedAuthentication |
Settings for Azure Files identity based authentication. All required parameters must be populated in order to send to server. |
BlobContainer |
Properties of the blob container, including Id, resource name, resource type, Etag. Variables are only populated by the server, and will be ignored when sending a request. |
BlobInventoryPolicy |
The storage account blob inventory policy. Variables are only populated by the server, and will be ignored when sending a request. |
BlobInventoryPolicyDefinition |
An object that defines the blob inventory rule. All required parameters must be populated in order to send to server. |
BlobInventoryPolicyFilter |
An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. |
BlobInventoryPolicyRule |
An object that wraps the blob inventory rule. Each rule is uniquely defined by name. All required parameters must be populated in order to send to server. |
BlobInventoryPolicySchema |
The storage account blob inventory policy rules. 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 server. |
BlobRestoreParameters |
Blob restore parameters. All required parameters must be populated in order to send to server. |
BlobRestoreRange |
Blob range. All required parameters must be populated in order to send to server. |
BlobRestoreStatus |
Blob restore status. Variables are only populated by the server, and will be ignored when sending a request. |
BlobServiceItems |
BlobServiceItems. Variables are only populated by the server, and will be ignored when sending a request. |
BlobServiceProperties |
The properties of a storage account's Blob service. Variables are only populated by the server, and will be ignored when sending a request. |
ChangeFeed |
The blob service properties for change feed events. |
CheckNameAvailabilityResult |
The CheckNameAvailability operation response. Variables are only populated by the server, and will be ignored when sending a request. |
CloudErrorBody |
An error response from the Storage service. |
CorsRule |
Specifies a CORS rule for the Blob service. All required parameters must be populated in order to send to server. |
CorsRules |
Sets the CORS rules. You can include up to five CorsRule elements in the request. |
CustomDomain |
The custom domain assigned to this storage account. This can be set via Update. All required parameters must be populated in order to send to server. |
DateAfterCreation |
Object to define snapshot and version action conditions. All required parameters must be populated in order to send to server. |
DateAfterModification |
Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan. |
DeleteRetentionPolicy |
The service properties for soft delete. |
DeletedAccount |
Deleted storage account. Variables are only populated by the server, and will be ignored when sending a request. |
DeletedAccountListResult |
The response from the List Deleted Accounts operation. Variables are only populated by the server, and will be ignored when sending a request. |
DeletedShare |
The deleted share to be restored. All required parameters must be populated in order to send to server. |
Dimension |
Dimension of blobs, possibly be blob type or access tier. |
Encryption |
The encryption settings on the storage account. All required parameters must be populated in order to send to server. |
EncryptionIdentity |
Encryption identity for the storage account. |
EncryptionScope |
The Encryption Scope resource. Variables are only populated by the server, and will be ignored when sending a request. |
EncryptionScopeKeyVaultProperties |
The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. Variables are only populated by the server, and will be ignored when sending a request. |
EncryptionScopeListResult |
List of encryption scopes requested, and if paging is required, a URL to the next page of encryption scopes. Variables are only populated by the server, and will be ignored when sending a request. |
EncryptionService |
A service that allows server-side encryption to be used. Variables are only populated by the server, and will be ignored when sending a request. |
EncryptionServices |
A list of services that support encryption. |
Endpoints |
The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. Variables are only populated by the server, and will be ignored when sending a request. |
ErrorResponse |
An error response from the storage resource provider. |
ErrorResponseBody |
Error response body contract. |
ExtendedLocation |
The complex type of the extended location. |
FileServiceItems |
FileServiceItems. Variables are only populated by the server, and will be ignored when sending a request. |
FileServiceProperties |
The properties of File services in storage account. Variables are only populated by the server, and will be ignored when sending a request. |
FileShare |
Properties of the file share, including Id, resource name, resource type, Etag. Variables are only populated by the server, and will be ignored when sending a request. |
FileShareItem |
The file share properties be listed out. Variables are only populated by the server, and will be ignored when sending a request. |
FileShareItems |
Response schema. Contains list of shares returned, and if paging is requested or required, a URL to next page of shares. Variables are only populated by the server, and will be ignored when sending a request. |
GeoReplicationStats |
Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. Variables are only populated by the server, and will be ignored when sending a request. |
IPRule |
IP rule with specific IP or IP range in CIDR format. All required parameters must be populated in order to send to server. |
Identity |
Identity for the 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 server. |
ImmutabilityPolicy |
The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag. Variables are only populated by the server, and will be ignored when sending a request. |
ImmutabilityPolicyProperties |
The properties of an ImmutabilityPolicy of a blob container. Variables are only populated by the server, and will be ignored when sending a request. |
ImmutableStorageAccount |
This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. |
ImmutableStorageWithVersioning |
Object level immutability properties of the container. Variables are only populated by the server, and will be ignored when sending a request. |
KeyCreationTime |
Storage account keys creation time. |
KeyPolicy |
KeyPolicy assigned to the storage account. All required parameters must be populated in order to send to server. |
KeyVaultProperties |
Properties of key vault. Variables are only populated by the server, and will be ignored when sending a request. |
LastAccessTimeTrackingPolicy |
The blob service properties for Last access time based tracking policy. All required parameters must be populated in order to send to server. |
LeaseContainerRequest |
Lease Container request schema. All required parameters must be populated in order to send to server. |
LeaseContainerResponse |
Lease Container response schema. |
LeaseShareRequest |
Lease Share request schema. All required parameters must be populated in order to send to server. |
LeaseShareResponse |
Lease Share response schema. |
LegalHold |
The LegalHold property of a blob container. 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 server. |
LegalHoldProperties |
The LegalHold property of a blob container. Variables are only populated by the server, and will be ignored when sending a request. |
ListAccountSasResponse |
The List SAS credentials operation response. Variables are only populated by the server, and will be ignored when sending a request. |
ListBlobInventoryPolicy |
List of blob inventory policies returned. Variables are only populated by the server, and will be ignored when sending a request. |
ListContainerItem |
The blob container properties be listed out. Variables are only populated by the server, and will be ignored when sending a request. |
ListContainerItems |
Response schema. Contains list of blobs returned, and if paging is requested or required, a URL to next page of containers. Variables are only populated by the server, and will be ignored when sending a request. |
ListQueue |
ListQueue. Variables are only populated by the server, and will be ignored when sending a request. |
ListQueueResource |
Response schema. Contains list of queues returned. Variables are only populated by the server, and will be ignored when sending a request. |
ListQueueServices |
ListQueueServices. Variables are only populated by the server, and will be ignored when sending a request. |
ListServiceSasResponse |
The List service SAS credentials operation response. Variables are only populated by the server, and will be ignored when sending a request. |
ListTableResource |
Response schema. Contains list of tables returned. Variables are only populated by the server, and will be ignored when sending a request. |
ListTableServices |
ListTableServices. Variables are only populated by the server, and will be ignored when sending a request. |
LocalUser |
The local user associated with the storage accounts. Variables are only populated by the server, and will be ignored when sending a request. |
LocalUserKeys |
The Storage Account Local User keys. Variables are only populated by the server, and will be ignored when sending a request. |
LocalUserRegeneratePasswordResult |
The secrets of Storage Account Local User. Variables are only populated by the server, and will be ignored when sending a request. |
LocalUsers |
List storage account local users. |
ManagementPolicy |
The Get Storage Account ManagementPolicies operation response. Variables are only populated by the server, and will be ignored when sending a request. |
ManagementPolicyAction |
Actions are applied to the filtered blobs when the execution condition is met. |
ManagementPolicyBaseBlob |
Management policy action for base blob. |
ManagementPolicyDefinition |
An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. All required parameters must be populated in order to send to server. |
ManagementPolicyFilter |
Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters. All required parameters must be populated in order to send to server. |
ManagementPolicyRule |
An object that wraps the Lifecycle rule. Each rule is uniquely defined by name. All required parameters must be populated in order to send to server. |
ManagementPolicySchema |
The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. All required parameters must be populated in order to send to server. |
ManagementPolicySnapShot |
Management policy action for snapshot. |
ManagementPolicyVersion |
Management policy action for blob version. |
MetricSpecification |
Metric specification of operation. |
Multichannel |
Multichannel setting. Applies to Premium FileStorage only. |
NetworkRuleSet |
Network rule set. All required parameters must be populated in order to send to server. |
ObjectReplicationPolicies |
List storage account object replication policies. |
ObjectReplicationPolicy |
The replication policy between two storage accounts. Multiple rules can be defined in one policy. Variables are only populated by the server, and will be ignored when sending a request. |
ObjectReplicationPolicyFilter |
Filters limit replication to a subset of blobs within the storage account. A logical OR is performed on values in the filter. If multiple filters are defined, a logical AND is performed on all filters. |
ObjectReplicationPolicyRule |
The replication policy rule between two containers. All required parameters must be populated in order to send to server. |
Operation |
Storage REST API operation definition. |
OperationDisplay |
Display metadata associated with the operation. |
OperationListResult |
Result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results. |
PermissionScope |
PermissionScope. All required parameters must be populated in order to send to server. |
PrivateEndpoint |
The Private Endpoint resource. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateEndpointConnection |
The Private Endpoint Connection resource. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateEndpointConnectionListResult |
List of private endpoint connection associated with the specified storage account. |
PrivateLinkResource |
A private link resource. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateLinkResourceListResult |
A list of private link resources. |
PrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
ProtectedAppendWritesHistory |
Protected append writes history setting for the blob container with Legal holds. Variables are only populated by the server, and will be ignored when sending a request. |
ProtocolSettings |
Protocol settings for file service. |
ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location. Variables are only populated by the server, and will be ignored when sending a request. |
QueueServiceProperties |
The properties of a storage account's Queue service. Variables are only populated by the server, and will be ignored when sending a request. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources. Variables are only populated by the server, and will be ignored when sending a request. |
ResourceAccessRule |
Resource Access Rule. |
RestorePolicyProperties |
The blob service properties for blob restore policy. 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 server. |
Restriction |
The restriction because of which SKU cannot be used. Variables are only populated by the server, and will be ignored when sending a request. |
RoutingPreference |
Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing. |
SKUCapability |
The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. Variables are only populated by the server, and will be ignored when sending a request. |
SasPolicy |
SasPolicy assigned to the storage account. All required parameters must be populated in order to send to server. |
ServiceSasParameters |
The parameters to list service SAS credentials of a specific resource. All required parameters must be populated in order to send to server. |
ServiceSpecification |
One property of operation, include metric specifications. |
SignedIdentifier |
SignedIdentifier. |
Sku |
The SKU of the storage account. 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 server. |
SkuInformation |
Storage SKU and its properties. 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 server. |
SmbSetting |
Setting for SMB protocol. |
SshPublicKey |
SshPublicKey. |
StorageAccount |
The storage account. 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 server. |
StorageAccountCheckNameAvailabilityParameters |
The parameters used to check the availability of the storage account name. 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 server. |
StorageAccountCreateParameters |
The parameters used when creating a storage account. All required parameters must be populated in order to send to server. |
StorageAccountInternetEndpoints |
The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. Variables are only populated by the server, and will be ignored when sending a request. |
StorageAccountKey |
An access key for the storage account. Variables are only populated by the server, and will be ignored when sending a request. |
StorageAccountListKeysResult |
The response from the ListKeys operation. Variables are only populated by the server, and will be ignored when sending a request. |
StorageAccountListResult |
The response from the List Storage Accounts operation. Variables are only populated by the server, and will be ignored when sending a request. |
StorageAccountMicrosoftEndpoints |
The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. Variables are only populated by the server, and will be ignored when sending a request. |
StorageAccountRegenerateKeyParameters |
The parameters used to regenerate the storage account key. All required parameters must be populated in order to send to server. |
StorageAccountSkuConversionStatus |
This defines the sku conversion status object for asynchronous sku conversions. Variables are only populated by the server, and will be ignored when sending a request. |
StorageAccountUpdateParameters |
The parameters that can be provided when updating the storage account properties. |
StorageQueue |
StorageQueue. Variables are only populated by the server, and will be ignored when sending a request. |
StorageSkuListResult |
The response from the List Storage SKUs operation. Variables are only populated by the server, and will be ignored when sending a request. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
Table |
Properties of the table, including Id, resource name, resource type. Variables are only populated by the server, and will be ignored when sending a request. |
TableAccessPolicy |
Table Access Policy Properties Object. All required parameters must be populated in order to send to server. |
TableServiceProperties |
The properties of a storage account's Table service. Variables are only populated by the server, and will be ignored when sending a request. |
TableSignedIdentifier |
Object to set Table Access Policy. All required parameters must be populated in order to send to server. |
TagFilter |
Blob index tag based filtering for blob objects. All required parameters must be populated in order to send to server. |
TagProperty |
A tag of the LegalHold of a blob container. Variables are only populated by the server, and will be ignored when sending a request. |
TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'. 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 server. |
UpdateHistoryProperty |
An update history of the ImmutabilityPolicy of a blob container. Variables are only populated by the server, and will be ignored when sending a request. |
Usage |
Describes Storage Resource Usage. Variables are only populated by the server, and will be ignored when sending a request. |
UsageListResult |
The response from the List Usages operation. |
UsageName |
The usage names that can be used; currently limited to StorageAccount. Variables are only populated by the server, and will be ignored when sending a request. |
UserAssignedIdentity |
UserAssignedIdentity for the resource. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualNetworkRule |
Virtual Network rule. All required parameters must be populated in order to send to server. |
Enums
AccessTier |
Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. |
AccountImmutabilityPolicyState |
The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. |
AccountStatus |
Gets the status indicating whether the primary location of the storage account is available or unavailable. |
ActiveDirectoryPropertiesAccountType |
Specifies the Active Directory account type for Azure Storage. |
AllowedCopyScope |
Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. |
BlobInventoryPolicyName |
BlobInventoryPolicyName. |
BlobRestoreProgressStatus |
The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. |
Bypass |
Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics. |
CorsRuleAllowedMethodsItem |
CorsRuleAllowedMethodsItem. |
CreatedByType |
The type of identity that created the resource. |
DefaultAction |
Specifies the default action of allow or deny when no other rules match. |
DefaultSharePermission |
Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
DirectoryServiceOptions |
Indicates the directory service used. |
DnsEndpointType |
Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. |
EnabledProtocols |
The authentication protocol that is used for the file share. Can only be specified when creating a share. |
EncryptionScopeSource |
The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. |
EncryptionScopeState |
The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. |
ExpirationAction |
The SAS expiration action. Can only be Log. |
ExtendedLocationTypes |
The type of extendedLocation. |
Format |
This is a required field, it specifies the format for the inventory files. |
GeoReplicationStatus |
The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. |
HttpProtocol |
The protocol permitted for a request made with the account SAS. |
IdentityType |
The identity type. |
ImmutabilityPolicyState |
The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. |
ImmutabilityPolicyUpdateType |
The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. |
InventoryRuleType |
The valid value is Inventory. |
KeyPermission |
Permissions for the key – read-only or full permissions. |
KeySource |
The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. |
KeyType |
Encryption key type to be used for the encryption service. 'Account' key type implies that an account-scoped encryption key will be used. 'Service' key type implies that a default service key is used. |
Kind |
Indicates the type of storage account. |
LargeFileSharesState |
Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. |
LeaseContainerRequestAction |
Specifies the lease action. Can be one of the available actions. |
LeaseDuration |
Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. |
LeaseShareAction |
Specifies the lease action. Can be one of the available actions. |
LeaseState |
Lease state of the container. |
LeaseStatus |
The lease status of the container. |
ListContainersInclude |
ListContainersInclude. |
ManagementPolicyName |
ManagementPolicyName. |
MigrationState |
This property denotes the container level immutability to object level immutability migration state. |
MinimumTlsVersion |
Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. |
Name |
Name of the policy. The valid value is AccessTimeTracking. This field is currently read only. |
ObjectType |
This is a required field. This field specifies the scope of the inventory created either at the blob or container level. |
Permissions |
The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). |
PrivateEndpointConnectionProvisioningState |
The current provisioning state. |
PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
ProvisioningState |
Gets the status of the storage account at the time the operation was called. |
PublicAccess |
Specifies whether data in the container may be accessed publicly and the level of access. |
PublicNetworkAccess |
Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. |
Reason |
Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false. |
ReasonCode |
The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC. |
RootSquashType |
The property is for NFS share only. The default is NoRootSquash. |
RoutingChoice |
Routing Choice defines the kind of network routing opted by the user. |
RuleType |
The valid value is Lifecycle. |
Schedule |
This is a required field. This field is used to schedule an inventory formation. |
Services |
The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). |
ShareAccessTier |
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
SignedResource |
The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). |
SignedResourceTypes |
The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. |
SkuConversionStatus |
This property indicates the current sku conversion status. |
SkuName |
The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. |
SkuTier |
The SKU tier. This is based on the SKU name. |
State |
Gets the state of virtual network rule. |
StorageAccountExpand |
StorageAccountExpand. |
UsageUnit |
Gets the unit of measurement. |
Azure SDK for Python