storage.azure.com/v1api20220901
storage.azure.com/v1api20220901
Package v1api20220901 contains API Schema definitions for the storage v1api20220901 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2022-09-01" |
AccessPolicy
(Appears on:SignedIdentifier)
Field | Description |
---|---|
expiryTime string |
ExpiryTime: Expiry time of the access policy |
permission string |
Permission: List of abbreviated permissions. |
startTime string |
StartTime: Start time of the access policy |
AccessPolicy_ARM
(Appears on:SignedIdentifier_ARM)
Field | Description |
---|---|
expiryTime string |
ExpiryTime: Expiry time of the access policy |
permission string |
Permission: List of abbreviated permissions. |
startTime string |
StartTime: Start time of the access policy |
AccessPolicy_STATUS
(Appears on:SignedIdentifier_STATUS)
Field | Description |
---|---|
expiryTime string |
ExpiryTime: Expiry time of the access policy |
permission string |
Permission: List of abbreviated permissions. |
startTime string |
StartTime: Start time of the access policy |
AccessPolicy_STATUS_ARM
(Appears on:SignedIdentifier_STATUS_ARM)
Field | Description |
---|---|
expiryTime string |
ExpiryTime: Expiry time of the access policy |
permission string |
Permission: List of abbreviated permissions. |
startTime string |
StartTime: Start time of the access policy |
AccountImmutabilityPolicyProperties
(Appears on:ImmutableStorageAccount)
This defines account-level immutability policy properties.
Field | Description |
---|---|
allowProtectedAppendWrites bool |
AllowProtectedAppendWrites: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
state AccountImmutabilityPolicyProperties_State |
State: 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. |
AccountImmutabilityPolicyProperties_ARM
(Appears on:ImmutableStorageAccount_ARM)
This defines account-level immutability policy properties.
Field | Description |
---|---|
allowProtectedAppendWrites bool |
AllowProtectedAppendWrites: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
state AccountImmutabilityPolicyProperties_State_ARM |
State: 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. |
AccountImmutabilityPolicyProperties_STATUS
(Appears on:ImmutableStorageAccount_STATUS)
This defines account-level immutability policy properties.
Field | Description |
---|---|
allowProtectedAppendWrites bool |
AllowProtectedAppendWrites: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
state AccountImmutabilityPolicyProperties_State_STATUS |
State: 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. |
AccountImmutabilityPolicyProperties_STATUS_ARM
(Appears on:ImmutableStorageAccount_STATUS_ARM)
This defines account-level immutability policy properties.
Field | Description |
---|---|
allowProtectedAppendWrites bool |
AllowProtectedAppendWrites: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
state AccountImmutabilityPolicyProperties_State_STATUS_ARM |
State: 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. |
AccountImmutabilityPolicyProperties_State
(string
alias)
(Appears on:AccountImmutabilityPolicyProperties)
Value | Description |
---|---|
"Disabled" |
|
"Locked" |
|
"Unlocked" |
AccountImmutabilityPolicyProperties_State_ARM
(string
alias)
(Appears on:AccountImmutabilityPolicyProperties_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Locked" |
|
"Unlocked" |
AccountImmutabilityPolicyProperties_State_STATUS
(string
alias)
(Appears on:AccountImmutabilityPolicyProperties_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Locked" |
|
"Unlocked" |
AccountImmutabilityPolicyProperties_State_STATUS_ARM
(string
alias)
(Appears on:AccountImmutabilityPolicyProperties_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Locked" |
|
"Unlocked" |
ActiveDirectoryProperties
(Appears on:AzureFilesIdentityBasedAuthentication)
Settings properties for Active Directory (AD).
Field | Description |
---|---|
accountType ActiveDirectoryProperties_AccountType |
AccountType: Specifies the Active Directory account type for Azure Storage. |
azureStorageSid string |
AzureStorageSid: Specifies the security identifier (SID) for Azure Storage. |
domainGuid string |
DomainGuid: Specifies the domain GUID. |
domainName string |
DomainName: Specifies the primary domain that the AD DNS server is authoritative for. |
domainSid string |
DomainSid: Specifies the security identifier (SID). |
forestName string |
ForestName: Specifies the Active Directory forest to get. |
netBiosDomainName string |
NetBiosDomainName: Specifies the NetBIOS domain name. |
samAccountName string |
SamAccountName: Specifies the Active Directory SAMAccountName for Azure Storage. |
ActiveDirectoryProperties_ARM
(Appears on:AzureFilesIdentityBasedAuthentication_ARM)
Settings properties for Active Directory (AD).
Field | Description |
---|---|
accountType ActiveDirectoryProperties_AccountType_ARM |
AccountType: Specifies the Active Directory account type for Azure Storage. |
azureStorageSid string |
AzureStorageSid: Specifies the security identifier (SID) for Azure Storage. |
domainGuid string |
DomainGuid: Specifies the domain GUID. |
domainName string |
DomainName: Specifies the primary domain that the AD DNS server is authoritative for. |
domainSid string |
DomainSid: Specifies the security identifier (SID). |
forestName string |
ForestName: Specifies the Active Directory forest to get. |
netBiosDomainName string |
NetBiosDomainName: Specifies the NetBIOS domain name. |
samAccountName string |
SamAccountName: Specifies the Active Directory SAMAccountName for Azure Storage. |
ActiveDirectoryProperties_AccountType
(string
alias)
(Appears on:ActiveDirectoryProperties)
Value | Description |
---|---|
"Computer" |
|
"User" |
ActiveDirectoryProperties_AccountType_ARM
(string
alias)
(Appears on:ActiveDirectoryProperties_ARM)
Value | Description |
---|---|
"Computer" |
|
"User" |
ActiveDirectoryProperties_AccountType_STATUS
(string
alias)
(Appears on:ActiveDirectoryProperties_STATUS)
Value | Description |
---|---|
"Computer" |
|
"User" |
ActiveDirectoryProperties_AccountType_STATUS_ARM
(string
alias)
(Appears on:ActiveDirectoryProperties_STATUS_ARM)
Value | Description |
---|---|
"Computer" |
|
"User" |
ActiveDirectoryProperties_STATUS
(Appears on:AzureFilesIdentityBasedAuthentication_STATUS)
Settings properties for Active Directory (AD).
Field | Description |
---|---|
accountType ActiveDirectoryProperties_AccountType_STATUS |
AccountType: Specifies the Active Directory account type for Azure Storage. |
azureStorageSid string |
AzureStorageSid: Specifies the security identifier (SID) for Azure Storage. |
domainGuid string |
DomainGuid: Specifies the domain GUID. |
domainName string |
DomainName: Specifies the primary domain that the AD DNS server is authoritative for. |
domainSid string |
DomainSid: Specifies the security identifier (SID). |
forestName string |
ForestName: Specifies the Active Directory forest to get. |
netBiosDomainName string |
NetBiosDomainName: Specifies the NetBIOS domain name. |
samAccountName string |
SamAccountName: Specifies the Active Directory SAMAccountName for Azure Storage. |
ActiveDirectoryProperties_STATUS_ARM
(Appears on:AzureFilesIdentityBasedAuthentication_STATUS_ARM)
Settings properties for Active Directory (AD).
Field | Description |
---|---|
accountType ActiveDirectoryProperties_AccountType_STATUS_ARM |
AccountType: Specifies the Active Directory account type for Azure Storage. |
azureStorageSid string |
AzureStorageSid: Specifies the security identifier (SID) for Azure Storage. |
domainGuid string |
DomainGuid: Specifies the domain GUID. |
domainName string |
DomainName: Specifies the primary domain that the AD DNS server is authoritative for. |
domainSid string |
DomainSid: Specifies the security identifier (SID). |
forestName string |
ForestName: Specifies the Active Directory forest to get. |
netBiosDomainName string |
NetBiosDomainName: Specifies the NetBIOS domain name. |
samAccountName string |
SamAccountName: Specifies the Active Directory SAMAccountName for Azure Storage. |
AzureFilesIdentityBasedAuthentication
(Appears on:StorageAccount_Spec)
Settings for Azure Files identity based authentication.
Field | Description |
---|---|
activeDirectoryProperties ActiveDirectoryProperties |
ActiveDirectoryProperties: Required if directoryServiceOptions are AD, optional if they are AADKERB. |
defaultSharePermission AzureFilesIdentityBasedAuthentication_DefaultSharePermission |
DefaultSharePermission: Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
directoryServiceOptions AzureFilesIdentityBasedAuthentication_DirectoryServiceOptions |
DirectoryServiceOptions: Indicates the directory service used. Note that this enum may be extended in the future. |
AzureFilesIdentityBasedAuthentication_ARM
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
Settings for Azure Files identity based authentication.
Field | Description |
---|---|
activeDirectoryProperties ActiveDirectoryProperties_ARM |
ActiveDirectoryProperties: Required if directoryServiceOptions are AD, optional if they are AADKERB. |
defaultSharePermission AzureFilesIdentityBasedAuthentication_DefaultSharePermission_ARM |
DefaultSharePermission: Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
directoryServiceOptions AzureFilesIdentityBasedAuthentication_DirectoryServiceOptions_ARM |
DirectoryServiceOptions: Indicates the directory service used. Note that this enum may be extended in the future. |
AzureFilesIdentityBasedAuthentication_DefaultSharePermission
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication)
Value | Description |
---|---|
"None" |
|
"StorageFileDataSmbShareContributor" |
|
"StorageFileDataSmbShareElevatedContributor" |
|
"StorageFileDataSmbShareReader" |
AzureFilesIdentityBasedAuthentication_DefaultSharePermission_ARM
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication_ARM)
Value | Description |
---|---|
"None" |
|
"StorageFileDataSmbShareContributor" |
|
"StorageFileDataSmbShareElevatedContributor" |
|
"StorageFileDataSmbShareReader" |
AzureFilesIdentityBasedAuthentication_DefaultSharePermission_STATUS
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication_STATUS)
Value | Description |
---|---|
"None" |
|
"StorageFileDataSmbShareContributor" |
|
"StorageFileDataSmbShareElevatedContributor" |
|
"StorageFileDataSmbShareReader" |
AzureFilesIdentityBasedAuthentication_DefaultSharePermission_STATUS_ARM
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication_STATUS_ARM)
Value | Description |
---|---|
"None" |
|
"StorageFileDataSmbShareContributor" |
|
"StorageFileDataSmbShareElevatedContributor" |
|
"StorageFileDataSmbShareReader" |
AzureFilesIdentityBasedAuthentication_DirectoryServiceOptions
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication)
Value | Description |
---|---|
"AADDS" |
|
"AADKERB" |
|
"AD" |
|
"None" |
AzureFilesIdentityBasedAuthentication_DirectoryServiceOptions_ARM
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication_ARM)
Value | Description |
---|---|
"AADDS" |
|
"AADKERB" |
|
"AD" |
|
"None" |
AzureFilesIdentityBasedAuthentication_DirectoryServiceOptions_STATUS
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication_STATUS)
Value | Description |
---|---|
"AADDS" |
|
"AADKERB" |
|
"AD" |
|
"None" |
AzureFilesIdentityBasedAuthentication_DirectoryServiceOptions_STATUS_ARM
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication_STATUS_ARM)
Value | Description |
---|---|
"AADDS" |
|
"AADKERB" |
|
"AD" |
|
"None" |
AzureFilesIdentityBasedAuthentication_STATUS
(Appears on:StorageAccount_STATUS)
Settings for Azure Files identity based authentication.
Field | Description |
---|---|
activeDirectoryProperties ActiveDirectoryProperties_STATUS |
ActiveDirectoryProperties: Required if directoryServiceOptions are AD, optional if they are AADKERB. |
defaultSharePermission AzureFilesIdentityBasedAuthentication_DefaultSharePermission_STATUS |
DefaultSharePermission: Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
directoryServiceOptions AzureFilesIdentityBasedAuthentication_DirectoryServiceOptions_STATUS |
DirectoryServiceOptions: Indicates the directory service used. Note that this enum may be extended in the future. |
AzureFilesIdentityBasedAuthentication_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
Settings for Azure Files identity based authentication.
Field | Description |
---|---|
activeDirectoryProperties ActiveDirectoryProperties_STATUS_ARM |
ActiveDirectoryProperties: Required if directoryServiceOptions are AD, optional if they are AADKERB. |
defaultSharePermission AzureFilesIdentityBasedAuthentication_DefaultSharePermission_STATUS_ARM |
DefaultSharePermission: Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
directoryServiceOptions AzureFilesIdentityBasedAuthentication_DirectoryServiceOptions_STATUS_ARM |
DirectoryServiceOptions: Indicates the directory service used. Note that this enum may be extended in the future. |
BlobRestoreParameters_STATUS
(Appears on:BlobRestoreStatus_STATUS)
Blob restore parameters
Field | Description |
---|---|
blobRanges []BlobRestoreRange_STATUS |
BlobRanges: Blob ranges to restore. |
timeToRestore string |
TimeToRestore: Restore blob to the specified time. |
BlobRestoreParameters_STATUS_ARM
(Appears on:BlobRestoreStatus_STATUS_ARM)
Blob restore parameters
Field | Description |
---|---|
blobRanges []BlobRestoreRange_STATUS_ARM |
BlobRanges: Blob ranges to restore. |
timeToRestore string |
TimeToRestore: Restore blob to the specified time. |
BlobRestoreRange_STATUS
(Appears on:BlobRestoreParameters_STATUS)
Blob range
Field | Description |
---|---|
endRange string |
EndRange: Blob end range. This is exclusive. Empty means account end. |
startRange string |
StartRange: Blob start range. This is inclusive. Empty means account start. |
BlobRestoreRange_STATUS_ARM
(Appears on:BlobRestoreParameters_STATUS_ARM)
Blob range
Field | Description |
---|---|
endRange string |
EndRange: Blob end range. This is exclusive. Empty means account end. |
startRange string |
StartRange: Blob start range. This is inclusive. Empty means account start. |
BlobRestoreStatus_STATUS
(Appears on:StorageAccount_STATUS)
Blob restore status.
Field | Description |
---|---|
failureReason string |
FailureReason: Failure reason when blob restore is failed. |
parameters BlobRestoreParameters_STATUS |
Parameters: Blob restore request parameters. |
restoreId string |
RestoreId: Id for tracking blob restore request. |
status BlobRestoreStatus_Status_STATUS |
Status: 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. |
BlobRestoreStatus_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
Blob restore status.
Field | Description |
---|---|
failureReason string |
FailureReason: Failure reason when blob restore is failed. |
parameters BlobRestoreParameters_STATUS_ARM |
Parameters: Blob restore request parameters. |
restoreId string |
RestoreId: Id for tracking blob restore request. |
status BlobRestoreStatus_Status_STATUS_ARM |
Status: 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. |
BlobRestoreStatus_Status_STATUS
(string
alias)
(Appears on:BlobRestoreStatus_STATUS)
Value | Description |
---|---|
"Complete" |
|
"Failed" |
|
"InProgress" |
BlobRestoreStatus_Status_STATUS_ARM
(string
alias)
(Appears on:BlobRestoreStatus_STATUS_ARM)
Value | Description |
---|---|
"Complete" |
|
"Failed" |
|
"InProgress" |
ChangeFeed
(Appears on:StorageAccounts_BlobService_Spec)
The blob service properties for change feed events.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates whether change feed event logging is enabled for the Blob service. |
retentionInDays int |
RetentionInDays: Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed. |
ChangeFeed_ARM
(Appears on:StorageAccounts_BlobService_Properties_Spec_ARM)
The blob service properties for change feed events.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates whether change feed event logging is enabled for the Blob service. |
retentionInDays int |
RetentionInDays: Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed. |
ChangeFeed_STATUS
(Appears on:StorageAccounts_BlobService_STATUS)
The blob service properties for change feed events.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates whether change feed event logging is enabled for the Blob service. |
retentionInDays int |
RetentionInDays: Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed. |
ChangeFeed_STATUS_ARM
(Appears on:StorageAccounts_BlobService_Properties_STATUS_ARM)
The blob service properties for change feed events.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates whether change feed event logging is enabled for the Blob service. |
retentionInDays int |
RetentionInDays: Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed. |
ContainerProperties_ARM
(Appears on:StorageAccounts_BlobServices_Container_Spec_ARM)
The properties of a container.
Field | Description |
---|---|
defaultEncryptionScope string |
DefaultEncryptionScope: Default the container to use specified encryption scope for all writes. |
denyEncryptionScopeOverride bool |
DenyEncryptionScopeOverride: Block override of encryption scope from the container default. |
enableNfsV3AllSquash bool |
EnableNfsV3AllSquash: Enable NFSv3 all squash on blob container. |
enableNfsV3RootSquash bool |
EnableNfsV3RootSquash: Enable NFSv3 root squash on blob container. |
immutableStorageWithVersioning ImmutableStorageWithVersioning_ARM |
ImmutableStorageWithVersioning: The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process. |
metadata map[string]string |
Metadata: A name-value pair to associate with the container as metadata. |
publicAccess ContainerProperties_PublicAccess_ARM |
PublicAccess: Specifies whether data in the container may be accessed publicly and the level of access. |
ContainerProperties_LeaseDuration_STATUS
(string
alias)
(Appears on:StorageAccounts_BlobServices_Container_STATUS)
Value | Description |
---|---|
"Fixed" |
|
"Infinite" |
ContainerProperties_LeaseDuration_STATUS_ARM
(string
alias)
(Appears on:ContainerProperties_STATUS_ARM)
Value | Description |
---|---|
"Fixed" |
|
"Infinite" |
ContainerProperties_LeaseState_STATUS
(string
alias)
(Appears on:StorageAccounts_BlobServices_Container_STATUS)
Value | Description |
---|---|
"Available" |
|
"Breaking" |
|
"Broken" |
|
"Expired" |
|
"Leased" |
ContainerProperties_LeaseState_STATUS_ARM
(string
alias)
(Appears on:ContainerProperties_STATUS_ARM)
Value | Description |
---|---|
"Available" |
|
"Breaking" |
|
"Broken" |
|
"Expired" |
|
"Leased" |
ContainerProperties_LeaseStatus_STATUS
(string
alias)
(Appears on:StorageAccounts_BlobServices_Container_STATUS)
Value | Description |
---|---|
"Locked" |
|
"Unlocked" |
ContainerProperties_LeaseStatus_STATUS_ARM
(string
alias)
(Appears on:ContainerProperties_STATUS_ARM)
Value | Description |
---|---|
"Locked" |
|
"Unlocked" |
ContainerProperties_PublicAccess
(string
alias)
(Appears on:StorageAccounts_BlobServices_Container_Spec)
Value | Description |
---|---|
"Blob" |
|
"Container" |
|
"None" |
ContainerProperties_PublicAccess_ARM
(string
alias)
(Appears on:ContainerProperties_ARM)
Value | Description |
---|---|
"Blob" |
|
"Container" |
|
"None" |
ContainerProperties_PublicAccess_STATUS
(string
alias)
(Appears on:StorageAccounts_BlobServices_Container_STATUS)
Value | Description |
---|---|
"Blob" |
|
"Container" |
|
"None" |
ContainerProperties_PublicAccess_STATUS_ARM
(string
alias)
(Appears on:ContainerProperties_STATUS_ARM)
Value | Description |
---|---|
"Blob" |
|
"Container" |
|
"None" |
ContainerProperties_STATUS_ARM
(Appears on:StorageAccounts_BlobServices_Container_STATUS_ARM)
The properties of a container.
Field | Description |
---|---|
defaultEncryptionScope string |
DefaultEncryptionScope: Default the container to use specified encryption scope for all writes. |
deleted bool |
Deleted: Indicates whether the blob container was deleted. |
deletedTime string |
DeletedTime: Blob container deletion time. |
denyEncryptionScopeOverride bool |
DenyEncryptionScopeOverride: Block override of encryption scope from the container default. |
enableNfsV3AllSquash bool |
EnableNfsV3AllSquash: Enable NFSv3 all squash on blob container. |
enableNfsV3RootSquash bool |
EnableNfsV3RootSquash: Enable NFSv3 root squash on blob container. |
hasImmutabilityPolicy bool |
HasImmutabilityPolicy: The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. |
hasLegalHold bool |
HasLegalHold: The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. |
immutabilityPolicy ImmutabilityPolicyProperties_STATUS_ARM |
ImmutabilityPolicy: The ImmutabilityPolicy property of the container. |
immutableStorageWithVersioning ImmutableStorageWithVersioning_STATUS_ARM |
ImmutableStorageWithVersioning: The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process. |
lastModifiedTime string |
LastModifiedTime: Returns the date and time the container was last modified. |
leaseDuration ContainerProperties_LeaseDuration_STATUS_ARM |
LeaseDuration: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. |
leaseState ContainerProperties_LeaseState_STATUS_ARM |
LeaseState: Lease state of the container. |
leaseStatus ContainerProperties_LeaseStatus_STATUS_ARM |
LeaseStatus: The lease status of the container. |
legalHold LegalHoldProperties_STATUS_ARM |
LegalHold: The LegalHold property of the container. |
metadata map[string]string |
Metadata: A name-value pair to associate with the container as metadata. |
publicAccess ContainerProperties_PublicAccess_STATUS_ARM |
PublicAccess: Specifies whether data in the container may be accessed publicly and the level of access. |
remainingRetentionDays int |
RemainingRetentionDays: Remaining retention days for soft deleted blob container. |
version string |
Version: The version of the deleted blob container. |
CorsRule
(Appears on:CorsRules)
Specifies a CORS rule for the Blob service.
Field | Description |
---|---|
allowedHeaders []string |
AllowedHeaders: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. |
allowedMethods []CorsRule_AllowedMethods |
AllowedMethods: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. |
allowedOrigins []string |
AllowedOrigins: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or “*” to allow all domains |
exposedHeaders []string |
ExposedHeaders: Required if CorsRule element is present. A list of response headers to expose to CORS clients. |
maxAgeInSeconds int |
MaxAgeInSeconds: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. |
CorsRule_ARM
(Appears on:CorsRules_ARM)
Specifies a CORS rule for the Blob service.
Field | Description |
---|---|
allowedHeaders []string |
AllowedHeaders: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. |
allowedMethods []CorsRule_AllowedMethods_ARM |
AllowedMethods: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. |
allowedOrigins []string |
AllowedOrigins: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or “*” to allow all domains |
exposedHeaders []string |
ExposedHeaders: Required if CorsRule element is present. A list of response headers to expose to CORS clients. |
maxAgeInSeconds int |
MaxAgeInSeconds: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. |
CorsRule_AllowedMethods
(string
alias)
(Appears on:CorsRule)
Value | Description |
---|---|
"DELETE" |
|
"GET" |
|
"HEAD" |
|
"MERGE" |
|
"OPTIONS" |
|
"PATCH" |
|
"POST" |
|
"PUT" |
CorsRule_AllowedMethods_ARM
(string
alias)
(Appears on:CorsRule_ARM)
Value | Description |
---|---|
"DELETE" |
|
"GET" |
|
"HEAD" |
|
"MERGE" |
|
"OPTIONS" |
|
"PATCH" |
|
"POST" |
|
"PUT" |
CorsRule_AllowedMethods_STATUS
(string
alias)
(Appears on:CorsRule_STATUS)
Value | Description |
---|---|
"DELETE" |
|
"GET" |
|
"HEAD" |
|
"MERGE" |
|
"OPTIONS" |
|
"PATCH" |
|
"POST" |
|
"PUT" |
CorsRule_AllowedMethods_STATUS_ARM
(string
alias)
(Appears on:CorsRule_STATUS_ARM)
Value | Description |
---|---|
"DELETE" |
|
"GET" |
|
"HEAD" |
|
"MERGE" |
|
"OPTIONS" |
|
"PATCH" |
|
"POST" |
|
"PUT" |
CorsRule_STATUS
(Appears on:CorsRules_STATUS)
Specifies a CORS rule for the Blob service.
Field | Description |
---|---|
allowedHeaders []string |
AllowedHeaders: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. |
allowedMethods []CorsRule_AllowedMethods_STATUS |
AllowedMethods: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. |
allowedOrigins []string |
AllowedOrigins: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or “*” to allow all domains |
exposedHeaders []string |
ExposedHeaders: Required if CorsRule element is present. A list of response headers to expose to CORS clients. |
maxAgeInSeconds int |
MaxAgeInSeconds: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. |
CorsRule_STATUS_ARM
(Appears on:CorsRules_STATUS_ARM)
Specifies a CORS rule for the Blob service.
Field | Description |
---|---|
allowedHeaders []string |
AllowedHeaders: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. |
allowedMethods []CorsRule_AllowedMethods_STATUS_ARM |
AllowedMethods: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. |
allowedOrigins []string |
AllowedOrigins: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or “*” to allow all domains |
exposedHeaders []string |
ExposedHeaders: Required if CorsRule element is present. A list of response headers to expose to CORS clients. |
maxAgeInSeconds int |
MaxAgeInSeconds: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. |
CorsRules
(Appears on:StorageAccounts_BlobService_Spec, StorageAccounts_FileService_Spec, StorageAccounts_QueueService_Spec, StorageAccounts_TableService_Spec)
Sets the CORS rules. You can include up to five CorsRule elements in the request.
Field | Description |
---|---|
corsRules []CorsRule |
CorsRules: The List of CORS rules. You can include up to five CorsRule elements in the request. |
CorsRules_ARM
(Appears on:StorageAccounts_BlobService_Properties_Spec_ARM, StorageAccounts_FileService_Properties_Spec_ARM, StorageAccounts_QueueService_Properties_Spec_ARM, StorageAccounts_TableService_Properties_Spec_ARM)
Sets the CORS rules. You can include up to five CorsRule elements in the request.
Field | Description |
---|---|
corsRules []CorsRule_ARM |
CorsRules: The List of CORS rules. You can include up to five CorsRule elements in the request. |
CorsRules_STATUS
(Appears on:StorageAccounts_BlobService_STATUS, StorageAccounts_FileService_STATUS, StorageAccounts_QueueService_STATUS, StorageAccounts_TableService_STATUS)
Sets the CORS rules. You can include up to five CorsRule elements in the request.
Field | Description |
---|---|
corsRules []CorsRule_STATUS |
CorsRules: The List of CORS rules. You can include up to five CorsRule elements in the request. |
CorsRules_STATUS_ARM
(Appears on:StorageAccounts_BlobService_Properties_STATUS_ARM, StorageAccounts_FileService_Properties_STATUS_ARM, StorageAccounts_QueueService_Properties_STATUS_ARM, StorageAccounts_TableService_Properties_STATUS_ARM)
Sets the CORS rules. You can include up to five CorsRule elements in the request.
Field | Description |
---|---|
corsRules []CorsRule_STATUS_ARM |
CorsRules: The List of CORS rules. You can include up to five CorsRule elements in the request. |
CustomDomain
(Appears on:StorageAccount_Spec)
The custom domain assigned to this storage account. This can be set via Update.
Field | Description |
---|---|
name string |
Name: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. |
useSubDomainName bool |
UseSubDomainName: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. |
CustomDomain_ARM
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
The custom domain assigned to this storage account. This can be set via Update.
Field | Description |
---|---|
name string |
Name: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. |
useSubDomainName bool |
UseSubDomainName: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. |
CustomDomain_STATUS
(Appears on:StorageAccount_STATUS)
The custom domain assigned to this storage account. This can be set via Update.
Field | Description |
---|---|
name string |
Name: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. |
useSubDomainName bool |
UseSubDomainName: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. |
CustomDomain_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
The custom domain assigned to this storage account. This can be set via Update.
Field | Description |
---|---|
name string |
Name: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. |
useSubDomainName bool |
UseSubDomainName: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. |
DateAfterCreation
(Appears on:ManagementPolicySnapShot, ManagementPolicyVersion)
Object to define snapshot and version action conditions.
Field | Description |
---|---|
daysAfterCreationGreaterThan int |
DaysAfterCreationGreaterThan: Value indicating the age in days after creation |
daysAfterLastTierChangeGreaterThan int |
DaysAfterLastTierChangeGreaterThan: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. |
DateAfterCreation_ARM
(Appears on:ManagementPolicySnapShot_ARM, ManagementPolicyVersion_ARM)
Object to define snapshot and version action conditions.
Field | Description |
---|---|
daysAfterCreationGreaterThan int |
DaysAfterCreationGreaterThan: Value indicating the age in days after creation |
daysAfterLastTierChangeGreaterThan int |
DaysAfterLastTierChangeGreaterThan: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. |
DateAfterCreation_STATUS
(Appears on:ManagementPolicySnapShot_STATUS, ManagementPolicyVersion_STATUS)
Object to define snapshot and version action conditions.
Field | Description |
---|---|
daysAfterCreationGreaterThan float64 |
DaysAfterCreationGreaterThan: Value indicating the age in days after creation |
daysAfterLastTierChangeGreaterThan float64 |
DaysAfterLastTierChangeGreaterThan: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. |
DateAfterCreation_STATUS_ARM
(Appears on:ManagementPolicySnapShot_STATUS_ARM, ManagementPolicyVersion_STATUS_ARM)
Object to define snapshot and version action conditions.
Field | Description |
---|---|
daysAfterCreationGreaterThan float64 |
DaysAfterCreationGreaterThan: Value indicating the age in days after creation |
daysAfterLastTierChangeGreaterThan float64 |
DaysAfterLastTierChangeGreaterThan: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. |
DateAfterModification
(Appears on:ManagementPolicyBaseBlob)
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.
Field | Description |
---|---|
daysAfterCreationGreaterThan int |
DaysAfterCreationGreaterThan: Value indicating the age in days after blob creation. |
daysAfterLastAccessTimeGreaterThan int |
DaysAfterLastAccessTimeGreaterThan: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy |
daysAfterLastTierChangeGreaterThan int |
DaysAfterLastTierChangeGreaterThan: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. |
daysAfterModificationGreaterThan int |
DaysAfterModificationGreaterThan: Value indicating the age in days after last modification |
DateAfterModification_ARM
(Appears on:ManagementPolicyBaseBlob_ARM)
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.
Field | Description |
---|---|
daysAfterCreationGreaterThan int |
DaysAfterCreationGreaterThan: Value indicating the age in days after blob creation. |
daysAfterLastAccessTimeGreaterThan int |
DaysAfterLastAccessTimeGreaterThan: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy |
daysAfterLastTierChangeGreaterThan int |
DaysAfterLastTierChangeGreaterThan: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. |
daysAfterModificationGreaterThan int |
DaysAfterModificationGreaterThan: Value indicating the age in days after last modification |
DateAfterModification_STATUS
(Appears on:ManagementPolicyBaseBlob_STATUS)
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.
Field | Description |
---|---|
daysAfterCreationGreaterThan float64 |
DaysAfterCreationGreaterThan: Value indicating the age in days after blob creation. |
daysAfterLastAccessTimeGreaterThan float64 |
DaysAfterLastAccessTimeGreaterThan: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy |
daysAfterLastTierChangeGreaterThan float64 |
DaysAfterLastTierChangeGreaterThan: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. |
daysAfterModificationGreaterThan float64 |
DaysAfterModificationGreaterThan: Value indicating the age in days after last modification |
DateAfterModification_STATUS_ARM
(Appears on:ManagementPolicyBaseBlob_STATUS_ARM)
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.
Field | Description |
---|---|
daysAfterCreationGreaterThan float64 |
DaysAfterCreationGreaterThan: Value indicating the age in days after blob creation. |
daysAfterLastAccessTimeGreaterThan float64 |
DaysAfterLastAccessTimeGreaterThan: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy |
daysAfterLastTierChangeGreaterThan float64 |
DaysAfterLastTierChangeGreaterThan: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. |
daysAfterModificationGreaterThan float64 |
DaysAfterModificationGreaterThan: Value indicating the age in days after last modification |
DeleteRetentionPolicy
(Appears on:StorageAccounts_BlobService_Spec, StorageAccounts_FileService_Spec)
The service properties for soft delete.
Field | Description |
---|---|
allowPermanentDelete bool |
AllowPermanentDelete: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. |
days int |
Days: Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365. |
enabled bool |
Enabled: Indicates whether DeleteRetentionPolicy is enabled. |
DeleteRetentionPolicy_ARM
(Appears on:StorageAccounts_BlobService_Properties_Spec_ARM, StorageAccounts_FileService_Properties_Spec_ARM)
The service properties for soft delete.
Field | Description |
---|---|
allowPermanentDelete bool |
AllowPermanentDelete: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. |
days int |
Days: Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365. |
enabled bool |
Enabled: Indicates whether DeleteRetentionPolicy is enabled. |
DeleteRetentionPolicy_STATUS
(Appears on:StorageAccounts_BlobService_STATUS, StorageAccounts_FileService_STATUS)
The service properties for soft delete.
Field | Description |
---|---|
allowPermanentDelete bool |
AllowPermanentDelete: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. |
days int |
Days: Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365. |
enabled bool |
Enabled: Indicates whether DeleteRetentionPolicy is enabled. |
DeleteRetentionPolicy_STATUS_ARM
(Appears on:StorageAccounts_BlobService_Properties_STATUS_ARM, StorageAccounts_FileService_Properties_STATUS_ARM)
The service properties for soft delete.
Field | Description |
---|---|
allowPermanentDelete bool |
AllowPermanentDelete: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. |
days int |
Days: Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365. |
enabled bool |
Enabled: Indicates whether DeleteRetentionPolicy is enabled. |
Encryption
(Appears on:StorageAccount_Spec)
The encryption settings on the storage account.
Field | Description |
---|---|
identity EncryptionIdentity |
Identity: The identity to be used with service-side encryption at rest. |
keySource Encryption_KeySource |
KeySource: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault |
keyvaultproperties KeyVaultProperties |
Keyvaultproperties: Properties provided by key vault. |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. |
services EncryptionServices |
Services: List of services which support encryption. |
EncryptionIdentity
(Appears on:Encryption)
Encryption identity for the storage account.
Field | Description |
---|---|
federatedIdentityClientId string |
FederatedIdentityClientId: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. |
userAssignedIdentityReference genruntime.ResourceReference |
UserAssignedIdentityReference: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. |
EncryptionIdentity_ARM
(Appears on:Encryption_ARM)
Encryption identity for the storage account.
Field | Description |
---|---|
federatedIdentityClientId string |
FederatedIdentityClientId: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. |
userAssignedIdentity string |
EncryptionIdentity_STATUS
(Appears on:Encryption_STATUS)
Encryption identity for the storage account.
Field | Description |
---|---|
federatedIdentityClientId string |
FederatedIdentityClientId: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. |
userAssignedIdentity string |
UserAssignedIdentity: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. |
EncryptionIdentity_STATUS_ARM
(Appears on:Encryption_STATUS_ARM)
Encryption identity for the storage account.
Field | Description |
---|---|
federatedIdentityClientId string |
FederatedIdentityClientId: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. |
userAssignedIdentity string |
UserAssignedIdentity: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. |
EncryptionService
(Appears on:EncryptionServices)
A service that allows server-side encryption to be used.
Field | Description |
---|---|
enabled bool |
Enabled: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. |
keyType EncryptionService_KeyType |
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. |
EncryptionService_ARM
(Appears on:EncryptionServices_ARM)
A service that allows server-side encryption to be used.
Field | Description |
---|---|
enabled bool |
Enabled: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. |
keyType EncryptionService_KeyType_ARM |
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. |
EncryptionService_KeyType
(string
alias)
(Appears on:EncryptionService)
Value | Description |
---|---|
"Account" |
|
"Service" |
EncryptionService_KeyType_ARM
(string
alias)
(Appears on:EncryptionService_ARM)
Value | Description |
---|---|
"Account" |
|
"Service" |
EncryptionService_KeyType_STATUS
(string
alias)
(Appears on:EncryptionService_STATUS)
Value | Description |
---|---|
"Account" |
|
"Service" |
EncryptionService_KeyType_STATUS_ARM
(string
alias)
(Appears on:EncryptionService_STATUS_ARM)
Value | Description |
---|---|
"Account" |
|
"Service" |
EncryptionService_STATUS
(Appears on:EncryptionServices_STATUS)
A service that allows server-side encryption to be used.
Field | Description |
---|---|
enabled bool |
Enabled: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. |
keyType EncryptionService_KeyType_STATUS |
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. |
lastEnabledTime string |
LastEnabledTime: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. |
EncryptionService_STATUS_ARM
(Appears on:EncryptionServices_STATUS_ARM)
A service that allows server-side encryption to be used.
Field | Description |
---|---|
enabled bool |
Enabled: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. |
keyType EncryptionService_KeyType_STATUS_ARM |
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. |
lastEnabledTime string |
LastEnabledTime: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. |
EncryptionServices
(Appears on:Encryption)
A list of services that support encryption.
Field | Description |
---|---|
blob EncryptionService |
Blob: The encryption function of the blob storage service. |
file EncryptionService |
File: The encryption function of the file storage service. |
queue EncryptionService |
Queue: The encryption function of the queue storage service. |
table EncryptionService |
Table: The encryption function of the table storage service. |
EncryptionServices_ARM
(Appears on:Encryption_ARM)
A list of services that support encryption.
Field | Description |
---|---|
blob EncryptionService_ARM |
Blob: The encryption function of the blob storage service. |
file EncryptionService_ARM |
File: The encryption function of the file storage service. |
queue EncryptionService_ARM |
Queue: The encryption function of the queue storage service. |
table EncryptionService_ARM |
Table: The encryption function of the table storage service. |
EncryptionServices_STATUS
(Appears on:Encryption_STATUS)
A list of services that support encryption.
Field | Description |
---|---|
blob EncryptionService_STATUS |
Blob: The encryption function of the blob storage service. |
file EncryptionService_STATUS |
File: The encryption function of the file storage service. |
queue EncryptionService_STATUS |
Queue: The encryption function of the queue storage service. |
table EncryptionService_STATUS |
Table: The encryption function of the table storage service. |
EncryptionServices_STATUS_ARM
(Appears on:Encryption_STATUS_ARM)
A list of services that support encryption.
Field | Description |
---|---|
blob EncryptionService_STATUS_ARM |
Blob: The encryption function of the blob storage service. |
file EncryptionService_STATUS_ARM |
File: The encryption function of the file storage service. |
queue EncryptionService_STATUS_ARM |
Queue: The encryption function of the queue storage service. |
table EncryptionService_STATUS_ARM |
Table: The encryption function of the table storage service. |
Encryption_ARM
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
The encryption settings on the storage account.
Field | Description |
---|---|
identity EncryptionIdentity_ARM |
Identity: The identity to be used with service-side encryption at rest. |
keySource Encryption_KeySource_ARM |
KeySource: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault |
keyvaultproperties KeyVaultProperties_ARM |
Keyvaultproperties: Properties provided by key vault. |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. |
services EncryptionServices_ARM |
Services: List of services which support encryption. |
Encryption_KeySource
(string
alias)
(Appears on:Encryption)
Value | Description |
---|---|
"Microsoft.Keyvault" |
|
"Microsoft.Storage" |
Encryption_KeySource_ARM
(string
alias)
(Appears on:Encryption_ARM)
Value | Description |
---|---|
"Microsoft.Keyvault" |
|
"Microsoft.Storage" |
Encryption_KeySource_STATUS
(string
alias)
(Appears on:Encryption_STATUS)
Value | Description |
---|---|
"Microsoft.Keyvault" |
|
"Microsoft.Storage" |
Encryption_KeySource_STATUS_ARM
(string
alias)
(Appears on:Encryption_STATUS_ARM)
Value | Description |
---|---|
"Microsoft.Keyvault" |
|
"Microsoft.Storage" |
Encryption_STATUS
(Appears on:StorageAccount_STATUS)
The encryption settings on the storage account.
Field | Description |
---|---|
identity EncryptionIdentity_STATUS |
Identity: The identity to be used with service-side encryption at rest. |
keySource Encryption_KeySource_STATUS |
KeySource: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault |
keyvaultproperties KeyVaultProperties_STATUS |
Keyvaultproperties: Properties provided by key vault. |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. |
services EncryptionServices_STATUS |
Services: List of services which support encryption. |
Encryption_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
The encryption settings on the storage account.
Field | Description |
---|---|
identity EncryptionIdentity_STATUS_ARM |
Identity: The identity to be used with service-side encryption at rest. |
keySource Encryption_KeySource_STATUS_ARM |
KeySource: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault |
keyvaultproperties KeyVaultProperties_STATUS_ARM |
Keyvaultproperties: Properties provided by key vault. |
requireInfrastructureEncryption bool |
RequireInfrastructureEncryption: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. |
services EncryptionServices_STATUS_ARM |
Services: List of services which support encryption. |
Endpoints_STATUS
(Appears on:StorageAccount_STATUS)
The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object.
Field | Description |
---|---|
blob string |
Blob: Gets the blob endpoint. |
dfs string |
Dfs: Gets the dfs endpoint. |
file string |
File: Gets the file endpoint. |
internetEndpoints StorageAccountInternetEndpoints_STATUS |
InternetEndpoints: Gets the internet routing storage endpoints |
microsoftEndpoints StorageAccountMicrosoftEndpoints_STATUS |
MicrosoftEndpoints: Gets the microsoft routing storage endpoints. |
queue string |
Queue: Gets the queue endpoint. |
table string |
Table: Gets the table endpoint. |
web string |
Web: Gets the web endpoint. |
Endpoints_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object.
Field | Description |
---|---|
blob string |
Blob: Gets the blob endpoint. |
dfs string |
Dfs: Gets the dfs endpoint. |
file string |
File: Gets the file endpoint. |
internetEndpoints StorageAccountInternetEndpoints_STATUS_ARM |
InternetEndpoints: Gets the internet routing storage endpoints |
microsoftEndpoints StorageAccountMicrosoftEndpoints_STATUS_ARM |
MicrosoftEndpoints: Gets the microsoft routing storage endpoints. |
queue string |
Queue: Gets the queue endpoint. |
table string |
Table: Gets the table endpoint. |
web string |
Web: Gets the web endpoint. |
ExtendedLocation
(Appears on:StorageAccount_Spec)
The complex type of the extended location.
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType |
Type: The type of the extended location. |
ExtendedLocationType
(string
alias)
(Appears on:ExtendedLocation)
The type of extendedLocation.
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocationType_ARM
(string
alias)
(Appears on:ExtendedLocation_ARM)
The type of extendedLocation.
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocationType_STATUS
(string
alias)
(Appears on:ExtendedLocation_STATUS)
The type of extendedLocation.
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocationType_STATUS_ARM
(string
alias)
(Appears on:ExtendedLocation_STATUS_ARM)
The type of extendedLocation.
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocation_ARM
(Appears on:StorageAccount_Spec_ARM)
The complex type of the extended location.
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_ARM |
Type: The type of the extended location. |
ExtendedLocation_STATUS
(Appears on:StorageAccount_STATUS)
The complex type of the extended location.
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_STATUS |
Type: The type of the extended location. |
ExtendedLocation_STATUS_ARM
(Appears on:StorageAccount_STATUS_ARM)
The complex type of the extended location.
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_STATUS_ARM |
Type: The type of the extended location. |
FileShareProperties_ARM
(Appears on:StorageAccounts_FileServices_Share_Spec_ARM)
The properties of the file share.
Field | Description |
---|---|
accessTier FileShareProperties_AccessTier_ARM |
AccessTier: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
enabledProtocols FileShareProperties_EnabledProtocols_ARM |
EnabledProtocols: The authentication protocol that is used for the file share. Can only be specified when creating a share. |
metadata map[string]string |
Metadata: A name-value pair to associate with the share as metadata. |
rootSquash FileShareProperties_RootSquash_ARM |
RootSquash: The property is for NFS share only. The default is NoRootSquash. |
shareQuota int |
ShareQuota: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. |
signedIdentifiers []SignedIdentifier_ARM |
SignedIdentifiers: List of stored access policies specified on the share. |
FileShareProperties_AccessTier
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_Spec)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
|
"Premium" |
|
"TransactionOptimized" |
FileShareProperties_AccessTier_ARM
(string
alias)
(Appears on:FileShareProperties_ARM)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
|
"Premium" |
|
"TransactionOptimized" |
FileShareProperties_AccessTier_STATUS
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_STATUS)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
|
"Premium" |
|
"TransactionOptimized" |
FileShareProperties_AccessTier_STATUS_ARM
(string
alias)
(Appears on:FileShareProperties_STATUS_ARM)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
|
"Premium" |
|
"TransactionOptimized" |
FileShareProperties_EnabledProtocols
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_Spec)
Value | Description |
---|---|
"NFS" |
|
"SMB" |
FileShareProperties_EnabledProtocols_ARM
(string
alias)
(Appears on:FileShareProperties_ARM)
Value | Description |
---|---|
"NFS" |
|
"SMB" |
FileShareProperties_EnabledProtocols_STATUS
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_STATUS)
Value | Description |
---|---|
"NFS" |
|
"SMB" |
FileShareProperties_EnabledProtocols_STATUS_ARM
(string
alias)
(Appears on:FileShareProperties_STATUS_ARM)
Value | Description |
---|---|
"NFS" |
|
"SMB" |
FileShareProperties_LeaseDuration_STATUS
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_STATUS)
Value | Description |
---|---|
"Fixed" |
|
"Infinite" |
FileShareProperties_LeaseDuration_STATUS_ARM
(string
alias)
(Appears on:FileShareProperties_STATUS_ARM)
Value | Description |
---|---|
"Fixed" |
|
"Infinite" |
FileShareProperties_LeaseState_STATUS
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_STATUS)
Value | Description |
---|---|
"Available" |
|
"Breaking" |
|
"Broken" |
|
"Expired" |
|
"Leased" |
FileShareProperties_LeaseState_STATUS_ARM
(string
alias)
(Appears on:FileShareProperties_STATUS_ARM)
Value | Description |
---|---|
"Available" |
|
"Breaking" |
|
"Broken" |
|
"Expired" |
|
"Leased" |
FileShareProperties_LeaseStatus_STATUS
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_STATUS)
Value | Description |
---|---|
"Locked" |
|
"Unlocked" |
FileShareProperties_LeaseStatus_STATUS_ARM
(string
alias)
(Appears on:FileShareProperties_STATUS_ARM)
Value | Description |
---|---|
"Locked" |
|
"Unlocked" |
FileShareProperties_RootSquash
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_Spec)
Value | Description |
---|---|
"AllSquash" |
|
"NoRootSquash" |
|
"RootSquash" |
FileShareProperties_RootSquash_ARM
(string
alias)
(Appears on:FileShareProperties_ARM)
Value | Description |
---|---|
"AllSquash" |
|
"NoRootSquash" |
|
"RootSquash" |
FileShareProperties_RootSquash_STATUS
(string
alias)
(Appears on:StorageAccounts_FileServices_Share_STATUS)
Value | Description |
---|---|
"AllSquash" |
|
"NoRootSquash" |
|
"RootSquash" |
FileShareProperties_RootSquash_STATUS_ARM
(string
alias)
(Appears on:FileShareProperties_STATUS_ARM)
Value | Description |
---|---|
"AllSquash" |
|
"NoRootSquash" |
|
"RootSquash" |
FileShareProperties_STATUS_ARM
(Appears on:StorageAccounts_FileServices_Share_STATUS_ARM)
The properties of the file share.
Field | Description |
---|---|
accessTier FileShareProperties_AccessTier_STATUS_ARM |
AccessTier: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
accessTierChangeTime string |
AccessTierChangeTime: Indicates the last modification time for share access tier. |
accessTierStatus string |
AccessTierStatus: Indicates if there is a pending transition for access tier. |
deleted bool |
Deleted: Indicates whether the share was deleted. |
deletedTime string |
DeletedTime: The deleted time if the share was deleted. |
enabledProtocols FileShareProperties_EnabledProtocols_STATUS_ARM |
EnabledProtocols: The authentication protocol that is used for the file share. Can only be specified when creating a share. |
lastModifiedTime string |
LastModifiedTime: Returns the date and time the share was last modified. |
leaseDuration FileShareProperties_LeaseDuration_STATUS_ARM |
LeaseDuration: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. |
leaseState FileShareProperties_LeaseState_STATUS_ARM |
LeaseState: Lease state of the share. |
leaseStatus FileShareProperties_LeaseStatus_STATUS_ARM |
LeaseStatus: The lease status of the share. |
metadata map[string]string |
Metadata: A name-value pair to associate with the share as metadata. |
remainingRetentionDays int |
RemainingRetentionDays: Remaining retention days for share that was soft deleted. |
rootSquash FileShareProperties_RootSquash_STATUS_ARM |
RootSquash: The property is for NFS share only. The default is NoRootSquash. |
shareQuota int |
ShareQuota: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. |
shareUsageBytes int |
ShareUsageBytes: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. |
signedIdentifiers []SignedIdentifier_STATUS_ARM |
SignedIdentifiers: List of stored access policies specified on the share. |
snapshotTime string |
SnapshotTime: Creation time of share snapshot returned in the response of list shares with expand param “snapshots”. |
version string |
Version: The version of the share. |
GeoReplicationStats_STATUS
(Appears on:StorageAccount_STATUS)
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.
Field | Description |
---|---|
canFailover bool |
CanFailover: A boolean flag which indicates whether or not account failover is supported for the account. |
lastSyncTime string |
LastSyncTime: All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. |
status GeoReplicationStats_Status_STATUS |
Status: 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. |
GeoReplicationStats_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
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.
Field | Description |
---|---|
canFailover bool |
CanFailover: A boolean flag which indicates whether or not account failover is supported for the account. |
lastSyncTime string |
LastSyncTime: All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. |
status GeoReplicationStats_Status_STATUS_ARM |
Status: 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. |
GeoReplicationStats_Status_STATUS
(string
alias)
(Appears on:GeoReplicationStats_STATUS)
Value | Description |
---|---|
"Bootstrap" |
|
"Live" |
|
"Unavailable" |
GeoReplicationStats_Status_STATUS_ARM
(string
alias)
(Appears on:GeoReplicationStats_STATUS_ARM)
Value | Description |
---|---|
"Bootstrap" |
|
"Live" |
|
"Unavailable" |
IPRule
(Appears on:NetworkRuleSet)
IP rule with specific IP or IP range in CIDR format.
Field | Description |
---|---|
action IPRule_Action |
Action: The action of IP ACL rule. |
value string |
Value: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
IPRule_ARM
(Appears on:NetworkRuleSet_ARM)
IP rule with specific IP or IP range in CIDR format.
Field | Description |
---|---|
action IPRule_Action_ARM |
Action: The action of IP ACL rule. |
value string |
Value: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
IPRule_Action
(string
alias)
(Appears on:IPRule)
Value | Description |
---|---|
"Allow" |
IPRule_Action_ARM
(string
alias)
(Appears on:IPRule_ARM)
Value | Description |
---|---|
"Allow" |
IPRule_Action_STATUS
(string
alias)
(Appears on:IPRule_STATUS)
Value | Description |
---|---|
"Allow" |
IPRule_Action_STATUS_ARM
(string
alias)
(Appears on:IPRule_STATUS_ARM)
Value | Description |
---|---|
"Allow" |
IPRule_STATUS
(Appears on:NetworkRuleSet_STATUS)
IP rule with specific IP or IP range in CIDR format.
Field | Description |
---|---|
action IPRule_Action_STATUS |
Action: The action of IP ACL rule. |
value string |
Value: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
IPRule_STATUS_ARM
(Appears on:NetworkRuleSet_STATUS_ARM)
IP rule with specific IP or IP range in CIDR format.
Field | Description |
---|---|
action IPRule_Action_STATUS_ARM |
Action: The action of IP ACL rule. |
value string |
Value: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
Identity
(Appears on:StorageAccount_Spec)
Identity for the resource.
Field | Description |
---|---|
type Identity_Type |
Type: The identity type. |
userAssignedIdentities []UserAssignedIdentityDetails |
UserAssignedIdentities: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. |
Identity_ARM
(Appears on:StorageAccount_Spec_ARM)
Identity for the resource.
Field | Description |
---|---|
type Identity_Type_ARM |
Type: The identity type. |
userAssignedIdentities map[string]./api/storage/v1api20220901.UserAssignedIdentityDetails_ARM |
Identity_STATUS
(Appears on:StorageAccount_STATUS)
Identity for the resource.
Field | Description |
---|---|
principalId string |
PrincipalId: The principal ID of resource identity. |
tenantId string |
TenantId: The tenant ID of resource. |
type Identity_Type_STATUS |
Type: The identity type. |
userAssignedIdentities map[string]./api/storage/v1api20220901.UserAssignedIdentity_STATUS |
UserAssignedIdentities: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. |
Identity_STATUS_ARM
(Appears on:StorageAccount_STATUS_ARM)
Identity for the resource.
Field | Description |
---|---|
principalId string |
PrincipalId: The principal ID of resource identity. |
tenantId string |
TenantId: The tenant ID of resource. |
type Identity_Type_STATUS_ARM |
Type: The identity type. |
userAssignedIdentities map[string]./api/storage/v1api20220901.UserAssignedIdentity_STATUS_ARM |
UserAssignedIdentities: Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. |
Identity_Type
(string
alias)
(Appears on:Identity)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
Identity_Type_ARM
(string
alias)
(Appears on:Identity_ARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
Identity_Type_STATUS
(string
alias)
(Appears on:Identity_STATUS)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
Identity_Type_STATUS_ARM
(string
alias)
(Appears on:Identity_STATUS_ARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
ImmutabilityPolicyProperties_STATUS
(Appears on:StorageAccounts_BlobServices_Container_STATUS)
The properties of an ImmutabilityPolicy of a blob container.
Field | Description |
---|---|
allowProtectedAppendWrites bool |
AllowProtectedAppendWrites: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. |
allowProtectedAppendWritesAll bool |
AllowProtectedAppendWritesAll: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive. |
etag string |
Etag: ImmutabilityPolicy Etag. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
state ImmutabilityPolicyProperty_State_STATUS |
State: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. |
updateHistory []UpdateHistoryProperty_STATUS |
UpdateHistory: The ImmutabilityPolicy update history of the blob container. |
ImmutabilityPolicyProperties_STATUS_ARM
(Appears on:ContainerProperties_STATUS_ARM)
The properties of an ImmutabilityPolicy of a blob container.
Field | Description |
---|---|
etag string |
Etag: ImmutabilityPolicy Etag. |
properties ImmutabilityPolicyProperty_STATUS_ARM |
Properties: The properties of an ImmutabilityPolicy of a blob container. |
updateHistory []UpdateHistoryProperty_STATUS_ARM |
UpdateHistory: The ImmutabilityPolicy update history of the blob container. |
ImmutabilityPolicyProperty_STATUS_ARM
(Appears on:ImmutabilityPolicyProperties_STATUS_ARM)
The properties of an ImmutabilityPolicy of a blob container.
Field | Description |
---|---|
allowProtectedAppendWrites bool |
AllowProtectedAppendWrites: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. |
allowProtectedAppendWritesAll bool |
AllowProtectedAppendWritesAll: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
state ImmutabilityPolicyProperty_State_STATUS_ARM |
State: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. |
ImmutabilityPolicyProperty_State_STATUS
(string
alias)
(Appears on:ImmutabilityPolicyProperties_STATUS)
Value | Description |
---|---|
"Locked" |
|
"Unlocked" |
ImmutabilityPolicyProperty_State_STATUS_ARM
(string
alias)
(Appears on:ImmutabilityPolicyProperty_STATUS_ARM)
Value | Description |
---|---|
"Locked" |
|
"Unlocked" |
ImmutableStorageAccount
(Appears on:StorageAccount_Spec)
This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning.
Field | Description |
---|---|
enabled bool |
Enabled: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. |
immutabilityPolicy AccountImmutabilityPolicyProperties |
ImmutabilityPolicy: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. |
ImmutableStorageAccount_ARM
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning.
Field | Description |
---|---|
enabled bool |
Enabled: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. |
immutabilityPolicy AccountImmutabilityPolicyProperties_ARM |
ImmutabilityPolicy: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. |
ImmutableStorageAccount_STATUS
(Appears on:StorageAccount_STATUS)
This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning.
Field | Description |
---|---|
enabled bool |
Enabled: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. |
immutabilityPolicy AccountImmutabilityPolicyProperties_STATUS |
ImmutabilityPolicy: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. |
ImmutableStorageAccount_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning.
Field | Description |
---|---|
enabled bool |
Enabled: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. |
immutabilityPolicy AccountImmutabilityPolicyProperties_STATUS_ARM |
ImmutabilityPolicy: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. |
ImmutableStorageWithVersioning
(Appears on:StorageAccounts_BlobServices_Container_Spec)
Object level immutability properties of the container.
Field | Description |
---|---|
enabled bool |
Enabled: This is an immutable property, when set to true it enables object level immutability at the container level. |
ImmutableStorageWithVersioning_ARM
(Appears on:ContainerProperties_ARM)
Object level immutability properties of the container.
Field | Description |
---|---|
enabled bool |
Enabled: This is an immutable property, when set to true it enables object level immutability at the container level. |
ImmutableStorageWithVersioning_MigrationState_STATUS
(string
alias)
(Appears on:ImmutableStorageWithVersioning_STATUS)
Value | Description |
---|---|
"Completed" |
|
"InProgress" |
ImmutableStorageWithVersioning_MigrationState_STATUS_ARM
(string
alias)
(Appears on:ImmutableStorageWithVersioning_STATUS_ARM)
Value | Description |
---|---|
"Completed" |
|
"InProgress" |
ImmutableStorageWithVersioning_STATUS
(Appears on:StorageAccounts_BlobServices_Container_STATUS)
Object level immutability properties of the container.
Field | Description |
---|---|
enabled bool |
Enabled: This is an immutable property, when set to true it enables object level immutability at the container level. |
migrationState ImmutableStorageWithVersioning_MigrationState_STATUS |
MigrationState: This property denotes the container level immutability to object level immutability migration state. |
timeStamp string |
TimeStamp: Returns the date and time the object level immutability was enabled. |
ImmutableStorageWithVersioning_STATUS_ARM
(Appears on:ContainerProperties_STATUS_ARM)
Object level immutability properties of the container.
Field | Description |
---|---|
enabled bool |
Enabled: This is an immutable property, when set to true it enables object level immutability at the container level. |
migrationState ImmutableStorageWithVersioning_MigrationState_STATUS_ARM |
MigrationState: This property denotes the container level immutability to object level immutability migration state. |
timeStamp string |
TimeStamp: Returns the date and time the object level immutability was enabled. |
KeyCreationTime_STATUS
(Appears on:StorageAccount_STATUS)
Storage account keys creation time.
Field | Description |
---|---|
key1 string |
|
key2 string |
KeyCreationTime_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
Storage account keys creation time.
Field | Description |
---|---|
key1 string |
|
key2 string |
KeyPolicy
(Appears on:StorageAccount_Spec)
KeyPolicy assigned to the storage account.
Field | Description |
---|---|
keyExpirationPeriodInDays int |
KeyExpirationPeriodInDays: The key expiration period in days. |
KeyPolicy_ARM
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
KeyPolicy assigned to the storage account.
Field | Description |
---|---|
keyExpirationPeriodInDays int |
KeyExpirationPeriodInDays: The key expiration period in days. |
KeyPolicy_STATUS
(Appears on:StorageAccount_STATUS)
KeyPolicy assigned to the storage account.
Field | Description |
---|---|
keyExpirationPeriodInDays int |
KeyExpirationPeriodInDays: The key expiration period in days. |
KeyPolicy_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
KeyPolicy assigned to the storage account.
Field | Description |
---|---|
keyExpirationPeriodInDays int |
KeyExpirationPeriodInDays: The key expiration period in days. |
KeyVaultProperties
(Appears on:Encryption)
Properties of key vault.
Field | Description |
---|---|
keyname string |
Keyname: The name of KeyVault key. |
keyvaulturi string |
Keyvaulturi: The Uri of KeyVault. |
keyversion string |
Keyversion: The version of KeyVault key. |
KeyVaultProperties_ARM
(Appears on:Encryption_ARM)
Properties of key vault.
Field | Description |
---|---|
keyname string |
Keyname: The name of KeyVault key. |
keyvaulturi string |
Keyvaulturi: The Uri of KeyVault. |
keyversion string |
Keyversion: The version of KeyVault key. |
KeyVaultProperties_STATUS
(Appears on:Encryption_STATUS)
Properties of key vault.
Field | Description |
---|---|
currentVersionedKeyExpirationTimestamp string |
CurrentVersionedKeyExpirationTimestamp: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. |
currentVersionedKeyIdentifier string |
CurrentVersionedKeyIdentifier: The object identifier of the current versioned Key Vault Key in use. |
keyname string |
Keyname: The name of KeyVault key. |
keyvaulturi string |
Keyvaulturi: The Uri of KeyVault. |
keyversion string |
Keyversion: The version of KeyVault key. |
lastKeyRotationTimestamp string |
LastKeyRotationTimestamp: Timestamp of last rotation of the Key Vault Key. |
KeyVaultProperties_STATUS_ARM
(Appears on:Encryption_STATUS_ARM)
Properties of key vault.
Field | Description |
---|---|
currentVersionedKeyExpirationTimestamp string |
CurrentVersionedKeyExpirationTimestamp: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. |
currentVersionedKeyIdentifier string |
CurrentVersionedKeyIdentifier: The object identifier of the current versioned Key Vault Key in use. |
keyname string |
Keyname: The name of KeyVault key. |
keyvaulturi string |
Keyvaulturi: The Uri of KeyVault. |
keyversion string |
Keyversion: The version of KeyVault key. |
lastKeyRotationTimestamp string |
LastKeyRotationTimestamp: Timestamp of last rotation of the Key Vault Key. |
LastAccessTimeTrackingPolicy
(Appears on:StorageAccounts_BlobService_Spec)
The blob service properties for Last access time based tracking policy.
Field | Description |
---|---|
blobType []string |
BlobType: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only |
enable bool |
Enable: When set to true last access time based tracking is enabled. |
name LastAccessTimeTrackingPolicy_Name |
Name: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only |
trackingGranularityInDays int |
TrackingGranularityInDays: The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1 |
LastAccessTimeTrackingPolicy_ARM
(Appears on:StorageAccounts_BlobService_Properties_Spec_ARM)
The blob service properties for Last access time based tracking policy.
Field | Description |
---|---|
blobType []string |
BlobType: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only |
enable bool |
Enable: When set to true last access time based tracking is enabled. |
name LastAccessTimeTrackingPolicy_Name_ARM |
Name: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only |
trackingGranularityInDays int |
TrackingGranularityInDays: The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1 |
LastAccessTimeTrackingPolicy_Name
(string
alias)
(Appears on:LastAccessTimeTrackingPolicy)
Value | Description |
---|---|
"AccessTimeTracking" |
LastAccessTimeTrackingPolicy_Name_ARM
(string
alias)
(Appears on:LastAccessTimeTrackingPolicy_ARM)
Value | Description |
---|---|
"AccessTimeTracking" |
LastAccessTimeTrackingPolicy_Name_STATUS
(string
alias)
(Appears on:LastAccessTimeTrackingPolicy_STATUS)
Value | Description |
---|---|
"AccessTimeTracking" |
LastAccessTimeTrackingPolicy_Name_STATUS_ARM
(string
alias)
(Appears on:LastAccessTimeTrackingPolicy_STATUS_ARM)
Value | Description |
---|---|
"AccessTimeTracking" |
LastAccessTimeTrackingPolicy_STATUS
(Appears on:StorageAccounts_BlobService_STATUS)
The blob service properties for Last access time based tracking policy.
Field | Description |
---|---|
blobType []string |
BlobType: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only |
enable bool |
Enable: When set to true last access time based tracking is enabled. |
name LastAccessTimeTrackingPolicy_Name_STATUS |
Name: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only |
trackingGranularityInDays int |
TrackingGranularityInDays: The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1 |
LastAccessTimeTrackingPolicy_STATUS_ARM
(Appears on:StorageAccounts_BlobService_Properties_STATUS_ARM)
The blob service properties for Last access time based tracking policy.
Field | Description |
---|---|
blobType []string |
BlobType: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only |
enable bool |
Enable: When set to true last access time based tracking is enabled. |
name LastAccessTimeTrackingPolicy_Name_STATUS_ARM |
Name: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only |
trackingGranularityInDays int |
TrackingGranularityInDays: The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1 |
LegalHoldProperties_STATUS
(Appears on:StorageAccounts_BlobServices_Container_STATUS)
The LegalHold property of a blob container.
Field | Description |
---|---|
hasLegalHold bool |
HasLegalHold: The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. |
protectedAppendWritesHistory ProtectedAppendWritesHistory_STATUS |
ProtectedAppendWritesHistory: Protected append blob writes history. |
tags []TagProperty_STATUS |
Tags: The list of LegalHold tags of a blob container. |
LegalHoldProperties_STATUS_ARM
(Appears on:ContainerProperties_STATUS_ARM)
The LegalHold property of a blob container.
Field | Description |
---|---|
hasLegalHold bool |
HasLegalHold: The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. |
protectedAppendWritesHistory ProtectedAppendWritesHistory_STATUS_ARM |
ProtectedAppendWritesHistory: Protected append blob writes history. |
tags []TagProperty_STATUS_ARM |
Tags: The list of LegalHold tags of a blob container. |
ManagementPolicyAction
(Appears on:ManagementPolicyDefinition)
Actions are applied to the filtered blobs when the execution condition is met.
Field | Description |
---|---|
baseBlob ManagementPolicyBaseBlob |
BaseBlob: The management policy action for base blob |
snapshot ManagementPolicySnapShot |
Snapshot: The management policy action for snapshot |
version ManagementPolicyVersion |
Version: The management policy action for version |
ManagementPolicyAction_ARM
(Appears on:ManagementPolicyDefinition_ARM)
Actions are applied to the filtered blobs when the execution condition is met.
Field | Description |
---|---|
baseBlob ManagementPolicyBaseBlob_ARM |
BaseBlob: The management policy action for base blob |
snapshot ManagementPolicySnapShot_ARM |
Snapshot: The management policy action for snapshot |
version ManagementPolicyVersion_ARM |
Version: The management policy action for version |
ManagementPolicyAction_STATUS
(Appears on:ManagementPolicyDefinition_STATUS)
Actions are applied to the filtered blobs when the execution condition is met.
Field | Description |
---|---|
baseBlob ManagementPolicyBaseBlob_STATUS |
BaseBlob: The management policy action for base blob |
snapshot ManagementPolicySnapShot_STATUS |
Snapshot: The management policy action for snapshot |
version ManagementPolicyVersion_STATUS |
Version: The management policy action for version |
ManagementPolicyAction_STATUS_ARM
(Appears on:ManagementPolicyDefinition_STATUS_ARM)
Actions are applied to the filtered blobs when the execution condition is met.
Field | Description |
---|---|
baseBlob ManagementPolicyBaseBlob_STATUS_ARM |
BaseBlob: The management policy action for base blob |
snapshot ManagementPolicySnapShot_STATUS_ARM |
Snapshot: The management policy action for snapshot |
version ManagementPolicyVersion_STATUS_ARM |
Version: The management policy action for version |
ManagementPolicyBaseBlob
(Appears on:ManagementPolicyAction)
Management policy action for base blob.
Field | Description |
---|---|
delete DateAfterModification |
Delete: The function to delete the blob |
enableAutoTierToHotFromCool bool |
EnableAutoTierToHotFromCool: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. |
tierToArchive DateAfterModification |
TierToArchive: The function to tier blobs to archive storage. |
tierToCold DateAfterModification |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterModification |
TierToCool: The function to tier blobs to cool storage. |
tierToHot DateAfterModification |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicyBaseBlob_ARM
(Appears on:ManagementPolicyAction_ARM)
Management policy action for base blob.
Field | Description |
---|---|
delete DateAfterModification_ARM |
Delete: The function to delete the blob |
enableAutoTierToHotFromCool bool |
EnableAutoTierToHotFromCool: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. |
tierToArchive DateAfterModification_ARM |
TierToArchive: The function to tier blobs to archive storage. |
tierToCold DateAfterModification_ARM |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterModification_ARM |
TierToCool: The function to tier blobs to cool storage. |
tierToHot DateAfterModification_ARM |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicyBaseBlob_STATUS
(Appears on:ManagementPolicyAction_STATUS)
Management policy action for base blob.
Field | Description |
---|---|
delete DateAfterModification_STATUS |
Delete: The function to delete the blob |
enableAutoTierToHotFromCool bool |
EnableAutoTierToHotFromCool: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. |
tierToArchive DateAfterModification_STATUS |
TierToArchive: The function to tier blobs to archive storage. |
tierToCold DateAfterModification_STATUS |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterModification_STATUS |
TierToCool: The function to tier blobs to cool storage. |
tierToHot DateAfterModification_STATUS |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicyBaseBlob_STATUS_ARM
(Appears on:ManagementPolicyAction_STATUS_ARM)
Management policy action for base blob.
Field | Description |
---|---|
delete DateAfterModification_STATUS_ARM |
Delete: The function to delete the blob |
enableAutoTierToHotFromCool bool |
EnableAutoTierToHotFromCool: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. |
tierToArchive DateAfterModification_STATUS_ARM |
TierToArchive: The function to tier blobs to archive storage. |
tierToCold DateAfterModification_STATUS_ARM |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterModification_STATUS_ARM |
TierToCool: The function to tier blobs to cool storage. |
tierToHot DateAfterModification_STATUS_ARM |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicyDefinition
(Appears on:ManagementPolicyRule)
An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.
Field | Description |
---|---|
actions ManagementPolicyAction |
Actions: An object that defines the action set. |
filters ManagementPolicyFilter |
Filters: An object that defines the filter set. |
ManagementPolicyDefinition_ARM
(Appears on:ManagementPolicyRule_ARM)
An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.
Field | Description |
---|---|
actions ManagementPolicyAction_ARM |
Actions: An object that defines the action set. |
filters ManagementPolicyFilter_ARM |
Filters: An object that defines the filter set. |
ManagementPolicyDefinition_STATUS
(Appears on:ManagementPolicyRule_STATUS)
An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.
Field | Description |
---|---|
actions ManagementPolicyAction_STATUS |
Actions: An object that defines the action set. |
filters ManagementPolicyFilter_STATUS |
Filters: An object that defines the filter set. |
ManagementPolicyDefinition_STATUS_ARM
(Appears on:ManagementPolicyRule_STATUS_ARM)
An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set.
Field | Description |
---|---|
actions ManagementPolicyAction_STATUS_ARM |
Actions: An object that defines the action set. |
filters ManagementPolicyFilter_STATUS_ARM |
Filters: An object that defines the filter set. |
ManagementPolicyFilter
(Appears on:ManagementPolicyDefinition)
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.
Field | Description |
---|---|
blobIndexMatch []TagFilter |
BlobIndexMatch: An array of blob index tag based filters, there can be at most 10 tag filters |
blobTypes []string |
BlobTypes: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. |
prefixMatch []string |
PrefixMatch: An array of strings for prefixes to be match. |
ManagementPolicyFilter_ARM
(Appears on:ManagementPolicyDefinition_ARM)
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.
Field | Description |
---|---|
blobIndexMatch []TagFilter_ARM |
BlobIndexMatch: An array of blob index tag based filters, there can be at most 10 tag filters |
blobTypes []string |
BlobTypes: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. |
prefixMatch []string |
PrefixMatch: An array of strings for prefixes to be match. |
ManagementPolicyFilter_STATUS
(Appears on:ManagementPolicyDefinition_STATUS)
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.
Field | Description |
---|---|
blobIndexMatch []TagFilter_STATUS |
BlobIndexMatch: An array of blob index tag based filters, there can be at most 10 tag filters |
blobTypes []string |
BlobTypes: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. |
prefixMatch []string |
PrefixMatch: An array of strings for prefixes to be match. |
ManagementPolicyFilter_STATUS_ARM
(Appears on:ManagementPolicyDefinition_STATUS_ARM)
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.
Field | Description |
---|---|
blobIndexMatch []TagFilter_STATUS_ARM |
BlobIndexMatch: An array of blob index tag based filters, there can be at most 10 tag filters |
blobTypes []string |
BlobTypes: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. |
prefixMatch []string |
PrefixMatch: An array of strings for prefixes to be match. |
ManagementPolicyProperties_ARM
(Appears on:StorageAccounts_ManagementPolicy_Spec_ARM)
The Storage Account ManagementPolicy properties.
Field | Description |
---|---|
policy ManagementPolicySchema_ARM |
Policy: The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
ManagementPolicyProperties_STATUS_ARM
(Appears on:StorageAccounts_ManagementPolicy_STATUS_ARM)
The Storage Account ManagementPolicy properties.
Field | Description |
---|---|
lastModifiedTime string |
LastModifiedTime: Returns the date and time the ManagementPolicies was last modified. |
policy ManagementPolicySchema_STATUS_ARM |
Policy: The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
ManagementPolicyRule
(Appears on:ManagementPolicySchema)
An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.
Field | Description |
---|---|
definition ManagementPolicyDefinition |
Definition: An object that defines the Lifecycle rule. |
enabled bool |
Enabled: Rule is enabled if set to true. |
name string |
Name: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. |
type ManagementPolicyRule_Type |
Type: The valid value is Lifecycle |
ManagementPolicyRule_ARM
(Appears on:ManagementPolicySchema_ARM)
An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.
Field | Description |
---|---|
definition ManagementPolicyDefinition_ARM |
Definition: An object that defines the Lifecycle rule. |
enabled bool |
Enabled: Rule is enabled if set to true. |
name string |
Name: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. |
type ManagementPolicyRule_Type_ARM |
Type: The valid value is Lifecycle |
ManagementPolicyRule_STATUS
(Appears on:ManagementPolicySchema_STATUS)
An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.
Field | Description |
---|---|
definition ManagementPolicyDefinition_STATUS |
Definition: An object that defines the Lifecycle rule. |
enabled bool |
Enabled: Rule is enabled if set to true. |
name string |
Name: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. |
type ManagementPolicyRule_Type_STATUS |
Type: The valid value is Lifecycle |
ManagementPolicyRule_STATUS_ARM
(Appears on:ManagementPolicySchema_STATUS_ARM)
An object that wraps the Lifecycle rule. Each rule is uniquely defined by name.
Field | Description |
---|---|
definition ManagementPolicyDefinition_STATUS_ARM |
Definition: An object that defines the Lifecycle rule. |
enabled bool |
Enabled: Rule is enabled if set to true. |
name string |
Name: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. |
type ManagementPolicyRule_Type_STATUS_ARM |
Type: The valid value is Lifecycle |
ManagementPolicyRule_Type
(string
alias)
(Appears on:ManagementPolicyRule)
Value | Description |
---|---|
"Lifecycle" |
ManagementPolicyRule_Type_ARM
(string
alias)
(Appears on:ManagementPolicyRule_ARM)
Value | Description |
---|---|
"Lifecycle" |
ManagementPolicyRule_Type_STATUS
(string
alias)
(Appears on:ManagementPolicyRule_STATUS)
Value | Description |
---|---|
"Lifecycle" |
ManagementPolicyRule_Type_STATUS_ARM
(string
alias)
(Appears on:ManagementPolicyRule_STATUS_ARM)
Value | Description |
---|---|
"Lifecycle" |
ManagementPolicySchema
(Appears on:StorageAccounts_ManagementPolicy_Spec)
The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.
Field | Description |
---|---|
rules []ManagementPolicyRule |
Rules: The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
ManagementPolicySchema_ARM
(Appears on:ManagementPolicyProperties_ARM)
The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.
Field | Description |
---|---|
rules []ManagementPolicyRule_ARM |
Rules: The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
ManagementPolicySchema_STATUS
(Appears on:StorageAccounts_ManagementPolicy_STATUS)
The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.
Field | Description |
---|---|
rules []ManagementPolicyRule_STATUS |
Rules: The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
ManagementPolicySchema_STATUS_ARM
(Appears on:ManagementPolicyProperties_STATUS_ARM)
The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts.
Field | Description |
---|---|
rules []ManagementPolicyRule_STATUS_ARM |
Rules: The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
ManagementPolicySnapShot
(Appears on:ManagementPolicyAction)
Management policy action for snapshot.
Field | Description |
---|---|
delete DateAfterCreation |
Delete: The function to delete the blob snapshot |
tierToArchive DateAfterCreation |
TierToArchive: The function to tier blob snapshot to archive storage. |
tierToCold DateAfterCreation |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterCreation |
TierToCool: The function to tier blob snapshot to cool storage. |
tierToHot DateAfterCreation |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicySnapShot_ARM
(Appears on:ManagementPolicyAction_ARM)
Management policy action for snapshot.
Field | Description |
---|---|
delete DateAfterCreation_ARM |
Delete: The function to delete the blob snapshot |
tierToArchive DateAfterCreation_ARM |
TierToArchive: The function to tier blob snapshot to archive storage. |
tierToCold DateAfterCreation_ARM |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterCreation_ARM |
TierToCool: The function to tier blob snapshot to cool storage. |
tierToHot DateAfterCreation_ARM |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicySnapShot_STATUS
(Appears on:ManagementPolicyAction_STATUS)
Management policy action for snapshot.
Field | Description |
---|---|
delete DateAfterCreation_STATUS |
Delete: The function to delete the blob snapshot |
tierToArchive DateAfterCreation_STATUS |
TierToArchive: The function to tier blob snapshot to archive storage. |
tierToCold DateAfterCreation_STATUS |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterCreation_STATUS |
TierToCool: The function to tier blob snapshot to cool storage. |
tierToHot DateAfterCreation_STATUS |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicySnapShot_STATUS_ARM
(Appears on:ManagementPolicyAction_STATUS_ARM)
Management policy action for snapshot.
Field | Description |
---|---|
delete DateAfterCreation_STATUS_ARM |
Delete: The function to delete the blob snapshot |
tierToArchive DateAfterCreation_STATUS_ARM |
TierToArchive: The function to tier blob snapshot to archive storage. |
tierToCold DateAfterCreation_STATUS_ARM |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterCreation_STATUS_ARM |
TierToCool: The function to tier blob snapshot to cool storage. |
tierToHot DateAfterCreation_STATUS_ARM |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicyVersion
(Appears on:ManagementPolicyAction)
Management policy action for blob version.
Field | Description |
---|---|
delete DateAfterCreation |
Delete: The function to delete the blob version |
tierToArchive DateAfterCreation |
TierToArchive: The function to tier blob version to archive storage. |
tierToCold DateAfterCreation |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterCreation |
TierToCool: The function to tier blob version to cool storage. |
tierToHot DateAfterCreation |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicyVersion_ARM
(Appears on:ManagementPolicyAction_ARM)
Management policy action for blob version.
Field | Description |
---|---|
delete DateAfterCreation_ARM |
Delete: The function to delete the blob version |
tierToArchive DateAfterCreation_ARM |
TierToArchive: The function to tier blob version to archive storage. |
tierToCold DateAfterCreation_ARM |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterCreation_ARM |
TierToCool: The function to tier blob version to cool storage. |
tierToHot DateAfterCreation_ARM |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicyVersion_STATUS
(Appears on:ManagementPolicyAction_STATUS)
Management policy action for blob version.
Field | Description |
---|---|
delete DateAfterCreation_STATUS |
Delete: The function to delete the blob version |
tierToArchive DateAfterCreation_STATUS |
TierToArchive: The function to tier blob version to archive storage. |
tierToCold DateAfterCreation_STATUS |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterCreation_STATUS |
TierToCool: The function to tier blob version to cool storage. |
tierToHot DateAfterCreation_STATUS |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
ManagementPolicyVersion_STATUS_ARM
(Appears on:ManagementPolicyAction_STATUS_ARM)
Management policy action for blob version.
Field | Description |
---|---|
delete DateAfterCreation_STATUS_ARM |
Delete: The function to delete the blob version |
tierToArchive DateAfterCreation_STATUS_ARM |
TierToArchive: The function to tier blob version to archive storage. |
tierToCold DateAfterCreation_STATUS_ARM |
TierToCold: The function to tier blobs to cold storage. |
tierToCool DateAfterCreation_STATUS_ARM |
TierToCool: The function to tier blob version to cool storage. |
tierToHot DateAfterCreation_STATUS_ARM |
TierToHot: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts |
Multichannel
(Appears on:SmbSetting)
Multichannel setting. Applies to Premium FileStorage only.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates whether multichannel is enabled |
Multichannel_ARM
(Appears on:SmbSetting_ARM)
Multichannel setting. Applies to Premium FileStorage only.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates whether multichannel is enabled |
Multichannel_STATUS
(Appears on:SmbSetting_STATUS)
Multichannel setting. Applies to Premium FileStorage only.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates whether multichannel is enabled |
Multichannel_STATUS_ARM
(Appears on:SmbSetting_STATUS_ARM)
Multichannel setting. Applies to Premium FileStorage only.
Field | Description |
---|---|
enabled bool |
Enabled: Indicates whether multichannel is enabled |
NetworkRuleSet
(Appears on:StorageAccount_Spec)
Network rule set
Field | Description |
---|---|
bypass NetworkRuleSet_Bypass |
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. |
defaultAction NetworkRuleSet_DefaultAction |
DefaultAction: Specifies the default action of allow or deny when no other rules match. |
ipRules []IPRule |
IpRules: Sets the IP ACL rules |
resourceAccessRules []ResourceAccessRule |
ResourceAccessRules: Sets the resource access rules |
virtualNetworkRules []VirtualNetworkRule |
VirtualNetworkRules: Sets the virtual network rules |
NetworkRuleSet_ARM
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
Network rule set
Field | Description |
---|---|
bypass NetworkRuleSet_Bypass_ARM |
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. |
defaultAction NetworkRuleSet_DefaultAction_ARM |
DefaultAction: Specifies the default action of allow or deny when no other rules match. |
ipRules []IPRule_ARM |
IpRules: Sets the IP ACL rules |
resourceAccessRules []ResourceAccessRule_ARM |
ResourceAccessRules: Sets the resource access rules |
virtualNetworkRules []VirtualNetworkRule_ARM |
VirtualNetworkRules: Sets the virtual network rules |
NetworkRuleSet_Bypass
(string
alias)
(Appears on:NetworkRuleSet)
Value | Description |
---|---|
"AzureServices" |
|
"Logging" |
|
"Metrics" |
|
"None" |
NetworkRuleSet_Bypass_ARM
(string
alias)
(Appears on:NetworkRuleSet_ARM)
Value | Description |
---|---|
"AzureServices" |
|
"Logging" |
|
"Metrics" |
|
"None" |
NetworkRuleSet_Bypass_STATUS
(string
alias)
(Appears on:NetworkRuleSet_STATUS)
Value | Description |
---|---|
"AzureServices" |
|
"Logging" |
|
"Metrics" |
|
"None" |
NetworkRuleSet_Bypass_STATUS_ARM
(string
alias)
(Appears on:NetworkRuleSet_STATUS_ARM)
Value | Description |
---|---|
"AzureServices" |
|
"Logging" |
|
"Metrics" |
|
"None" |
NetworkRuleSet_DefaultAction
(string
alias)
(Appears on:NetworkRuleSet)
Value | Description |
---|---|
"Allow" |
|
"Deny" |
NetworkRuleSet_DefaultAction_ARM
(string
alias)
(Appears on:NetworkRuleSet_ARM)
Value | Description |
---|---|
"Allow" |
|
"Deny" |
NetworkRuleSet_DefaultAction_STATUS
(string
alias)
(Appears on:NetworkRuleSet_STATUS)
Value | Description |
---|---|
"Allow" |
|
"Deny" |
NetworkRuleSet_DefaultAction_STATUS_ARM
(string
alias)
(Appears on:NetworkRuleSet_STATUS_ARM)
Value | Description |
---|---|
"Allow" |
|
"Deny" |
NetworkRuleSet_STATUS
(Appears on:StorageAccount_STATUS)
Network rule set
Field | Description |
---|---|
bypass NetworkRuleSet_Bypass_STATUS |
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. |
defaultAction NetworkRuleSet_DefaultAction_STATUS |
DefaultAction: Specifies the default action of allow or deny when no other rules match. |
ipRules []IPRule_STATUS |
IpRules: Sets the IP ACL rules |
resourceAccessRules []ResourceAccessRule_STATUS |
ResourceAccessRules: Sets the resource access rules |
virtualNetworkRules []VirtualNetworkRule_STATUS |
VirtualNetworkRules: Sets the virtual network rules |
NetworkRuleSet_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
Network rule set
Field | Description |
---|---|
bypass NetworkRuleSet_Bypass_STATUS_ARM |
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. |
defaultAction NetworkRuleSet_DefaultAction_STATUS_ARM |
DefaultAction: Specifies the default action of allow or deny when no other rules match. |
ipRules []IPRule_STATUS_ARM |
IpRules: Sets the IP ACL rules |
resourceAccessRules []ResourceAccessRule_STATUS_ARM |
ResourceAccessRules: Sets the resource access rules |
virtualNetworkRules []VirtualNetworkRule_STATUS_ARM |
VirtualNetworkRules: Sets the virtual network rules |
PrivateEndpointConnection_STATUS
(Appears on:StorageAccount_STATUS)
The Private Endpoint Connection resource.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
PrivateEndpointConnection_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
The Private Endpoint Connection resource.
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
ProtectedAppendWritesHistory_STATUS
(Appears on:LegalHoldProperties_STATUS)
Protected append writes history setting for the blob container with Legal holds.
Field | Description |
---|---|
allowProtectedAppendWritesAll bool |
AllowProtectedAppendWritesAll: When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. |
timestamp string |
Timestamp: Returns the date and time the tag was added. |
ProtectedAppendWritesHistory_STATUS_ARM
(Appears on:LegalHoldProperties_STATUS_ARM)
Protected append writes history setting for the blob container with Legal holds.
Field | Description |
---|---|
allowProtectedAppendWritesAll bool |
AllowProtectedAppendWritesAll: When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. |
timestamp string |
Timestamp: Returns the date and time the tag was added. |
ProtocolSettings
(Appears on:StorageAccounts_FileService_Spec)
Protocol settings for file service
Field | Description |
---|---|
smb SmbSetting |
Smb: Setting for SMB protocol |
ProtocolSettings_ARM
(Appears on:StorageAccounts_FileService_Properties_Spec_ARM)
Protocol settings for file service
Field | Description |
---|---|
smb SmbSetting_ARM |
Smb: Setting for SMB protocol |
ProtocolSettings_STATUS
(Appears on:StorageAccounts_FileService_STATUS)
Protocol settings for file service
Field | Description |
---|---|
smb SmbSetting_STATUS |
Smb: Setting for SMB protocol |
ProtocolSettings_STATUS_ARM
(Appears on:StorageAccounts_FileService_Properties_STATUS_ARM)
Protocol settings for file service
Field | Description |
---|---|
smb SmbSetting_STATUS_ARM |
Smb: Setting for SMB protocol |
QueueProperties_ARM
(Appears on:StorageAccounts_QueueServices_Queue_Spec_ARM)
Field | Description |
---|---|
metadata map[string]string |
Metadata: A name-value pair that represents queue metadata. |
QueueProperties_STATUS_ARM
(Appears on:StorageAccounts_QueueServices_Queue_STATUS_ARM)
Field | Description |
---|---|
approximateMessageCount int |
ApproximateMessageCount: Integer indicating an approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher. |
metadata map[string]string |
Metadata: A name-value pair that represents queue metadata. |
ResourceAccessRule
(Appears on:NetworkRuleSet)
Resource Access Rule.
Field | Description |
---|---|
resourceReference genruntime.ResourceReference |
ResourceReference: Resource Id |
tenantId string |
TenantId: Tenant Id |
ResourceAccessRule_ARM
(Appears on:NetworkRuleSet_ARM)
Resource Access Rule.
Field | Description |
---|---|
resourceId string |
|
tenantId string |
TenantId: Tenant Id |
ResourceAccessRule_STATUS
(Appears on:NetworkRuleSet_STATUS)
Resource Access Rule.
Field | Description |
---|---|
resourceId string |
ResourceId: Resource Id |
tenantId string |
TenantId: Tenant Id |
ResourceAccessRule_STATUS_ARM
(Appears on:NetworkRuleSet_STATUS_ARM)
Resource Access Rule.
Field | Description |
---|---|
resourceId string |
ResourceId: Resource Id |
tenantId string |
TenantId: Tenant Id |
RestorePolicyProperties
(Appears on:StorageAccounts_BlobService_Spec)
The blob service properties for blob restore policy
Field | Description |
---|---|
days int |
Days: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. |
enabled bool |
Enabled: Blob restore is enabled if set to true. |
RestorePolicyProperties_ARM
(Appears on:StorageAccounts_BlobService_Properties_Spec_ARM)
The blob service properties for blob restore policy
Field | Description |
---|---|
days int |
Days: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. |
enabled bool |
Enabled: Blob restore is enabled if set to true. |
RestorePolicyProperties_STATUS
(Appears on:StorageAccounts_BlobService_STATUS)
The blob service properties for blob restore policy
Field | Description |
---|---|
days int |
Days: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. |
enabled bool |
Enabled: Blob restore is enabled if set to true. |
lastEnabledTime string |
LastEnabledTime: Deprecated in favor of minRestoreTime property. |
minRestoreTime string |
MinRestoreTime: Returns the minimum date and time that the restore can be started. |
RestorePolicyProperties_STATUS_ARM
(Appears on:StorageAccounts_BlobService_Properties_STATUS_ARM)
The blob service properties for blob restore policy
Field | Description |
---|---|
days int |
Days: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. |
enabled bool |
Enabled: Blob restore is enabled if set to true. |
lastEnabledTime string |
LastEnabledTime: Deprecated in favor of minRestoreTime property. |
minRestoreTime string |
MinRestoreTime: Returns the minimum date and time that the restore can be started. |
RoutingPreference
(Appears on:StorageAccount_Spec)
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
Field | Description |
---|---|
publishInternetEndpoints bool |
PublishInternetEndpoints: A boolean flag which indicates whether internet routing storage endpoints are to be published |
publishMicrosoftEndpoints bool |
PublishMicrosoftEndpoints: A boolean flag which indicates whether microsoft routing storage endpoints are to be published |
routingChoice RoutingPreference_RoutingChoice |
RoutingChoice: Routing Choice defines the kind of network routing opted by the user. |
RoutingPreference_ARM
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
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
Field | Description |
---|---|
publishInternetEndpoints bool |
PublishInternetEndpoints: A boolean flag which indicates whether internet routing storage endpoints are to be published |
publishMicrosoftEndpoints bool |
PublishMicrosoftEndpoints: A boolean flag which indicates whether microsoft routing storage endpoints are to be published |
routingChoice RoutingPreference_RoutingChoice_ARM |
RoutingChoice: Routing Choice defines the kind of network routing opted by the user. |
RoutingPreference_RoutingChoice
(string
alias)
(Appears on:RoutingPreference)
Value | Description |
---|---|
"InternetRouting" |
|
"MicrosoftRouting" |
RoutingPreference_RoutingChoice_ARM
(string
alias)
(Appears on:RoutingPreference_ARM)
Value | Description |
---|---|
"InternetRouting" |
|
"MicrosoftRouting" |
RoutingPreference_RoutingChoice_STATUS
(string
alias)
(Appears on:RoutingPreference_STATUS)
Value | Description |
---|---|
"InternetRouting" |
|
"MicrosoftRouting" |
RoutingPreference_RoutingChoice_STATUS_ARM
(string
alias)
(Appears on:RoutingPreference_STATUS_ARM)
Value | Description |
---|---|
"InternetRouting" |
|
"MicrosoftRouting" |
RoutingPreference_STATUS
(Appears on:StorageAccount_STATUS)
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
Field | Description |
---|---|
publishInternetEndpoints bool |
PublishInternetEndpoints: A boolean flag which indicates whether internet routing storage endpoints are to be published |
publishMicrosoftEndpoints bool |
PublishMicrosoftEndpoints: A boolean flag which indicates whether microsoft routing storage endpoints are to be published |
routingChoice RoutingPreference_RoutingChoice_STATUS |
RoutingChoice: Routing Choice defines the kind of network routing opted by the user. |
RoutingPreference_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
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
Field | Description |
---|---|
publishInternetEndpoints bool |
PublishInternetEndpoints: A boolean flag which indicates whether internet routing storage endpoints are to be published |
publishMicrosoftEndpoints bool |
PublishMicrosoftEndpoints: A boolean flag which indicates whether microsoft routing storage endpoints are to be published |
routingChoice RoutingPreference_RoutingChoice_STATUS_ARM |
RoutingChoice: Routing Choice defines the kind of network routing opted by the user. |
SasPolicy
(Appears on:StorageAccount_Spec)
SasPolicy assigned to the storage account.
Field | Description |
---|---|
expirationAction SasPolicy_ExpirationAction |
ExpirationAction: The SAS expiration action. Can only be Log. |
sasExpirationPeriod string |
SasExpirationPeriod: The SAS expiration period, DD.HH:MM:SS. |
SasPolicy_ARM
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
SasPolicy assigned to the storage account.
Field | Description |
---|---|
expirationAction SasPolicy_ExpirationAction_ARM |
ExpirationAction: The SAS expiration action. Can only be Log. |
sasExpirationPeriod string |
SasExpirationPeriod: The SAS expiration period, DD.HH:MM:SS. |
SasPolicy_ExpirationAction
(string
alias)
(Appears on:SasPolicy)
Value | Description |
---|---|
"Log" |
SasPolicy_ExpirationAction_ARM
(string
alias)
(Appears on:SasPolicy_ARM)
Value | Description |
---|---|
"Log" |
SasPolicy_ExpirationAction_STATUS
(string
alias)
(Appears on:SasPolicy_STATUS)
Value | Description |
---|---|
"Log" |
SasPolicy_ExpirationAction_STATUS_ARM
(string
alias)
(Appears on:SasPolicy_STATUS_ARM)
Value | Description |
---|---|
"Log" |
SasPolicy_STATUS
(Appears on:StorageAccount_STATUS)
SasPolicy assigned to the storage account.
Field | Description |
---|---|
expirationAction SasPolicy_ExpirationAction_STATUS |
ExpirationAction: The SAS expiration action. Can only be Log. |
sasExpirationPeriod string |
SasExpirationPeriod: The SAS expiration period, DD.HH:MM:SS. |
SasPolicy_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
SasPolicy assigned to the storage account.
Field | Description |
---|---|
expirationAction SasPolicy_ExpirationAction_STATUS_ARM |
ExpirationAction: The SAS expiration action. Can only be Log. |
sasExpirationPeriod string |
SasExpirationPeriod: The SAS expiration period, DD.HH:MM:SS. |
SignedIdentifier
(Appears on:StorageAccounts_FileServices_Share_Spec)
Field | Description |
---|---|
accessPolicy AccessPolicy |
AccessPolicy: Access policy |
reference genruntime.ResourceReference |
Reference: An unique identifier of the stored access policy. |
SignedIdentifier_ARM
(Appears on:FileShareProperties_ARM)
Field | Description |
---|---|
accessPolicy AccessPolicy_ARM |
AccessPolicy: Access policy |
id string |
SignedIdentifier_STATUS
(Appears on:StorageAccounts_FileServices_Share_STATUS)
Field | Description |
---|---|
accessPolicy AccessPolicy_STATUS |
AccessPolicy: Access policy |
id string |
Id: An unique identifier of the stored access policy. |
SignedIdentifier_STATUS_ARM
(Appears on:FileShareProperties_STATUS_ARM)
Field | Description |
---|---|
accessPolicy AccessPolicy_STATUS_ARM |
AccessPolicy: Access policy |
id string |
Id: An unique identifier of the stored access policy. |
Sku
(Appears on:StorageAccount_Spec)
The SKU of the storage account.
Field | Description |
---|---|
name SkuName |
Name: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. |
tier Tier |
Tier: The SKU tier. This is based on the SKU name. |
SkuName
(string
alias)
(Appears on:Sku)
The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
Value | Description |
---|---|
"Premium_LRS" |
|
"Premium_ZRS" |
|
"Standard_GRS" |
|
"Standard_GZRS" |
|
"Standard_LRS" |
|
"Standard_RAGRS" |
|
"Standard_RAGZRS" |
|
"Standard_ZRS" |
SkuName_ARM
(string
alias)
(Appears on:Sku_ARM)
The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
Value | Description |
---|---|
"Premium_LRS" |
|
"Premium_ZRS" |
|
"Standard_GRS" |
|
"Standard_GZRS" |
|
"Standard_LRS" |
|
"Standard_RAGRS" |
|
"Standard_RAGZRS" |
|
"Standard_ZRS" |
SkuName_STATUS
(string
alias)
(Appears on:Sku_STATUS, StorageAccountSkuConversionStatus_STATUS)
The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
Value | Description |
---|---|
"Premium_LRS" |
|
"Premium_ZRS" |
|
"Standard_GRS" |
|
"Standard_GZRS" |
|
"Standard_LRS" |
|
"Standard_RAGRS" |
|
"Standard_RAGZRS" |
|
"Standard_ZRS" |
SkuName_STATUS_ARM
(string
alias)
(Appears on:Sku_STATUS_ARM, StorageAccountSkuConversionStatus_STATUS_ARM)
The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.
Value | Description |
---|---|
"Premium_LRS" |
|
"Premium_ZRS" |
|
"Standard_GRS" |
|
"Standard_GZRS" |
|
"Standard_LRS" |
|
"Standard_RAGRS" |
|
"Standard_RAGZRS" |
|
"Standard_ZRS" |
Sku_ARM
(Appears on:StorageAccount_Spec_ARM)
The SKU of the storage account.
Field | Description |
---|---|
name SkuName_ARM |
Name: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. |
tier Tier_ARM |
Tier: The SKU tier. This is based on the SKU name. |
Sku_STATUS
(Appears on:StorageAccount_STATUS, StorageAccounts_BlobService_STATUS, StorageAccounts_FileService_STATUS)
The SKU of the storage account.
Field | Description |
---|---|
name SkuName_STATUS |
Name: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. |
tier Tier_STATUS |
Tier: The SKU tier. This is based on the SKU name. |
Sku_STATUS_ARM
(Appears on:StorageAccount_STATUS_ARM, StorageAccounts_BlobService_STATUS_ARM, StorageAccounts_FileService_STATUS_ARM)
The SKU of the storage account.
Field | Description |
---|---|
name SkuName_STATUS_ARM |
Name: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. |
tier Tier_STATUS_ARM |
Tier: The SKU tier. This is based on the SKU name. |
SmbSetting
(Appears on:ProtocolSettings)
Setting for SMB protocol
Field | Description |
---|---|
authenticationMethods string |
AuthenticationMethods: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ‘;’. |
channelEncryption string |
ChannelEncryption: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ‘;’. |
kerberosTicketEncryption string |
KerberosTicketEncryption: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ‘;’ |
multichannel Multichannel |
Multichannel: Multichannel setting. Applies to Premium FileStorage only. |
versions string |
Versions: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ‘;’. |
SmbSetting_ARM
(Appears on:ProtocolSettings_ARM)
Setting for SMB protocol
Field | Description |
---|---|
authenticationMethods string |
AuthenticationMethods: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ‘;’. |
channelEncryption string |
ChannelEncryption: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ‘;’. |
kerberosTicketEncryption string |
KerberosTicketEncryption: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ‘;’ |
multichannel Multichannel_ARM |
Multichannel: Multichannel setting. Applies to Premium FileStorage only. |
versions string |
Versions: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ‘;’. |
SmbSetting_STATUS
(Appears on:ProtocolSettings_STATUS)
Setting for SMB protocol
Field | Description |
---|---|
authenticationMethods string |
AuthenticationMethods: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ‘;’. |
channelEncryption string |
ChannelEncryption: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ‘;’. |
kerberosTicketEncryption string |
KerberosTicketEncryption: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ‘;’ |
multichannel Multichannel_STATUS |
Multichannel: Multichannel setting. Applies to Premium FileStorage only. |
versions string |
Versions: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ‘;’. |
SmbSetting_STATUS_ARM
(Appears on:ProtocolSettings_STATUS_ARM)
Setting for SMB protocol
Field | Description |
---|---|
authenticationMethods string |
AuthenticationMethods: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ‘;’. |
channelEncryption string |
ChannelEncryption: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ‘;’. |
kerberosTicketEncryption string |
KerberosTicketEncryption: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ‘;’ |
multichannel Multichannel_STATUS_ARM |
Multichannel: Multichannel setting. Applies to Premium FileStorage only. |
versions string |
Versions: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ‘;’. |
StorageAccount
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/storage.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spec StorageAccount_Spec |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status StorageAccount_STATUS |
StorageAccountInternetEndpoints_STATUS
(Appears on:Endpoints_STATUS)
The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint.
Field | Description |
---|---|
blob string |
Blob: Gets the blob endpoint. |
dfs string |
Dfs: Gets the dfs endpoint. |
file string |
File: Gets the file endpoint. |
web string |
Web: Gets the web endpoint. |
StorageAccountInternetEndpoints_STATUS_ARM
(Appears on:Endpoints_STATUS_ARM)
The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint.
Field | Description |
---|---|
blob string |
Blob: Gets the blob endpoint. |
dfs string |
Dfs: Gets the dfs endpoint. |
file string |
File: Gets the file endpoint. |
web string |
Web: Gets the web endpoint. |
StorageAccountMicrosoftEndpoints_STATUS
(Appears on:Endpoints_STATUS)
The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint.
Field | Description |
---|---|
blob string |
Blob: Gets the blob endpoint. |
dfs string |
Dfs: Gets the dfs endpoint. |
file string |
File: Gets the file endpoint. |
queue string |
Queue: Gets the queue endpoint. |
table string |
Table: Gets the table endpoint. |
web string |
Web: Gets the web endpoint. |
StorageAccountMicrosoftEndpoints_STATUS_ARM
(Appears on:Endpoints_STATUS_ARM)
The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint.
Field | Description |
---|---|
blob string |
Blob: Gets the blob endpoint. |
dfs string |
Dfs: Gets the dfs endpoint. |
file string |
File: Gets the file endpoint. |
queue string |
Queue: Gets the queue endpoint. |
table string |
Table: Gets the table endpoint. |
web string |
Web: Gets the web endpoint. |
StorageAccountOperatorConfigMaps
(Appears on:StorageAccountOperatorSpec)
Field | Description |
---|---|
blobEndpoint genruntime.ConfigMapDestination |
BlobEndpoint: indicates where the BlobEndpoint config map should be placed. If omitted, no config map will be created. |
dfsEndpoint genruntime.ConfigMapDestination |
DfsEndpoint: indicates where the DfsEndpoint config map should be placed. If omitted, no config map will be created. |
fileEndpoint genruntime.ConfigMapDestination |
FileEndpoint: indicates where the FileEndpoint config map should be placed. If omitted, no config map will be created. |
queueEndpoint genruntime.ConfigMapDestination |
QueueEndpoint: indicates where the QueueEndpoint config map should be placed. If omitted, no config map will be created. |
tableEndpoint genruntime.ConfigMapDestination |
TableEndpoint: indicates where the TableEndpoint config map should be placed. If omitted, no config map will be created. |
webEndpoint genruntime.ConfigMapDestination |
WebEndpoint: indicates where the WebEndpoint config map should be placed. If omitted, no config map will be created. |
StorageAccountOperatorSecrets
(Appears on:StorageAccountOperatorSpec)
Field | Description |
---|---|
blobEndpoint genruntime.SecretDestination |
BlobEndpoint: indicates where the BlobEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. |
dfsEndpoint genruntime.SecretDestination |
DfsEndpoint: indicates where the DfsEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. |
fileEndpoint genruntime.SecretDestination |
FileEndpoint: indicates where the FileEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. |
key1 genruntime.SecretDestination |
Key1: indicates where the Key1 secret should be placed. If omitted, the secret will not be retrieved from Azure. |
key2 genruntime.SecretDestination |
Key2: indicates where the Key2 secret should be placed. If omitted, the secret will not be retrieved from Azure. |
queueEndpoint genruntime.SecretDestination |
QueueEndpoint: indicates where the QueueEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. |
tableEndpoint genruntime.SecretDestination |
TableEndpoint: indicates where the TableEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. |
webEndpoint genruntime.SecretDestination |
WebEndpoint: indicates where the WebEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. |
StorageAccountOperatorSpec
(Appears on:StorageAccount_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMaps StorageAccountOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secrets StorageAccountOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
StorageAccountPropertiesCreateParameters_ARM
(Appears on:StorageAccount_Spec_ARM)
The parameters used to create the storage account.
Field | Description |
---|---|
accessTier StorageAccountPropertiesCreateParameters_AccessTier_ARM |
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. |
allowBlobPublicAccess bool |
AllowBlobPublicAccess: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. |
allowCrossTenantReplication bool |
AllowCrossTenantReplication: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. |
allowSharedKeyAccess bool |
AllowSharedKeyAccess: Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true. |
allowedCopyScope StorageAccountPropertiesCreateParameters_AllowedCopyScope_ARM |
AllowedCopyScope: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. |
azureFilesIdentityBasedAuthentication AzureFilesIdentityBasedAuthentication_ARM |
AzureFilesIdentityBasedAuthentication: Provides the identity based authentication settings for Azure Files. |
customDomain CustomDomain_ARM |
CustomDomain: User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. |
defaultToOAuthAuthentication bool |
DefaultToOAuthAuthentication: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. |
dnsEndpointType StorageAccountPropertiesCreateParameters_DnsEndpointType_ARM |
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. |
encryption Encryption_ARM |
Encryption: Encryption settings to be used for server-side encryption for the storage account. |
immutableStorageWithVersioning ImmutableStorageAccount_ARM |
ImmutableStorageWithVersioning: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the new containers in the account by default. |
isHnsEnabled bool |
IsHnsEnabled: Account HierarchicalNamespace enabled if sets to true. |
isLocalUserEnabled bool |
IsLocalUserEnabled: Enables local users feature, if set to true |
isNfsV3Enabled bool |
IsNfsV3Enabled: NFS 3.0 protocol support enabled if set to true. |
isSftpEnabled bool |
IsSftpEnabled: Enables Secure File Transfer Protocol, if set to true |
keyPolicy KeyPolicy_ARM |
KeyPolicy: KeyPolicy assigned to the storage account. |
largeFileSharesState StorageAccountPropertiesCreateParameters_LargeFileSharesState_ARM |
LargeFileSharesState: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. |
minimumTlsVersion StorageAccountPropertiesCreateParameters_MinimumTlsVersion_ARM |
MinimumTlsVersion: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. |
networkAcls NetworkRuleSet_ARM |
NetworkAcls: Network rule set |
publicNetworkAccess StorageAccountPropertiesCreateParameters_PublicNetworkAccess_ARM |
PublicNetworkAccess: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. |
routingPreference RoutingPreference_ARM |
RoutingPreference: Maintains information about the network routing choice opted by the user for data transfer |
sasPolicy SasPolicy_ARM |
SasPolicy: SasPolicy assigned to the storage account. |
supportsHttpsTrafficOnly bool |
SupportsHttpsTrafficOnly: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. |
StorageAccountPropertiesCreateParameters_AccessTier
(string
alias)
(Appears on:StorageAccount_Spec)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
|
"Premium" |
StorageAccountPropertiesCreateParameters_AccessTier_ARM
(string
alias)
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
|
"Premium" |
StorageAccountPropertiesCreateParameters_AllowedCopyScope
(string
alias)
(Appears on:StorageAccount_Spec)
Value | Description |
---|---|
"AAD" |
|
"PrivateLink" |
StorageAccountPropertiesCreateParameters_AllowedCopyScope_ARM
(string
alias)
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
Value | Description |
---|---|
"AAD" |
|
"PrivateLink" |
StorageAccountPropertiesCreateParameters_DnsEndpointType
(string
alias)
(Appears on:StorageAccount_Spec)
Value | Description |
---|---|
"AzureDnsZone" |
|
"Standard" |
StorageAccountPropertiesCreateParameters_DnsEndpointType_ARM
(string
alias)
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
Value | Description |
---|---|
"AzureDnsZone" |
|
"Standard" |
StorageAccountPropertiesCreateParameters_LargeFileSharesState
(string
alias)
(Appears on:StorageAccount_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountPropertiesCreateParameters_LargeFileSharesState_ARM
(string
alias)
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountPropertiesCreateParameters_MinimumTlsVersion
(string
alias)
(Appears on:StorageAccount_Spec)
Value | Description |
---|---|
"TLS1_0" |
|
"TLS1_1" |
|
"TLS1_2" |
StorageAccountPropertiesCreateParameters_MinimumTlsVersion_ARM
(string
alias)
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
Value | Description |
---|---|
"TLS1_0" |
|
"TLS1_1" |
|
"TLS1_2" |
StorageAccountPropertiesCreateParameters_PublicNetworkAccess
(string
alias)
(Appears on:StorageAccount_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountPropertiesCreateParameters_PublicNetworkAccess_ARM
(string
alias)
(Appears on:StorageAccountPropertiesCreateParameters_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountProperties_AccessTier_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
|
"Premium" |
StorageAccountProperties_AccessTier_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
|
"Premium" |
StorageAccountProperties_AllowedCopyScope_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"AAD" |
|
"PrivateLink" |
StorageAccountProperties_AllowedCopyScope_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"AAD" |
|
"PrivateLink" |
StorageAccountProperties_DnsEndpointType_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"AzureDnsZone" |
|
"Standard" |
StorageAccountProperties_DnsEndpointType_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"AzureDnsZone" |
|
"Standard" |
StorageAccountProperties_LargeFileSharesState_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountProperties_LargeFileSharesState_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountProperties_MinimumTlsVersion_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"TLS1_0" |
|
"TLS1_1" |
|
"TLS1_2" |
StorageAccountProperties_MinimumTlsVersion_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"TLS1_0" |
|
"TLS1_1" |
|
"TLS1_2" |
StorageAccountProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"Creating" |
|
"ResolvingDNS" |
|
"Succeeded" |
StorageAccountProperties_ProvisioningState_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"Creating" |
|
"ResolvingDNS" |
|
"Succeeded" |
StorageAccountProperties_PublicNetworkAccess_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountProperties_PublicNetworkAccess_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountProperties_STATUS_ARM
(Appears on:StorageAccount_STATUS_ARM)
Properties of the storage account.
Field | Description |
---|---|
accessTier StorageAccountProperties_AccessTier_STATUS_ARM |
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. |
allowBlobPublicAccess bool |
AllowBlobPublicAccess: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. |
allowCrossTenantReplication bool |
AllowCrossTenantReplication: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. |
allowSharedKeyAccess bool |
AllowSharedKeyAccess: Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true. |
allowedCopyScope StorageAccountProperties_AllowedCopyScope_STATUS_ARM |
AllowedCopyScope: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. |
azureFilesIdentityBasedAuthentication AzureFilesIdentityBasedAuthentication_STATUS_ARM |
AzureFilesIdentityBasedAuthentication: Provides the identity based authentication settings for Azure Files. |
blobRestoreStatus BlobRestoreStatus_STATUS_ARM |
BlobRestoreStatus: Blob restore status |
creationTime string |
CreationTime: Gets the creation date and time of the storage account in UTC. |
customDomain CustomDomain_STATUS_ARM |
CustomDomain: Gets the custom domain the user assigned to this storage account. |
defaultToOAuthAuthentication bool |
DefaultToOAuthAuthentication: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. |
dnsEndpointType StorageAccountProperties_DnsEndpointType_STATUS_ARM |
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. |
encryption Encryption_STATUS_ARM |
Encryption: Encryption settings to be used for server-side encryption for the storage account. |
failoverInProgress bool |
FailoverInProgress: If the failover is in progress, the value will be true, otherwise, it will be null. |
geoReplicationStats GeoReplicationStats_STATUS_ARM |
GeoReplicationStats: Geo Replication Stats |
immutableStorageWithVersioning ImmutableStorageAccount_STATUS_ARM |
ImmutableStorageWithVersioning: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. |
isHnsEnabled bool |
IsHnsEnabled: Account HierarchicalNamespace enabled if sets to true. |
isLocalUserEnabled bool |
IsLocalUserEnabled: Enables local users feature, if set to true |
isNfsV3Enabled bool |
IsNfsV3Enabled: NFS 3.0 protocol support enabled if set to true. |
isSftpEnabled bool |
IsSftpEnabled: Enables Secure File Transfer Protocol, if set to true |
keyCreationTime KeyCreationTime_STATUS_ARM |
KeyCreationTime: Storage account keys creation time. |
keyPolicy KeyPolicy_STATUS_ARM |
KeyPolicy: KeyPolicy assigned to the storage account. |
largeFileSharesState StorageAccountProperties_LargeFileSharesState_STATUS_ARM |
LargeFileSharesState: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. |
lastGeoFailoverTime string |
LastGeoFailoverTime: Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. |
minimumTlsVersion StorageAccountProperties_MinimumTlsVersion_STATUS_ARM |
MinimumTlsVersion: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. |
networkAcls NetworkRuleSet_STATUS_ARM |
NetworkAcls: Network rule set |
primaryEndpoints Endpoints_STATUS_ARM |
PrimaryEndpoints: Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint. |
primaryLocation string |
PrimaryLocation: Gets the location of the primary data center for the storage account. |
privateEndpointConnections []PrivateEndpointConnection_STATUS_ARM |
PrivateEndpointConnections: List of private endpoint connection associated with the specified storage account |
provisioningState StorageAccountProperties_ProvisioningState_STATUS_ARM |
ProvisioningState: Gets the status of the storage account at the time the operation was called. |
publicNetworkAccess StorageAccountProperties_PublicNetworkAccess_STATUS_ARM |
PublicNetworkAccess: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. |
routingPreference RoutingPreference_STATUS_ARM |
RoutingPreference: Maintains information about the network routing choice opted by the user for data transfer |
sasPolicy SasPolicy_STATUS_ARM |
SasPolicy: SasPolicy assigned to the storage account. |
secondaryEndpoints Endpoints_STATUS_ARM |
SecondaryEndpoints: Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS. |
secondaryLocation string |
SecondaryLocation: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. |
statusOfPrimary StorageAccountProperties_StatusOfPrimary_STATUS_ARM |
StatusOfPrimary: Gets the status indicating whether the primary location of the storage account is available or unavailable. |
statusOfSecondary StorageAccountProperties_StatusOfSecondary_STATUS_ARM |
StatusOfSecondary: Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS. |
storageAccountSkuConversionStatus StorageAccountSkuConversionStatus_STATUS_ARM |
StorageAccountSkuConversionStatus: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. |
supportsHttpsTrafficOnly bool |
SupportsHttpsTrafficOnly: Allows https traffic only to storage service if sets to true. |
StorageAccountProperties_StatusOfPrimary_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"available" |
|
"unavailable" |
StorageAccountProperties_StatusOfPrimary_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"available" |
|
"unavailable" |
StorageAccountProperties_StatusOfSecondary_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"available" |
|
"unavailable" |
StorageAccountProperties_StatusOfSecondary_STATUS_ARM
(string
alias)
(Appears on:StorageAccountProperties_STATUS_ARM)
Value | Description |
---|---|
"available" |
|
"unavailable" |
StorageAccountSkuConversionStatus_STATUS
(Appears on:StorageAccount_STATUS)
This defines the sku conversion status object for asynchronous sku conversions.
Field | Description |
---|---|
endTime string |
EndTime: This property represents the sku conversion end time. |
skuConversionStatus StorageAccountSkuConversionStatus_SkuConversionStatus_STATUS |
SkuConversionStatus: This property indicates the current sku conversion status. |
startTime string |
StartTime: This property represents the sku conversion start time. |
targetSkuName SkuName_STATUS |
TargetSkuName: This property represents the target sku name to which the account sku is being converted asynchronously. |
StorageAccountSkuConversionStatus_STATUS_ARM
(Appears on:StorageAccountProperties_STATUS_ARM)
This defines the sku conversion status object for asynchronous sku conversions.
Field | Description |
---|---|
endTime string |
EndTime: This property represents the sku conversion end time. |
skuConversionStatus StorageAccountSkuConversionStatus_SkuConversionStatus_STATUS_ARM |
SkuConversionStatus: This property indicates the current sku conversion status. |
startTime string |
StartTime: This property represents the sku conversion start time. |
targetSkuName SkuName_STATUS_ARM |
TargetSkuName: This property represents the target sku name to which the account sku is being converted asynchronously. |
StorageAccountSkuConversionStatus_SkuConversionStatus_STATUS
(string
alias)
(Appears on:StorageAccountSkuConversionStatus_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"Succeeded" |
StorageAccountSkuConversionStatus_SkuConversionStatus_STATUS_ARM
(string
alias)
(Appears on:StorageAccountSkuConversionStatus_STATUS_ARM)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"Succeeded" |
StorageAccount_Kind_STATUS
(string
alias)
(Appears on:StorageAccount_STATUS)
Value | Description |
---|---|
"BlobStorage" |
|
"BlockBlobStorage" |
|
"FileStorage" |
|
"Storage" |
|
"StorageV2" |
StorageAccount_Kind_STATUS_ARM
(string
alias)
(Appears on:StorageAccount_STATUS_ARM)
Value | Description |
---|---|
"BlobStorage" |
|
"BlockBlobStorage" |
|
"FileStorage" |
|
"Storage" |
|
"StorageV2" |
StorageAccount_Kind_Spec
(string
alias)
(Appears on:StorageAccount_Spec)
Value | Description |
---|---|
"BlobStorage" |
|
"BlockBlobStorage" |
|
"FileStorage" |
|
"Storage" |
|
"StorageV2" |
StorageAccount_Kind_Spec_ARM
(string
alias)
(Appears on:StorageAccount_Spec_ARM)
Value | Description |
---|---|
"BlobStorage" |
|
"BlockBlobStorage" |
|
"FileStorage" |
|
"Storage" |
|
"StorageV2" |
StorageAccount_STATUS
(Appears on:StorageAccount)
The storage account.
Field | Description |
---|---|
accessTier StorageAccountProperties_AccessTier_STATUS |
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. |
allowBlobPublicAccess bool |
AllowBlobPublicAccess: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. |
allowCrossTenantReplication bool |
AllowCrossTenantReplication: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. |
allowSharedKeyAccess bool |
AllowSharedKeyAccess: Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true. |
allowedCopyScope StorageAccountProperties_AllowedCopyScope_STATUS |
AllowedCopyScope: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. |
azureFilesIdentityBasedAuthentication AzureFilesIdentityBasedAuthentication_STATUS |
AzureFilesIdentityBasedAuthentication: Provides the identity based authentication settings for Azure Files. |
blobRestoreStatus BlobRestoreStatus_STATUS |
BlobRestoreStatus: Blob restore status |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
creationTime string |
CreationTime: Gets the creation date and time of the storage account in UTC. |
customDomain CustomDomain_STATUS |
CustomDomain: Gets the custom domain the user assigned to this storage account. |
defaultToOAuthAuthentication bool |
DefaultToOAuthAuthentication: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. |
dnsEndpointType StorageAccountProperties_DnsEndpointType_STATUS |
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. |
encryption Encryption_STATUS |
Encryption: Encryption settings to be used for server-side encryption for the storage account. |
extendedLocation ExtendedLocation_STATUS |
ExtendedLocation: The extendedLocation of the resource. |
failoverInProgress bool |
FailoverInProgress: If the failover is in progress, the value will be true, otherwise, it will be null. |
geoReplicationStats GeoReplicationStats_STATUS |
GeoReplicationStats: Geo Replication Stats |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_STATUS |
Identity: The identity of the resource. |
immutableStorageWithVersioning ImmutableStorageAccount_STATUS |
ImmutableStorageWithVersioning: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. |
isHnsEnabled bool |
IsHnsEnabled: Account HierarchicalNamespace enabled if sets to true. |
isLocalUserEnabled bool |
IsLocalUserEnabled: Enables local users feature, if set to true |
isNfsV3Enabled bool |
IsNfsV3Enabled: NFS 3.0 protocol support enabled if set to true. |
isSftpEnabled bool |
IsSftpEnabled: Enables Secure File Transfer Protocol, if set to true |
keyCreationTime KeyCreationTime_STATUS |
KeyCreationTime: Storage account keys creation time. |
keyPolicy KeyPolicy_STATUS |
KeyPolicy: KeyPolicy assigned to the storage account. |
kind StorageAccount_Kind_STATUS |
Kind: Gets the Kind. |
largeFileSharesState StorageAccountProperties_LargeFileSharesState_STATUS |
LargeFileSharesState: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. |
lastGeoFailoverTime string |
LastGeoFailoverTime: Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS. |
location string |
Location: The geo-location where the resource lives |
minimumTlsVersion StorageAccountProperties_MinimumTlsVersion_STATUS |
MinimumTlsVersion: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. |
name string |
Name: The name of the resource |
networkAcls NetworkRuleSet_STATUS |
NetworkAcls: Network rule set |
primaryEndpoints Endpoints_STATUS |
PrimaryEndpoints: Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint. |
primaryLocation string |
PrimaryLocation: Gets the location of the primary data center for the storage account. |
privateEndpointConnections []PrivateEndpointConnection_STATUS |
PrivateEndpointConnections: List of private endpoint connection associated with the specified storage account |
provisioningState StorageAccountProperties_ProvisioningState_STATUS |
ProvisioningState: Gets the status of the storage account at the time the operation was called. |
publicNetworkAccess StorageAccountProperties_PublicNetworkAccess_STATUS |
PublicNetworkAccess: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. |
routingPreference RoutingPreference_STATUS |
RoutingPreference: Maintains information about the network routing choice opted by the user for data transfer |
sasPolicy SasPolicy_STATUS |
SasPolicy: SasPolicy assigned to the storage account. |
secondaryEndpoints Endpoints_STATUS |
SecondaryEndpoints: Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS. |
secondaryLocation string |
SecondaryLocation: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. |
sku Sku_STATUS |
Sku: Gets the SKU. |
statusOfPrimary StorageAccountProperties_StatusOfPrimary_STATUS |
StatusOfPrimary: Gets the status indicating whether the primary location of the storage account is available or unavailable. |
statusOfSecondary StorageAccountProperties_StatusOfSecondary_STATUS |
StatusOfSecondary: Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS. |
storageAccountSkuConversionStatus StorageAccountSkuConversionStatus_STATUS |
StorageAccountSkuConversionStatus: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. |
supportsHttpsTrafficOnly bool |
SupportsHttpsTrafficOnly: Allows https traffic only to storage service if sets to true. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccount_STATUS_ARM
The storage account.
Field | Description |
---|---|
extendedLocation ExtendedLocation_STATUS_ARM |
ExtendedLocation: The extendedLocation of the resource. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
identity Identity_STATUS_ARM |
Identity: The identity of the resource. |
kind StorageAccount_Kind_STATUS_ARM |
Kind: Gets the Kind. |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
properties StorageAccountProperties_STATUS_ARM |
Properties: Properties of the storage account. |
sku Sku_STATUS_ARM |
Sku: Gets the SKU. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccount_Spec
(Appears on:StorageAccount)
Field | Description |
---|---|
accessTier StorageAccountPropertiesCreateParameters_AccessTier |
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. |
allowBlobPublicAccess bool |
AllowBlobPublicAccess: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property. |
allowCrossTenantReplication bool |
AllowCrossTenantReplication: Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property. |
allowSharedKeyAccess bool |
AllowSharedKeyAccess: Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true. |
allowedCopyScope StorageAccountPropertiesCreateParameters_AllowedCopyScope |
AllowedCopyScope: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. |
azureFilesIdentityBasedAuthentication AzureFilesIdentityBasedAuthentication |
AzureFilesIdentityBasedAuthentication: Provides the identity based authentication settings for Azure Files. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
customDomain CustomDomain |
CustomDomain: User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. |
defaultToOAuthAuthentication bool |
DefaultToOAuthAuthentication: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. |
dnsEndpointType StorageAccountPropertiesCreateParameters_DnsEndpointType |
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. |
encryption Encryption |
Encryption: Encryption settings to be used for server-side encryption for the storage account. |
extendedLocation ExtendedLocation |
ExtendedLocation: Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location |
identity Identity |
Identity: The identity of the resource. |
immutableStorageWithVersioning ImmutableStorageAccount |
ImmutableStorageWithVersioning: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the new containers in the account by default. |
isHnsEnabled bool |
IsHnsEnabled: Account HierarchicalNamespace enabled if sets to true. |
isLocalUserEnabled bool |
IsLocalUserEnabled: Enables local users feature, if set to true |
isNfsV3Enabled bool |
IsNfsV3Enabled: NFS 3.0 protocol support enabled if set to true. |
isSftpEnabled bool |
IsSftpEnabled: Enables Secure File Transfer Protocol, if set to true |
keyPolicy KeyPolicy |
KeyPolicy: KeyPolicy assigned to the storage account. |
kind StorageAccount_Kind_Spec |
Kind: Required. Indicates the type of storage account. |
largeFileSharesState StorageAccountPropertiesCreateParameters_LargeFileSharesState |
LargeFileSharesState: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. |
location string |
Location: Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. |
minimumTlsVersion StorageAccountPropertiesCreateParameters_MinimumTlsVersion |
MinimumTlsVersion: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. |
networkAcls NetworkRuleSet |
NetworkAcls: Network rule set |
operatorSpec StorageAccountOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
publicNetworkAccess StorageAccountPropertiesCreateParameters_PublicNetworkAccess |
PublicNetworkAccess: Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be ‘Enabled’ or ‘Disabled’. |
routingPreference RoutingPreference |
RoutingPreference: Maintains information about the network routing choice opted by the user for data transfer |
sasPolicy SasPolicy |
SasPolicy: SasPolicy assigned to the storage account. |
sku Sku |
Sku: Required. Gets or sets the SKU name. |
supportsHttpsTrafficOnly bool |
SupportsHttpsTrafficOnly: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. |
tags map[string]string |
Tags: Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters. |
StorageAccount_Spec_ARM
Field | Description |
---|---|
extendedLocation ExtendedLocation_ARM |
ExtendedLocation: Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location |
identity Identity_ARM |
Identity: The identity of the resource. |
kind StorageAccount_Kind_Spec_ARM |
Kind: Required. Indicates the type of storage account. |
location string |
Location: Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed. |
name string |
|
properties StorageAccountPropertiesCreateParameters_ARM |
Properties: The parameters used to create the storage account. |
sku Sku_ARM |
Sku: Required. Gets or sets the SKU name. |
tags map[string]string |
Tags: Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters. |
StorageAccountsBlobService
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/blob.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/defaultp>
Field | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||
spec StorageAccounts_BlobService_Spec |
|
||||||||||||||||||||
status StorageAccounts_BlobService_STATUS |
StorageAccountsBlobServicesContainer
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/blob.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}p>
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||
spec StorageAccounts_BlobServices_Container_Spec |
|
||||||||||||||||||
status StorageAccounts_BlobServices_Container_STATUS |
StorageAccountsFileService
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/file.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/defaultp>
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec StorageAccounts_FileService_Spec |
|
||||||||
status StorageAccounts_FileService_STATUS |
StorageAccountsFileServicesShare
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/file.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}p>
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec StorageAccounts_FileServices_Share_Spec |
|
||||||||||||||||
status StorageAccounts_FileServices_Share_STATUS |
StorageAccountsManagementPolicy
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/storage.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/defaultp>
Field | Description | ||||
---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
spec StorageAccounts_ManagementPolicy_Spec |
|
||||
status StorageAccounts_ManagementPolicy_STATUS |
StorageAccountsQueueService
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/queue.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/defaultp>
Field | Description | ||||
---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
spec StorageAccounts_QueueService_Spec |
|
||||
status StorageAccounts_QueueService_STATUS |
StorageAccountsQueueServicesQueue
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/queue.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}p>
Field | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
spec StorageAccounts_QueueServices_Queue_Spec |
|
||||||
status StorageAccounts_QueueServices_Queue_STATUS |
StorageAccountsTableService
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/table.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/defaultp>
Field | Description | ||||
---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
spec StorageAccounts_TableService_Spec |
|
||||
status StorageAccounts_TableService_STATUS |
StorageAccountsTableServicesTable
Generator information: - Generated from: /storage/resource-manager/Microsoft.Storage/stable/2022-09-01/table.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}p>
Field | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
spec StorageAccounts_TableServices_Table_Spec |
|
||||||
status StorageAccounts_TableServices_Table_STATUS |
StorageAccounts_BlobService_Properties_STATUS_ARM
(Appears on:StorageAccounts_BlobService_STATUS_ARM)
Field | Description |
---|---|
automaticSnapshotPolicyEnabled bool |
AutomaticSnapshotPolicyEnabled: Deprecated in favor of isVersioningEnabled property. |
changeFeed ChangeFeed_STATUS_ARM |
ChangeFeed: The blob service properties for change feed events. |
containerDeleteRetentionPolicy DeleteRetentionPolicy_STATUS_ARM |
ContainerDeleteRetentionPolicy: The blob service properties for container soft delete. |
cors CorsRules_STATUS_ARM |
Cors: Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. |
defaultServiceVersion string |
DefaultServiceVersion: DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. |
deleteRetentionPolicy DeleteRetentionPolicy_STATUS_ARM |
DeleteRetentionPolicy: The blob service properties for blob soft delete. |
isVersioningEnabled bool |
IsVersioningEnabled: Versioning is enabled if set to true. |
lastAccessTimeTrackingPolicy LastAccessTimeTrackingPolicy_STATUS_ARM |
LastAccessTimeTrackingPolicy: The blob service property to configure last access time based tracking policy. |
restorePolicy RestorePolicyProperties_STATUS_ARM |
RestorePolicy: The blob service properties for blob restore policy. |
StorageAccounts_BlobService_Properties_Spec_ARM
(Appears on:StorageAccounts_BlobService_Spec_ARM)
Field | Description |
---|---|
automaticSnapshotPolicyEnabled bool |
AutomaticSnapshotPolicyEnabled: Deprecated in favor of isVersioningEnabled property. |
changeFeed ChangeFeed_ARM |
ChangeFeed: The blob service properties for change feed events. |
containerDeleteRetentionPolicy DeleteRetentionPolicy_ARM |
ContainerDeleteRetentionPolicy: The blob service properties for container soft delete. |
cors CorsRules_ARM |
Cors: Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. |
defaultServiceVersion string |
DefaultServiceVersion: DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. |
deleteRetentionPolicy DeleteRetentionPolicy_ARM |
DeleteRetentionPolicy: The blob service properties for blob soft delete. |
isVersioningEnabled bool |
IsVersioningEnabled: Versioning is enabled if set to true. |
lastAccessTimeTrackingPolicy LastAccessTimeTrackingPolicy_ARM |
LastAccessTimeTrackingPolicy: The blob service property to configure last access time based tracking policy. |
restorePolicy RestorePolicyProperties_ARM |
RestorePolicy: The blob service properties for blob restore policy. |
StorageAccounts_BlobService_STATUS
(Appears on:StorageAccountsBlobService)
Field | Description |
---|---|
automaticSnapshotPolicyEnabled bool |
AutomaticSnapshotPolicyEnabled: Deprecated in favor of isVersioningEnabled property. |
changeFeed ChangeFeed_STATUS |
ChangeFeed: The blob service properties for change feed events. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
containerDeleteRetentionPolicy DeleteRetentionPolicy_STATUS |
ContainerDeleteRetentionPolicy: The blob service properties for container soft delete. |
cors CorsRules_STATUS |
Cors: Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. |
defaultServiceVersion string |
DefaultServiceVersion: DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. |
deleteRetentionPolicy DeleteRetentionPolicy_STATUS |
DeleteRetentionPolicy: The blob service properties for blob soft delete. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
isVersioningEnabled bool |
IsVersioningEnabled: Versioning is enabled if set to true. |
lastAccessTimeTrackingPolicy LastAccessTimeTrackingPolicy_STATUS |
LastAccessTimeTrackingPolicy: The blob service property to configure last access time based tracking policy. |
name string |
Name: The name of the resource |
restorePolicy RestorePolicyProperties_STATUS |
RestorePolicy: The blob service properties for blob restore policy. |
sku Sku_STATUS |
Sku: Sku name and tier. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_BlobService_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties StorageAccounts_BlobService_Properties_STATUS_ARM |
Properties: The properties of a storage account’s Blob service. |
sku Sku_STATUS_ARM |
Sku: Sku name and tier. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_BlobService_Spec
(Appears on:StorageAccountsBlobService)
Field | Description |
---|---|
automaticSnapshotPolicyEnabled bool |
AutomaticSnapshotPolicyEnabled: Deprecated in favor of isVersioningEnabled property. |
changeFeed ChangeFeed |
ChangeFeed: The blob service properties for change feed events. |
containerDeleteRetentionPolicy DeleteRetentionPolicy |
ContainerDeleteRetentionPolicy: The blob service properties for container soft delete. |
cors CorsRules |
Cors: Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. |
defaultServiceVersion string |
DefaultServiceVersion: DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions. |
deleteRetentionPolicy DeleteRetentionPolicy |
DeleteRetentionPolicy: The blob service properties for blob soft delete. |
isVersioningEnabled bool |
IsVersioningEnabled: Versioning is enabled if set to true. |
lastAccessTimeTrackingPolicy LastAccessTimeTrackingPolicy |
LastAccessTimeTrackingPolicy: The blob service property to configure last access time based tracking policy. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccount resource |
restorePolicy RestorePolicyProperties |
RestorePolicy: The blob service properties for blob restore policy. |
StorageAccounts_BlobService_Spec_ARM
Field | Description |
---|---|
name string |
|
properties StorageAccounts_BlobService_Properties_Spec_ARM |
Properties: The properties of a storage account’s Blob service. |
StorageAccounts_BlobServices_Container_STATUS
(Appears on:StorageAccountsBlobServicesContainer)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
defaultEncryptionScope string |
DefaultEncryptionScope: Default the container to use specified encryption scope for all writes. |
deleted bool |
Deleted: Indicates whether the blob container was deleted. |
deletedTime string |
DeletedTime: Blob container deletion time. |
denyEncryptionScopeOverride bool |
DenyEncryptionScopeOverride: Block override of encryption scope from the container default. |
enableNfsV3AllSquash bool |
EnableNfsV3AllSquash: Enable NFSv3 all squash on blob container. |
enableNfsV3RootSquash bool |
EnableNfsV3RootSquash: Enable NFSv3 root squash on blob container. |
etag string |
Etag: Resource Etag. |
hasImmutabilityPolicy bool |
HasImmutabilityPolicy: The hasImmutabilityPolicy public property is set to true by SRP if ImmutabilityPolicy has been created for this container. The hasImmutabilityPolicy public property is set to false by SRP if ImmutabilityPolicy has not been created for this container. |
hasLegalHold bool |
HasLegalHold: The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
immutabilityPolicy ImmutabilityPolicyProperties_STATUS |
ImmutabilityPolicy: The ImmutabilityPolicy property of the container. |
immutableStorageWithVersioning ImmutableStorageWithVersioning_STATUS |
ImmutableStorageWithVersioning: The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process. |
lastModifiedTime string |
LastModifiedTime: Returns the date and time the container was last modified. |
leaseDuration ContainerProperties_LeaseDuration_STATUS |
LeaseDuration: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. |
leaseState ContainerProperties_LeaseState_STATUS |
LeaseState: Lease state of the container. |
leaseStatus ContainerProperties_LeaseStatus_STATUS |
LeaseStatus: The lease status of the container. |
legalHold LegalHoldProperties_STATUS |
LegalHold: The LegalHold property of the container. |
metadata map[string]string |
Metadata: A name-value pair to associate with the container as metadata. |
name string |
Name: The name of the resource |
publicAccess ContainerProperties_PublicAccess_STATUS |
PublicAccess: Specifies whether data in the container may be accessed publicly and the level of access. |
remainingRetentionDays int |
RemainingRetentionDays: Remaining retention days for soft deleted blob container. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
version string |
Version: The version of the deleted blob container. |
StorageAccounts_BlobServices_Container_STATUS_ARM
Field | Description |
---|---|
etag string |
Etag: Resource Etag. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties ContainerProperties_STATUS_ARM |
Properties: Properties of the blob container. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_BlobServices_Container_Spec
(Appears on:StorageAccountsBlobServicesContainer)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
defaultEncryptionScope string |
DefaultEncryptionScope: Default the container to use specified encryption scope for all writes. |
denyEncryptionScopeOverride bool |
DenyEncryptionScopeOverride: Block override of encryption scope from the container default. |
enableNfsV3AllSquash bool |
EnableNfsV3AllSquash: Enable NFSv3 all squash on blob container. |
enableNfsV3RootSquash bool |
EnableNfsV3RootSquash: Enable NFSv3 root squash on blob container. |
immutableStorageWithVersioning ImmutableStorageWithVersioning |
ImmutableStorageWithVersioning: The object level immutability property of the container. The property is immutable and can only be set to true at the container creation time. Existing containers must undergo a migration process. |
metadata map[string]string |
Metadata: A name-value pair to associate with the container as metadata. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccountsBlobService resource |
publicAccess ContainerProperties_PublicAccess |
PublicAccess: Specifies whether data in the container may be accessed publicly and the level of access. |
StorageAccounts_BlobServices_Container_Spec_ARM
Field | Description |
---|---|
name string |
|
properties ContainerProperties_ARM |
Properties: Properties of the blob container. |
StorageAccounts_FileService_Properties_STATUS_ARM
(Appears on:StorageAccounts_FileService_STATUS_ARM)
Field | Description |
---|---|
cors CorsRules_STATUS_ARM |
Cors: Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. |
protocolSettings ProtocolSettings_STATUS_ARM |
ProtocolSettings: Protocol settings for file service |
shareDeleteRetentionPolicy DeleteRetentionPolicy_STATUS_ARM |
ShareDeleteRetentionPolicy: The file service properties for share soft delete. |
StorageAccounts_FileService_Properties_Spec_ARM
(Appears on:StorageAccounts_FileService_Spec_ARM)
Field | Description |
---|---|
cors CorsRules_ARM |
Cors: Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. |
protocolSettings ProtocolSettings_ARM |
ProtocolSettings: Protocol settings for file service |
shareDeleteRetentionPolicy DeleteRetentionPolicy_ARM |
ShareDeleteRetentionPolicy: The file service properties for share soft delete. |
StorageAccounts_FileService_STATUS
(Appears on:StorageAccountsFileService)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
cors CorsRules_STATUS |
Cors: Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
protocolSettings ProtocolSettings_STATUS |
ProtocolSettings: Protocol settings for file service |
shareDeleteRetentionPolicy DeleteRetentionPolicy_STATUS |
ShareDeleteRetentionPolicy: The file service properties for share soft delete. |
sku Sku_STATUS |
Sku: Sku name and tier. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_FileService_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties StorageAccounts_FileService_Properties_STATUS_ARM |
Properties: The properties of File services in storage account. |
sku Sku_STATUS_ARM |
Sku: Sku name and tier. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_FileService_Spec
(Appears on:StorageAccountsFileService)
Field | Description |
---|---|
cors CorsRules |
Cors: Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccount resource |
protocolSettings ProtocolSettings |
ProtocolSettings: Protocol settings for file service |
shareDeleteRetentionPolicy DeleteRetentionPolicy |
ShareDeleteRetentionPolicy: The file service properties for share soft delete. |
StorageAccounts_FileService_Spec_ARM
Field | Description |
---|---|
name string |
|
properties StorageAccounts_FileService_Properties_Spec_ARM |
Properties: The properties of File services in storage account. |
StorageAccounts_FileServices_Share_STATUS
(Appears on:StorageAccountsFileServicesShare)
Field | Description |
---|---|
accessTier FileShareProperties_AccessTier_STATUS |
AccessTier: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
accessTierChangeTime string |
AccessTierChangeTime: Indicates the last modification time for share access tier. |
accessTierStatus string |
AccessTierStatus: Indicates if there is a pending transition for access tier. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deleted bool |
Deleted: Indicates whether the share was deleted. |
deletedTime string |
DeletedTime: The deleted time if the share was deleted. |
enabledProtocols FileShareProperties_EnabledProtocols_STATUS |
EnabledProtocols: The authentication protocol that is used for the file share. Can only be specified when creating a share. |
etag string |
Etag: Resource Etag. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
lastModifiedTime string |
LastModifiedTime: Returns the date and time the share was last modified. |
leaseDuration FileShareProperties_LeaseDuration_STATUS |
LeaseDuration: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. |
leaseState FileShareProperties_LeaseState_STATUS |
LeaseState: Lease state of the share. |
leaseStatus FileShareProperties_LeaseStatus_STATUS |
LeaseStatus: The lease status of the share. |
metadata map[string]string |
Metadata: A name-value pair to associate with the share as metadata. |
name string |
Name: The name of the resource |
remainingRetentionDays int |
RemainingRetentionDays: Remaining retention days for share that was soft deleted. |
rootSquash FileShareProperties_RootSquash_STATUS |
RootSquash: The property is for NFS share only. The default is NoRootSquash. |
shareQuota int |
ShareQuota: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. |
shareUsageBytes int |
ShareUsageBytes: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. |
signedIdentifiers []SignedIdentifier_STATUS |
SignedIdentifiers: List of stored access policies specified on the share. |
snapshotTime string |
SnapshotTime: Creation time of share snapshot returned in the response of list shares with expand param “snapshots”. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
version string |
Version: The version of the share. |
StorageAccounts_FileServices_Share_STATUS_ARM
Field | Description |
---|---|
etag string |
Etag: Resource Etag. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties FileShareProperties_STATUS_ARM |
Properties: Properties of the file share. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_FileServices_Share_Spec
(Appears on:StorageAccountsFileServicesShare)
Field | Description |
---|---|
accessTier FileShareProperties_AccessTier |
AccessTier: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
enabledProtocols FileShareProperties_EnabledProtocols |
EnabledProtocols: The authentication protocol that is used for the file share. Can only be specified when creating a share. |
metadata map[string]string |
Metadata: A name-value pair to associate with the share as metadata. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccountsFileService resource |
rootSquash FileShareProperties_RootSquash |
RootSquash: The property is for NFS share only. The default is NoRootSquash. |
shareQuota int |
ShareQuota: The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. |
signedIdentifiers []SignedIdentifier |
SignedIdentifiers: List of stored access policies specified on the share. |
StorageAccounts_FileServices_Share_Spec_ARM
Field | Description |
---|---|
name string |
|
properties FileShareProperties_ARM |
Properties: Properties of the file share. |
StorageAccounts_ManagementPolicy_STATUS
(Appears on:StorageAccountsManagementPolicy)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
lastModifiedTime string |
LastModifiedTime: Returns the date and time the ManagementPolicies was last modified. |
name string |
Name: The name of the resource |
policy ManagementPolicySchema_STATUS |
Policy: The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_ManagementPolicy_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties ManagementPolicyProperties_STATUS_ARM |
Properties: Returns the Storage Account Data Policies Rules. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_ManagementPolicy_Spec
(Appears on:StorageAccountsManagementPolicy)
Field | Description |
---|---|
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccount resource |
policy ManagementPolicySchema |
Policy: The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
StorageAccounts_ManagementPolicy_Spec_ARM
Field | Description |
---|---|
name string |
|
properties ManagementPolicyProperties_ARM |
Properties: Returns the Storage Account Data Policies Rules. |
StorageAccounts_QueueService_Properties_STATUS_ARM
(Appears on:StorageAccounts_QueueService_STATUS_ARM)
Field | Description |
---|---|
cors CorsRules_STATUS_ARM |
Cors: Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service. |
StorageAccounts_QueueService_Properties_Spec_ARM
(Appears on:StorageAccounts_QueueService_Spec_ARM)
Field | Description |
---|---|
cors CorsRules_ARM |
Cors: Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service. |
StorageAccounts_QueueService_STATUS
(Appears on:StorageAccountsQueueService)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
cors CorsRules_STATUS |
Cors: Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_QueueService_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties StorageAccounts_QueueService_Properties_STATUS_ARM |
Properties: The properties of a storage account’s Queue service. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_QueueService_Spec
(Appears on:StorageAccountsQueueService)
Field | Description |
---|---|
cors CorsRules |
Cors: Specifies CORS rules for the Queue service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Queue service. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccount resource |
StorageAccounts_QueueService_Spec_ARM
Field | Description |
---|---|
name string |
|
properties StorageAccounts_QueueService_Properties_Spec_ARM |
Properties: The properties of a storage account’s Queue service. |
StorageAccounts_QueueServices_Queue_STATUS
(Appears on:StorageAccountsQueueServicesQueue)
Field | Description |
---|---|
approximateMessageCount int |
ApproximateMessageCount: Integer indicating an approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
metadata map[string]string |
Metadata: A name-value pair that represents queue metadata. |
name string |
Name: The name of the resource |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_QueueServices_Queue_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties QueueProperties_STATUS_ARM |
Properties: Queue resource properties. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_QueueServices_Queue_Spec
(Appears on:StorageAccountsQueueServicesQueue)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
metadata map[string]string |
Metadata: A name-value pair that represents queue metadata. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccountsQueueService resource |
StorageAccounts_QueueServices_Queue_Spec_ARM
Field | Description |
---|---|
name string |
|
properties QueueProperties_ARM |
Properties: Queue resource properties. |
StorageAccounts_TableService_Properties_STATUS_ARM
(Appears on:StorageAccounts_TableService_STATUS_ARM)
Field | Description |
---|---|
cors CorsRules_STATUS_ARM |
Cors: Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service. |
StorageAccounts_TableService_Properties_Spec_ARM
(Appears on:StorageAccounts_TableService_Spec_ARM)
Field | Description |
---|---|
cors CorsRules_ARM |
Cors: Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service. |
StorageAccounts_TableService_STATUS
(Appears on:StorageAccountsTableService)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
cors CorsRules_STATUS |
Cors: Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_TableService_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties StorageAccounts_TableService_Properties_STATUS_ARM |
Properties: The properties of a storage account’s Table service. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_TableService_Spec
(Appears on:StorageAccountsTableService)
Field | Description |
---|---|
cors CorsRules |
Cors: Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccount resource |
StorageAccounts_TableService_Spec_ARM
Field | Description |
---|---|
name string |
|
properties StorageAccounts_TableService_Properties_Spec_ARM |
Properties: The properties of a storage account’s Table service. |
StorageAccounts_TableServices_Table_STATUS
(Appears on:StorageAccountsTableServicesTable)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
signedIdentifiers []TableSignedIdentifier_STATUS |
SignedIdentifiers: List of stored access policies specified on the table. |
tableName string |
TableName: Table name under the specified account |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_TableServices_Table_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
name string |
Name: The name of the resource |
properties TableProperties_STATUS_ARM |
Properties: Table resource properties. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
StorageAccounts_TableServices_Table_Spec
(Appears on:StorageAccountsTableServicesTable)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a storage.azure.com/StorageAccountsTableService resource |
signedIdentifiers []TableSignedIdentifier |
SignedIdentifiers: List of stored access policies specified on the table. |
StorageAccounts_TableServices_Table_Spec_ARM
Field | Description |
---|---|
name string |
|
properties TableProperties_ARM |
Properties: Table resource properties. |
TableAccessPolicy
(Appears on:TableSignedIdentifier)
Table Access Policy Properties Object.
Field | Description |
---|---|
expiryTime string |
ExpiryTime: Expiry time of the access policy |
permission string |
Permission: Required. List of abbreviated permissions. Supported permission values include ‘r’,‘a’,‘u’,’d’ |
startTime string |
StartTime: Start time of the access policy |
TableAccessPolicy_ARM
(Appears on:TableSignedIdentifier_ARM)
Table Access Policy Properties Object.
Field | Description |
---|---|
expiryTime string |
ExpiryTime: Expiry time of the access policy |
permission string |
Permission: Required. List of abbreviated permissions. Supported permission values include ‘r’,‘a’,‘u’,’d’ |
startTime string |
StartTime: Start time of the access policy |
TableAccessPolicy_STATUS
(Appears on:TableSignedIdentifier_STATUS)
Table Access Policy Properties Object.
Field | Description |
---|---|
expiryTime string |
ExpiryTime: Expiry time of the access policy |
permission string |
Permission: Required. List of abbreviated permissions. Supported permission values include ‘r’,‘a’,‘u’,’d’ |
startTime string |
StartTime: Start time of the access policy |
TableAccessPolicy_STATUS_ARM
(Appears on:TableSignedIdentifier_STATUS_ARM)
Table Access Policy Properties Object.
Field | Description |
---|---|
expiryTime string |
ExpiryTime: Expiry time of the access policy |
permission string |
Permission: Required. List of abbreviated permissions. Supported permission values include ‘r’,‘a’,‘u’,’d’ |
startTime string |
StartTime: Start time of the access policy |
TableProperties_ARM
(Appears on:StorageAccounts_TableServices_Table_Spec_ARM)
Field | Description |
---|---|
signedIdentifiers []TableSignedIdentifier_ARM |
SignedIdentifiers: List of stored access policies specified on the table. |
TableProperties_STATUS_ARM
(Appears on:StorageAccounts_TableServices_Table_STATUS_ARM)
Field | Description |
---|---|
signedIdentifiers []TableSignedIdentifier_STATUS_ARM |
SignedIdentifiers: List of stored access policies specified on the table. |
tableName string |
TableName: Table name under the specified account |
TableSignedIdentifier
(Appears on:StorageAccounts_TableServices_Table_Spec)
Object to set Table Access Policy.
Field | Description |
---|---|
accessPolicy TableAccessPolicy |
AccessPolicy: Access policy |
reference genruntime.ResourceReference |
Reference: unique-64-character-value of the stored access policy. |
TableSignedIdentifier_ARM
(Appears on:TableProperties_ARM)
Object to set Table Access Policy.
Field | Description |
---|---|
accessPolicy TableAccessPolicy_ARM |
AccessPolicy: Access policy |
id string |
TableSignedIdentifier_STATUS
(Appears on:StorageAccounts_TableServices_Table_STATUS)
Object to set Table Access Policy.
Field | Description |
---|---|
accessPolicy TableAccessPolicy_STATUS |
AccessPolicy: Access policy |
id string |
Id: unique-64-character-value of the stored access policy. |
TableSignedIdentifier_STATUS_ARM
(Appears on:TableProperties_STATUS_ARM)
Object to set Table Access Policy.
Field | Description |
---|---|
accessPolicy TableAccessPolicy_STATUS_ARM |
AccessPolicy: Access policy |
id string |
Id: unique-64-character-value of the stored access policy. |
TagFilter
(Appears on:ManagementPolicyFilter)
Blob index tag based filtering for blob objects
Field | Description |
---|---|
name string |
Name: This is the filter tag name, it can have 1 - 128 characters |
op string |
Op: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported |
value string |
Value: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters |
TagFilter_ARM
(Appears on:ManagementPolicyFilter_ARM)
Blob index tag based filtering for blob objects
Field | Description |
---|---|
name string |
Name: This is the filter tag name, it can have 1 - 128 characters |
op string |
Op: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported |
value string |
Value: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters |
TagFilter_STATUS
(Appears on:ManagementPolicyFilter_STATUS)
Blob index tag based filtering for blob objects
Field | Description |
---|---|
name string |
Name: This is the filter tag name, it can have 1 - 128 characters |
op string |
Op: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported |
value string |
Value: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters |
TagFilter_STATUS_ARM
(Appears on:ManagementPolicyFilter_STATUS_ARM)
Blob index tag based filtering for blob objects
Field | Description |
---|---|
name string |
Name: This is the filter tag name, it can have 1 - 128 characters |
op string |
Op: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported |
value string |
Value: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters |
TagProperty_STATUS
(Appears on:LegalHoldProperties_STATUS)
A tag of the LegalHold of a blob container.
Field | Description |
---|---|
objectIdentifier string |
ObjectIdentifier: Returns the Object ID of the user who added the tag. |
tag string |
Tag: The tag value. |
tenantId string |
TenantId: Returns the Tenant ID that issued the token for the user who added the tag. |
timestamp string |
Timestamp: Returns the date and time the tag was added. |
upn string |
Upn: Returns the User Principal Name of the user who added the tag. |
TagProperty_STATUS_ARM
(Appears on:LegalHoldProperties_STATUS_ARM)
A tag of the LegalHold of a blob container.
Field | Description |
---|---|
objectIdentifier string |
ObjectIdentifier: Returns the Object ID of the user who added the tag. |
tag string |
Tag: The tag value. |
tenantId string |
TenantId: Returns the Tenant ID that issued the token for the user who added the tag. |
timestamp string |
Timestamp: Returns the date and time the tag was added. |
upn string |
Upn: Returns the User Principal Name of the user who added the tag. |
Tier
(string
alias)
(Appears on:Sku)
The SKU tier. This is based on the SKU name.
Value | Description |
---|---|
"Premium" |
|
"Standard" |
Tier_ARM
(string
alias)
(Appears on:Sku_ARM)
The SKU tier. This is based on the SKU name.
Value | Description |
---|---|
"Premium" |
|
"Standard" |
Tier_STATUS
(string
alias)
(Appears on:Sku_STATUS)
The SKU tier. This is based on the SKU name.
Value | Description |
---|---|
"Premium" |
|
"Standard" |
Tier_STATUS_ARM
(string
alias)
(Appears on:Sku_STATUS_ARM)
The SKU tier. This is based on the SKU name.
Value | Description |
---|---|
"Premium" |
|
"Standard" |
UpdateHistoryProperty_STATUS
(Appears on:ImmutabilityPolicyProperties_STATUS)
An update history of the ImmutabilityPolicy of a blob container.
Field | Description |
---|---|
allowProtectedAppendWrites bool |
AllowProtectedAppendWrites: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. |
allowProtectedAppendWritesAll bool |
AllowProtectedAppendWritesAll: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
objectIdentifier string |
ObjectIdentifier: Returns the Object ID of the user who updated the ImmutabilityPolicy. |
tenantId string |
TenantId: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. |
timestamp string |
Timestamp: Returns the date and time the ImmutabilityPolicy was updated. |
update UpdateHistoryProperty_Update_STATUS |
Update: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. |
upn string |
Upn: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. |
UpdateHistoryProperty_STATUS_ARM
(Appears on:ImmutabilityPolicyProperties_STATUS_ARM)
An update history of the ImmutabilityPolicy of a blob container.
Field | Description |
---|---|
allowProtectedAppendWrites bool |
AllowProtectedAppendWrites: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. |
allowProtectedAppendWritesAll bool |
AllowProtectedAppendWritesAll: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both ‘Append and Bock Blobs’ while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The ‘allowProtectedAppendWrites’ and ‘allowProtectedAppendWritesAll’ properties are mutually exclusive. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
objectIdentifier string |
ObjectIdentifier: Returns the Object ID of the user who updated the ImmutabilityPolicy. |
tenantId string |
TenantId: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. |
timestamp string |
Timestamp: Returns the date and time the ImmutabilityPolicy was updated. |
update UpdateHistoryProperty_Update_STATUS_ARM |
Update: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. |
upn string |
Upn: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. |
UpdateHistoryProperty_Update_STATUS
(string
alias)
(Appears on:UpdateHistoryProperty_STATUS)
Value | Description |
---|---|
"extend" |
|
"lock" |
|
"put" |
UpdateHistoryProperty_Update_STATUS_ARM
(string
alias)
(Appears on:UpdateHistoryProperty_STATUS_ARM)
Value | Description |
---|---|
"extend" |
|
"lock" |
|
"put" |
UserAssignedIdentityDetails
(Appears on:Identity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |
UserAssignedIdentityDetails_ARM
(Appears on:Identity_ARM)
Information about the user assigned identity for the resource
UserAssignedIdentity_STATUS
(Appears on:Identity_STATUS)
UserAssignedIdentity for the resource.
Field | Description |
---|---|
clientId string |
ClientId: The client ID of the identity. |
principalId string |
PrincipalId: The principal ID of the identity. |
UserAssignedIdentity_STATUS_ARM
(Appears on:Identity_STATUS_ARM)
UserAssignedIdentity for the resource.
Field | Description |
---|---|
clientId string |
ClientId: The client ID of the identity. |
principalId string |
PrincipalId: The principal ID of the identity. |
VirtualNetworkRule
(Appears on:NetworkRuleSet)
Virtual Network rule.
Field | Description |
---|---|
action VirtualNetworkRule_Action |
Action: The action of virtual network rule. |
reference genruntime.ResourceReference |
Reference: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.p> |
state VirtualNetworkRule_State |
State: Gets the state of virtual network rule. |
VirtualNetworkRule_ARM
(Appears on:NetworkRuleSet_ARM)
Virtual Network rule.
Field | Description |
---|---|
action VirtualNetworkRule_Action_ARM |
Action: The action of virtual network rule. |
id string |
|
state VirtualNetworkRule_State_ARM |
State: Gets the state of virtual network rule. |
VirtualNetworkRule_Action
(string
alias)
(Appears on:VirtualNetworkRule)
Value | Description |
---|---|
"Allow" |
VirtualNetworkRule_Action_ARM
(string
alias)
(Appears on:VirtualNetworkRule_ARM)
Value | Description |
---|---|
"Allow" |
VirtualNetworkRule_Action_STATUS
(string
alias)
(Appears on:VirtualNetworkRule_STATUS)
Value | Description |
---|---|
"Allow" |
VirtualNetworkRule_Action_STATUS_ARM
(string
alias)
(Appears on:VirtualNetworkRule_STATUS_ARM)
Value | Description |
---|---|
"Allow" |
VirtualNetworkRule_STATUS
(Appears on:NetworkRuleSet_STATUS)
Virtual Network rule.
Field | Description |
---|---|
action VirtualNetworkRule_Action_STATUS |
Action: The action of virtual network rule. |
id string |
Id: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.p> |
state VirtualNetworkRule_State_STATUS |
State: Gets the state of virtual network rule. |
VirtualNetworkRule_STATUS_ARM
(Appears on:NetworkRuleSet_STATUS_ARM)
Virtual Network rule.
Field | Description |
---|---|
action VirtualNetworkRule_Action_STATUS_ARM |
Action: The action of virtual network rule. |
id string |
Id: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.p> |
state VirtualNetworkRule_State_STATUS_ARM |
State: Gets the state of virtual network rule. |
VirtualNetworkRule_State
(string
alias)
(Appears on:VirtualNetworkRule)
Value | Description |
---|---|
"Deprovisioning" |
|
"Failed" |
|
"NetworkSourceDeleted" |
|
"Provisioning" |
|
"Succeeded" |
VirtualNetworkRule_State_ARM
(string
alias)
(Appears on:VirtualNetworkRule_ARM)
Value | Description |
---|---|
"Deprovisioning" |
|
"Failed" |
|
"NetworkSourceDeleted" |
|
"Provisioning" |
|
"Succeeded" |
VirtualNetworkRule_State_STATUS
(string
alias)
(Appears on:VirtualNetworkRule_STATUS)
Value | Description |
---|---|
"Deprovisioning" |
|
"Failed" |
|
"NetworkSourceDeleted" |
|
"Provisioning" |
|
"Succeeded" |
VirtualNetworkRule_State_STATUS_ARM
(string
alias)
(Appears on:VirtualNetworkRule_STATUS_ARM)
Value | Description |
---|---|
"Deprovisioning" |
|
"Failed" |
|
"NetworkSourceDeleted" |
|
"Provisioning" |
|
"Succeeded" |