Azure.ResourceManager.Storage.Models Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
AccountImmutabilityPolicy |
This defines account-level immutability policy properties. |
AccountSasContent |
The parameters to list SAS credentials of a storage account. |
ArmStorageModelFactory |
Model factory for models. |
BlobContainerImmutabilityPolicy |
The properties of an ImmutabilityPolicy of a blob container. |
BlobInventoryPolicyDefinition |
An object that defines the blob inventory rule. |
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. |
BlobInventoryPolicySchema |
The storage account blob inventory policy rules. |
BlobRestoreContent |
Blob restore parameters. |
BlobRestoreRange |
Blob range. |
BlobRestoreStatus |
Blob restore status. |
BlobServiceChangeFeed |
The blob service properties for change feed events. |
DateAfterCreation |
Object to define snapshot and version action conditions. |
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. |
DeletedShare |
The deleted share to be restored. |
DeleteRetentionPolicy |
The service properties for soft delete. |
EncryptionScopeKeyVaultProperties |
The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. |
ExecutionTarget |
Target helps provide filter parameters for the objects in the storage account and forms the execution context for the storage task. |
ExecutionTrigger |
Execution trigger for storage task assignment. |
ExecutionTriggerParameters |
The trigger parameters update for the storage task assignment execution. |
ExecutionTriggerParametersUpdate |
The trigger parameters update for the storage task assignment execution. |
ExecutionTriggerUpdate |
Execution trigger update for storage task assignment. |
FilesIdentityBasedAuthentication |
Settings for Azure Files identity based authentication. |
GeoReplicationStatistics |
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. |
GetAccountSasResult |
The List SAS credentials operation response. |
GetServiceSasResult |
The List service SAS credentials operation response. |
ImmutableStorageAccount |
This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. |
ImmutableStorageWithVersioning |
Object level immutability properties of the container. |
LastAccessTimeTrackingPolicy |
The blob service properties for Last access time based tracking policy. |
LeaseContainerContent |
Lease Container request schema. |
LeaseContainerResponse |
Lease Container response schema. |
LeaseShareContent |
Lease Share request schema. |
LeaseShareResponse |
Lease Share response schema. |
LegalHold |
The LegalHold property of a blob container. |
LegalHoldProperties |
The LegalHold property of a blob container. |
LegalHoldTag |
A tag of the LegalHold of a blob container. |
LocalUserKeys |
The Storage Account Local User keys. |
LocalUserRegeneratePasswordResult |
The secrets of Storage Account Local User. |
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. |
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. |
ManagementPolicyRule |
An object that wraps the Lifecycle rule. Each rule is uniquely defined by name. |
ManagementPolicySnapShot |
Management policy action for snapshot. |
ManagementPolicyTagFilter |
Blob index tag based filtering for blob objects. |
ManagementPolicyVersion |
Management policy action for blob version. |
NetworkSecurityPerimeter |
NetworkSecurityPerimeter related information. |
NetworkSecurityPerimeterConfigurationPropertiesProfile |
Network Security Perimeter profile. |
NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation |
Information about resource association. |
NetworkSecurityPerimeterProvisioningIssue |
Describes provisioning issue for given NetworkSecurityPerimeterConfiguration. |
NetworkSecurityPerimeterProvisioningIssueProperties |
Properties of provisioning issue. |
NspAccessRule |
Information of Access Rule in Network Security Perimeter profile. |
NspAccessRuleProperties |
Properties of Access Rule. |
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. |
ProtectedAppendWritesHistory |
Protected append writes history setting for the blob container with Legal holds. |
RestorePolicy |
The blob service properties for blob restore policy. |
ServiceSasContent |
The parameters to list service SAS credentials of a specific resource. |
SmbSetting |
Setting for SMB protocol. |
StorageAccountCreateOrUpdateContent |
The parameters used when creating a storage account. |
StorageAccountEncryption |
The encryption settings on the storage account. |
StorageAccountEncryptionIdentity |
Encryption identity for the storage account. |
StorageAccountEncryptionServices |
A list of services that support encryption. |
StorageAccountEndpoints |
The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. |
StorageAccountInternetEndpoints |
The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. |
StorageAccountIPRule |
IP rule with specific IP or IP range in CIDR format. |
StorageAccountKey |
An access key for the storage account. |
StorageAccountKeyCreationTime |
Storage account keys creation time. |
StorageAccountKeyVaultProperties |
Properties of key vault. |
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. |
StorageAccountNameAvailabilityContent |
The parameters used to check the availability of the storage account name. |
StorageAccountNameAvailabilityResult |
The CheckNameAvailability operation response. |
StorageAccountNetworkRuleSet |
Network rule set. |
StorageAccountPatch |
The parameters that can be provided when updating the storage account properties. |
StorageAccountRegenerateKeyContent |
The parameters used to regenerate the storage account key. |
StorageAccountResourceAccessRule |
Resource Access Rule. |
StorageAccountSasPolicy |
SasPolicy assigned to the storage account. |
StorageAccountSkuConversionStatus |
This defines the sku conversion status object for asynchronous sku conversions. |
StorageAccountVirtualNetworkRule |
Virtual Network rule. |
StorageActiveDirectoryProperties |
Settings properties for Active Directory (AD). |
StorageCorsRule |
Specifies a CORS rule for the Blob service. |
StorageCustomDomain |
The custom domain assigned to this storage account. This can be set via Update. |
StorageEncryptionService |
A service that allows server-side encryption to be used. |
StoragePermissionScope |
The StoragePermissionScope. |
StoragePrivateLinkResourceData |
A private link resource. |
StoragePrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
StorageRoutingPreference |
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. |
StorageServiceAccessPolicy |
The StorageServiceAccessPolicy. |
StorageSignedIdentifier |
The StorageSignedIdentifier. |
StorageSku |
The SKU of the storage account. |
StorageSkuCapability |
The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. |
StorageSkuInformation |
Storage SKU and its properties. |
StorageSkuRestriction |
The restriction because of which SKU cannot be used. |
StorageSshPublicKey |
The StorageSshPublicKey. |
StorageTableAccessPolicy |
Table Access Policy Properties Object. |
StorageTableSignedIdentifier |
Object to set Table Access Policy. |
StorageTaskAssignmentExecutionContext |
Execution context of the storage task assignment. |
StorageTaskAssignmentPatch |
Parameters of the storage task assignment update request. |
StorageTaskAssignmentPatchProperties |
Properties of the storage task update assignment. |
StorageTaskAssignmentProperties |
Properties of the storage task assignment. |
StorageTaskAssignmentReport |
The storage task assignment report. |
StorageTaskAssignmentUpdateExecutionContext |
Execution context of the storage task assignment update. |
StorageTaskReportInstance |
Storage Tasks run report instance. |
StorageTaskReportProperties |
Storage task execution report for a run instance. |
StorageUsage |
Describes Storage Resource Usage. |
StorageUsageName |
The usage names that can be used; currently limited to StorageAccount. |
UpdateHistoryEntry |
An update history of the ImmutabilityPolicy of a blob container. |
Structs
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. |
ActiveDirectoryAccountType |
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. |
BlobContainerState |
The BlobContainerState. |
BlobInventoryPolicyFormat |
This is a required field, it specifies the format for the inventory files. |
BlobInventoryPolicyName |
The BlobInventoryPolicyName. |
BlobInventoryPolicyObjectType |
This is a required field. This field specifies the scope of the inventory created either at the blob or container level. |
BlobInventoryPolicySchedule |
This is a required field. This field is used to schedule an inventory formation. |
BlobInventoryRuleType |
The valid value is Inventory. |
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. |
CorsRuleAllowedMethod |
The CorsRuleAllowedMethod. |
DefaultSharePermission |
Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
DirectoryServiceOption |
Indicates the directory service used. Note that this enum may be extended in the future. |
EncryptionScopesIncludeType |
The EncryptionScopesIncludeType. |
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. |
ExecutionIntervalUnit |
Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce'. |
ExpirationAction |
The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. |
FileShareAccessTier |
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
FileShareEnabledProtocol |
The authentication protocol that is used for the file share. Can only be specified when creating a share. |
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. |
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. |
ImmutableStorageWithVersioningMigrationState |
This property denotes the container level immutability to object level immutability migration state. |
LargeFileSharesState |
Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. |
LastAccessTimeTrackingPolicyName |
Name of the policy. The valid value is AccessTimeTracking. This field is currently read only. |
LeaseContainerAction |
Specifies the lease action. Can be one of the available actions. |
LeaseShareAction |
Specifies the lease action. Can be one of the available actions. |
ListLocalUserIncludeParam |
The ListLocalUserIncludeParam. |
ManagementPolicyName |
The ManagementPolicyName. |
ManagementPolicyRuleType |
The valid value is Lifecycle. |
NetworkSecurityPerimeterConfigurationProvisioningState |
Provisioning state of Network Security Perimeter configuration propagation. |
NetworkSecurityPerimeterProvisioningIssueSeverity |
Severity of the issue. |
NetworkSecurityPerimeterProvisioningIssueType |
Type of issue. |
NspAccessRuleDirection |
Direction of Access Rule. |
PostFailoverRedundancy |
The redundancy type of the account after an account failover is performed. |
PostPlannedFailoverRedundancy |
The redundancy type of the account after a planned account failover is performed. |
ResourceAssociationAccessMode |
Access Mode of the resource association. |
RootSquashType |
The property is for NFS share only. The default is NoRootSquash. |
ServiceSasSignedResourceType |
The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). |
StorageAccountFailoverType |
The StorageAccountFailoverType. |
StorageAccountKeySource |
The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. |
StorageAccountMigrationName |
The StorageAccountMigrationName. |
StorageAccountMigrationStatus |
Current status of migration. |
StorageAccountNetworkRuleAction |
The action of virtual network rule. |
StorageAccountNetworkRuleState |
Gets the state of virtual network rule. |
StorageAccountSasPermission |
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). |
StorageAccountSasSignedResourceType |
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. |
StorageAccountSasSignedService |
The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). |
StorageAccountSkuConversionState |
This property indicates the current sku conversion status. |
StorageDnsEndpointType |
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. |
StorageEncryptionKeyType |
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. |
StorageKind |
Indicates the type of storage account. |
StorageLeaseDurationType |
Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. |
StorageLeaseState |
Lease state of the container. |
StorageLeaseStatus |
The lease status of the container. |
StorageListKeyExpand |
The StorageListKeyExpand. |
StorageMinimumTlsVersion |
Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. |
StorageNetworkBypass |
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. |
StoragePrivateEndpointConnectionProvisioningState |
The current provisioning state. |
StoragePrivateEndpointServiceConnectionStatus |
The private endpoint connection status. |
StoragePublicNetworkAccess |
Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. |
StorageRestrictionReasonCode |
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. |
StorageRoutingChoice |
Routing Choice defines the kind of network routing opted by the user. |
StorageSkuName |
The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. |
StorageTaskRunResult |
Represents the overall result of the execution for the run instance. |
StorageTaskRunStatus |
Represents the status of the execution. |
Enums
ExecutionTriggerType |
The trigger type of the storage task assignment execution. |
StorageAccountAccessTier |
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. |
StorageAccountExpand |
The StorageAccountExpand. |
StorageAccountHttpProtocol |
The protocol permitted for a request made with the account SAS. |
StorageAccountKeyPermission |
Permissions for the key -- read-only or full permissions. |
StorageAccountNameUnavailableReason |
Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false. |
StorageAccountStatus |
Gets the status indicating whether the primary location of the storage account is available or unavailable. |
StorageNetworkDefaultAction |
Specifies the default action of allow or deny when no other rules match. |
StorageProvisioningState |
Gets the status of the storage account at the time the operation was called. |
StoragePublicAccessType |
Specifies whether data in the container may be accessed publicly and the level of access. |
StorageSkuTier |
The SKU tier. This is based on the SKU name. |
StorageUsageUnit |
Gets the unit of measurement. |