storage.azure.com/v1beta20210401
storage.azure.com/v1beta20210401
Package v1beta20210401 contains API Schema definitions for the storage v1beta20210401 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-04-01" |
ActiveDirectoryProperties
(Appears on:AzureFilesIdentityBasedAuthentication)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ActiveDirectoryProperties
Field | Description |
---|---|
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. |
ActiveDirectoryPropertiesARM
(Appears on:AzureFilesIdentityBasedAuthenticationARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ActiveDirectoryProperties
Field | Description |
---|---|
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. |
ActiveDirectoryProperties_Status
(Appears on:AzureFilesIdentityBasedAuthentication_Status)
Field | Description |
---|---|
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. |
ActiveDirectoryProperties_StatusARM
(Appears on:AzureFilesIdentityBasedAuthentication_StatusARM)
Field | Description |
---|---|
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. |
AzureFilesIdentityBasedAuthentication
(Appears on:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/AzureFilesIdentityBasedAuthentication
Field | Description |
---|---|
activeDirectoryProperties ActiveDirectoryProperties |
ActiveDirectoryProperties: Settings properties for Active Directory (AD). |
defaultSharePermission AzureFilesIdentityBasedAuthenticationDefaultSharePermission |
DefaultSharePermission: Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
directoryServiceOptions AzureFilesIdentityBasedAuthenticationDirectoryServiceOptions |
DirectoryServiceOptions: Indicates the directory service used. |
AzureFilesIdentityBasedAuthenticationARM
(Appears on:StorageAccountPropertiesCreateParametersARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/AzureFilesIdentityBasedAuthentication
Field | Description |
---|---|
activeDirectoryProperties ActiveDirectoryPropertiesARM |
ActiveDirectoryProperties: Settings properties for Active Directory (AD). |
defaultSharePermission AzureFilesIdentityBasedAuthenticationDefaultSharePermission |
DefaultSharePermission: Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
directoryServiceOptions AzureFilesIdentityBasedAuthenticationDirectoryServiceOptions |
DirectoryServiceOptions: Indicates the directory service used. |
AzureFilesIdentityBasedAuthenticationDefaultSharePermission
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication, AzureFilesIdentityBasedAuthenticationARM)
Value | Description |
---|---|
"None" |
|
"StorageFileDataSmbShareContributor" |
|
"StorageFileDataSmbShareElevatedContributor" |
|
"StorageFileDataSmbShareOwner" |
|
"StorageFileDataSmbShareReader" |
AzureFilesIdentityBasedAuthenticationDirectoryServiceOptions
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication, AzureFilesIdentityBasedAuthenticationARM)
Value | Description |
---|---|
"AADDS" |
|
"AD" |
|
"None" |
AzureFilesIdentityBasedAuthenticationStatusDefaultSharePermission
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication_Status, AzureFilesIdentityBasedAuthentication_StatusARM)
Value | Description |
---|---|
"None" |
|
"StorageFileDataSmbShareContributor" |
|
"StorageFileDataSmbShareElevatedContributor" |
|
"StorageFileDataSmbShareOwner" |
|
"StorageFileDataSmbShareReader" |
AzureFilesIdentityBasedAuthenticationStatusDirectoryServiceOptions
(string
alias)
(Appears on:AzureFilesIdentityBasedAuthentication_Status, AzureFilesIdentityBasedAuthentication_StatusARM)
Value | Description |
---|---|
"AADDS" |
|
"AD" |
|
"None" |
AzureFilesIdentityBasedAuthentication_Status
(Appears on:StorageAccount_Status)
Field | Description |
---|---|
activeDirectoryProperties ActiveDirectoryProperties_Status |
ActiveDirectoryProperties: Required if choose AD. |
defaultSharePermission AzureFilesIdentityBasedAuthenticationStatusDefaultSharePermission |
DefaultSharePermission: Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
directoryServiceOptions AzureFilesIdentityBasedAuthenticationStatusDirectoryServiceOptions |
DirectoryServiceOptions: Indicates the directory service used. |
AzureFilesIdentityBasedAuthentication_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
Field | Description |
---|---|
activeDirectoryProperties ActiveDirectoryProperties_StatusARM |
ActiveDirectoryProperties: Required if choose AD. |
defaultSharePermission AzureFilesIdentityBasedAuthenticationStatusDefaultSharePermission |
DefaultSharePermission: Default share permission for users using Kerberos authentication if RBAC role is not assigned. |
directoryServiceOptions AzureFilesIdentityBasedAuthenticationStatusDirectoryServiceOptions |
DirectoryServiceOptions: Indicates the directory service used. |
BlobContainer_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. |
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 ContainerPropertiesStatusLeaseDuration |
LeaseDuration: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. |
leaseState ContainerPropertiesStatusLeaseState |
LeaseState: Lease state of the container. |
leaseStatus ContainerPropertiesStatusLeaseStatus |
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 ContainerPropertiesStatusPublicAccess |
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. |
BlobContainer_StatusARM
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_StatusARM |
Properties: Properties of the blob container. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
BlobRestoreParameters_Status
(Appears on:BlobRestoreStatus_Status)
Field | Description |
---|---|
blobRanges []BlobRestoreRange_Status |
BlobRanges: Blob ranges to restore. |
timeToRestore string |
TimeToRestore: Restore blob to the specified time. |
BlobRestoreParameters_StatusARM
(Appears on:BlobRestoreStatus_StatusARM)
Field | Description |
---|---|
blobRanges []BlobRestoreRange_StatusARM |
BlobRanges: Blob ranges to restore. |
timeToRestore string |
TimeToRestore: Restore blob to the specified time. |
BlobRestoreRange_Status
(Appears on:BlobRestoreParameters_Status)
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_StatusARM
(Appears on:BlobRestoreParameters_StatusARM)
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. |
BlobRestoreStatusStatusStatus
(string
alias)
(Appears on:BlobRestoreStatus_Status, BlobRestoreStatus_StatusARM)
Value | Description |
---|---|
"Complete" |
|
"Failed" |
|
"InProgress" |
BlobRestoreStatus_Status
(Appears on:StorageAccount_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 BlobRestoreStatusStatusStatus |
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_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
Field | Description |
---|---|
failureReason string |
FailureReason: Failure reason when blob restore is failed. |
parameters BlobRestoreParameters_StatusARM |
Parameters: Blob restore request parameters. |
restoreId string |
RestoreId: Id for tracking blob restore request. |
status BlobRestoreStatusStatusStatus |
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. |
BlobServicePropertiesPropertiesARM
(Appears on:StorageAccountsBlobServices_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/BlobServicePropertiesProperties
Field | Description |
---|---|
automaticSnapshotPolicyEnabled bool |
AutomaticSnapshotPolicyEnabled: Deprecated in favor of isVersioningEnabled property. |
changeFeed ChangeFeedARM |
ChangeFeed: The blob service properties for change feed events. |
containerDeleteRetentionPolicy DeleteRetentionPolicyARM |
ContainerDeleteRetentionPolicy: The service properties for soft delete. |
cors CorsRulesARM |
Cors: Sets the CORS rules. You can include up to five CorsRule elements in the request. |
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 DeleteRetentionPolicyARM |
DeleteRetentionPolicy: The service properties for soft delete. |
isVersioningEnabled bool |
IsVersioningEnabled: Versioning is enabled if set to true. |
lastAccessTimeTrackingPolicy LastAccessTimeTrackingPolicyARM |
LastAccessTimeTrackingPolicy: The blob service properties for Last access time based tracking policy. |
restorePolicy RestorePolicyPropertiesARM |
RestorePolicy: The blob service properties for blob restore policy |
BlobServiceProperties_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” |
BlobServiceProperties_StatusARM
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 BlobServiceProperties_Status_PropertiesARM |
Properties: The properties of a storage account’s Blob service. |
sku Sku_StatusARM |
Sku: Sku name and tier. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
BlobServiceProperties_Status_PropertiesARM
(Appears on:BlobServiceProperties_StatusARM)
Field | Description |
---|---|
automaticSnapshotPolicyEnabled bool |
AutomaticSnapshotPolicyEnabled: Deprecated in favor of isVersioningEnabled property. |
changeFeed ChangeFeed_StatusARM |
ChangeFeed: The blob service properties for change feed events. |
containerDeleteRetentionPolicy DeleteRetentionPolicy_StatusARM |
ContainerDeleteRetentionPolicy: The blob service properties for container soft delete. |
cors CorsRules_StatusARM |
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_StatusARM |
DeleteRetentionPolicy: The blob service properties for blob soft delete. |
isVersioningEnabled bool |
IsVersioningEnabled: Versioning is enabled if set to true. |
lastAccessTimeTrackingPolicy LastAccessTimeTrackingPolicy_StatusARM |
LastAccessTimeTrackingPolicy: The blob service property to configure last access time based tracking policy. |
restorePolicy RestorePolicyProperties_StatusARM |
RestorePolicy: The blob service properties for blob restore policy. |
ChangeFeed
(Appears on:StorageAccountsBlobServices_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ChangeFeed
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. |
ChangeFeedARM
(Appears on:BlobServicePropertiesPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ChangeFeed
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:BlobServiceProperties_Status)
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_StatusARM
(Appears on:BlobServiceProperties_Status_PropertiesARM)
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. |
ContainerPropertiesARM
(Appears on:StorageAccountsBlobServicesContainers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ContainerProperties
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. |
immutableStorageWithVersioning ImmutableStorageWithVersioningARM |
ImmutableStorageWithVersioning: Object level immutability properties of the container. |
metadata map[string]string |
Metadata: A name-value pair to associate with the container as metadata. |
publicAccess ContainerPropertiesPublicAccess |
PublicAccess: Specifies whether data in the container may be accessed publicly and the level of access. |
ContainerPropertiesPublicAccess
(string
alias)
(Appears on:ContainerPropertiesARM, StorageAccountsBlobServicesContainers_Spec)
Value | Description |
---|---|
"Blob" |
|
"Container" |
|
"None" |
ContainerPropertiesStatusLeaseDuration
(string
alias)
(Appears on:BlobContainer_Status, ContainerProperties_StatusARM)
Value | Description |
---|---|
"Fixed" |
|
"Infinite" |
ContainerPropertiesStatusLeaseState
(string
alias)
(Appears on:BlobContainer_Status, ContainerProperties_StatusARM)
Value | Description |
---|---|
"Available" |
|
"Breaking" |
|
"Broken" |
|
"Expired" |
|
"Leased" |
ContainerPropertiesStatusLeaseStatus
(string
alias)
(Appears on:BlobContainer_Status, ContainerProperties_StatusARM)
Value | Description |
---|---|
"Locked" |
|
"Unlocked" |
ContainerPropertiesStatusPublicAccess
(string
alias)
(Appears on:BlobContainer_Status, ContainerProperties_StatusARM)
Value | Description |
---|---|
"Blob" |
|
"Container" |
|
"None" |
ContainerProperties_StatusARM
(Appears on:BlobContainer_StatusARM)
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. |
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_StatusARM |
ImmutabilityPolicy: The ImmutabilityPolicy property of the container. |
immutableStorageWithVersioning ImmutableStorageWithVersioning_StatusARM |
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 ContainerPropertiesStatusLeaseDuration |
LeaseDuration: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. |
leaseState ContainerPropertiesStatusLeaseState |
LeaseState: Lease state of the container. |
leaseStatus ContainerPropertiesStatusLeaseStatus |
LeaseStatus: The lease status of the container. |
legalHold LegalHoldProperties_StatusARM |
LegalHold: The LegalHold property of the container. |
metadata map[string]string |
Metadata: A name-value pair to associate with the container as metadata. |
publicAccess ContainerPropertiesStatusPublicAccess |
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)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/CorsRule
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 []CorsRuleAllowedMethods |
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. |
CorsRuleARM
(Appears on:CorsRulesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/CorsRule
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 []CorsRuleAllowedMethods |
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. |
CorsRuleAllowedMethods
(string
alias)
(Appears on:CorsRule, CorsRuleARM)
Value | Description |
---|---|
"DELETE" |
|
"GET" |
|
"HEAD" |
|
"MERGE" |
|
"OPTIONS" |
|
"POST" |
|
"PUT" |
CorsRuleStatusAllowedMethods
(string
alias)
(Appears on:CorsRule_Status, CorsRule_StatusARM)
Value | Description |
---|---|
"DELETE" |
|
"GET" |
|
"HEAD" |
|
"MERGE" |
|
"OPTIONS" |
|
"POST" |
|
"PUT" |
CorsRule_Status
(Appears on:CorsRules_Status)
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 []CorsRuleStatusAllowedMethods |
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_StatusARM
(Appears on:CorsRules_StatusARM)
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 []CorsRuleStatusAllowedMethods |
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:StorageAccountsBlobServices_Spec, StorageAccountsQueueServices_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/CorsRules
Field | Description |
---|---|
corsRules []CorsRule |
CorsRules: The List of CORS rules. You can include up to five CorsRule elements in the request. |
CorsRulesARM
(Appears on:BlobServicePropertiesPropertiesARM, QueueServicePropertiesPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/CorsRules
Field | Description |
---|---|
corsRules []CorsRuleARM |
CorsRules: The List of CORS rules. You can include up to five CorsRule elements in the request. |
CorsRules_Status
(Appears on:BlobServiceProperties_Status, QueueServiceProperties_Status)
Field | Description |
---|---|
corsRules []CorsRule_Status |
CorsRules: The List of CORS rules. You can include up to five CorsRule elements in the request. |
CorsRules_StatusARM
(Appears on:BlobServiceProperties_Status_PropertiesARM, QueueServiceProperties_Status_PropertiesARM)
Field | Description |
---|---|
corsRules []CorsRule_StatusARM |
CorsRules: The List of CORS rules. You can include up to five CorsRule elements in the request. |
CustomDomain
(Appears on:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/CustomDomain
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. |
CustomDomainARM
(Appears on:StorageAccountPropertiesCreateParametersARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/CustomDomain
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)
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_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
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)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/DateAfterCreation
Field | Description |
---|---|
daysAfterCreationGreaterThan int |
DaysAfterCreationGreaterThan: Value indicating the age in days after creation |
DateAfterCreationARM
(Appears on:ManagementPolicySnapShotARM, ManagementPolicyVersionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/DateAfterCreation
Field | Description |
---|---|
daysAfterCreationGreaterThan int |
DaysAfterCreationGreaterThan: Value indicating the age in days after creation |
DateAfterCreation_Status
(Appears on:ManagementPolicySnapShot_Status, ManagementPolicyVersion_Status)
Field | Description |
---|---|
daysAfterCreationGreaterThan float64 |
DaysAfterCreationGreaterThan: Value indicating the age in days after creation |
DateAfterCreation_StatusARM
(Appears on:ManagementPolicySnapShot_StatusARM, ManagementPolicyVersion_StatusARM)
Field | Description |
---|---|
daysAfterCreationGreaterThan float64 |
DaysAfterCreationGreaterThan: Value indicating the age in days after creation |
DateAfterModification
(Appears on:ManagementPolicyBaseBlob)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/DateAfterModification
Field | Description |
---|---|
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 |
daysAfterModificationGreaterThan int |
DaysAfterModificationGreaterThan: Value indicating the age in days after last modification |
DateAfterModificationARM
(Appears on:ManagementPolicyBaseBlobARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/DateAfterModification
Field | Description |
---|---|
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 |
daysAfterModificationGreaterThan int |
DaysAfterModificationGreaterThan: Value indicating the age in days after last modification |
DateAfterModification_Status
(Appears on:ManagementPolicyBaseBlob_Status)
Field | Description |
---|---|
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 |
daysAfterModificationGreaterThan float64 |
DaysAfterModificationGreaterThan: Value indicating the age in days after last modification |
DateAfterModification_StatusARM
(Appears on:ManagementPolicyBaseBlob_StatusARM)
Field | Description |
---|---|
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 |
daysAfterModificationGreaterThan float64 |
DaysAfterModificationGreaterThan: Value indicating the age in days after last modification |
DeleteRetentionPolicy
(Appears on:StorageAccountsBlobServices_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/DeleteRetentionPolicy
Field | Description |
---|---|
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. |
DeleteRetentionPolicyARM
(Appears on:BlobServicePropertiesPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/DeleteRetentionPolicy
Field | Description |
---|---|
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:BlobServiceProperties_Status)
Field | Description |
---|---|
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_StatusARM
(Appears on:BlobServiceProperties_Status_PropertiesARM)
Field | Description |
---|---|
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:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/Encryption
Field | Description |
---|---|
identity EncryptionIdentity |
Identity: Encryption identity for the storage account. |
keySource EncryptionKeySource |
KeySource: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. |
keyvaultproperties KeyVaultProperties |
Keyvaultproperties: Properties of 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: A list of services that support encryption. |
EncryptionARM
(Appears on:StorageAccountPropertiesCreateParametersARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/Encryption
Field | Description |
---|---|
identity EncryptionIdentityARM |
Identity: Encryption identity for the storage account. |
keySource EncryptionKeySource |
KeySource: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault. |
keyvaultproperties KeyVaultPropertiesARM |
Keyvaultproperties: Properties of 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 EncryptionServicesARM |
Services: A list of services that support encryption. |
EncryptionIdentity
(Appears on:Encryption)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/EncryptionIdentity
Field | Description |
---|---|
userAssignedIdentityReference genruntime.ResourceReference |
UserAssignedIdentityReference: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. |
EncryptionIdentityARM
(Appears on:EncryptionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/EncryptionIdentity
Field | Description |
---|---|
userAssignedIdentity string |
EncryptionIdentity_Status
(Appears on:Encryption_Status)
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentity: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. |
EncryptionIdentity_StatusARM
(Appears on:Encryption_StatusARM)
Field | Description |
---|---|
userAssignedIdentity string |
UserAssignedIdentity: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. |
EncryptionKeySource
(string
alias)
(Appears on:Encryption, EncryptionARM)
Value | Description |
---|---|
"Microsoft.Keyvault" |
|
"Microsoft.Storage" |
EncryptionService
(Appears on:EncryptionServices)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/EncryptionService
Field | Description |
---|---|
enabled bool |
Enabled: A boolean indicating whether or not the service encrypts the data as it is stored. |
keyType EncryptionServiceKeyType |
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. |
EncryptionServiceARM
(Appears on:EncryptionServicesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/EncryptionService
Field | Description |
---|---|
enabled bool |
Enabled: A boolean indicating whether or not the service encrypts the data as it is stored. |
keyType EncryptionServiceKeyType |
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. |
EncryptionServiceKeyType
(string
alias)
(Appears on:EncryptionService, EncryptionServiceARM)
Value | Description |
---|---|
"Account" |
|
"Service" |
EncryptionServiceStatusKeyType
(string
alias)
(Appears on:EncryptionService_Status, EncryptionService_StatusARM)
Value | Description |
---|---|
"Account" |
|
"Service" |
EncryptionService_Status
(Appears on:EncryptionServices_Status)
Field | Description |
---|---|
enabled bool |
Enabled: A boolean indicating whether or not the service encrypts the data as it is stored. |
keyType EncryptionServiceStatusKeyType |
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. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. |
EncryptionService_StatusARM
(Appears on:EncryptionServices_StatusARM)
Field | Description |
---|---|
enabled bool |
Enabled: A boolean indicating whether or not the service encrypts the data as it is stored. |
keyType EncryptionServiceStatusKeyType |
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. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate. |
EncryptionServices
(Appears on:Encryption)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/EncryptionServices
Field | Description |
---|---|
blob EncryptionService |
Blob: A service that allows server-side encryption to be used. |
file EncryptionService |
File: A service that allows server-side encryption to be used. |
queue EncryptionService |
Queue: A service that allows server-side encryption to be used. |
table EncryptionService |
Table: A service that allows server-side encryption to be used. |
EncryptionServicesARM
(Appears on:EncryptionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/EncryptionServices
Field | Description |
---|---|
blob EncryptionServiceARM |
Blob: A service that allows server-side encryption to be used. |
file EncryptionServiceARM |
File: A service that allows server-side encryption to be used. |
queue EncryptionServiceARM |
Queue: A service that allows server-side encryption to be used. |
table EncryptionServiceARM |
Table: A service that allows server-side encryption to be used. |
EncryptionServices_Status
(Appears on:Encryption_Status)
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_StatusARM
(Appears on:Encryption_StatusARM)
Field | Description |
---|---|
blob EncryptionService_StatusARM |
Blob: The encryption function of the blob storage service. |
file EncryptionService_StatusARM |
File: The encryption function of the file storage service. |
queue EncryptionService_StatusARM |
Queue: The encryption function of the queue storage service. |
table EncryptionService_StatusARM |
Table: The encryption function of the table storage service. |
EncryptionStatusKeySource
(string
alias)
(Appears on:Encryption_Status, Encryption_StatusARM)
Value | Description |
---|---|
"Microsoft.Keyvault" |
|
"Microsoft.Storage" |
Encryption_Status
(Appears on:StorageAccount_Status)
Field | Description |
---|---|
identity EncryptionIdentity_Status |
Identity: The identity to be used with service-side encryption at rest. |
keySource EncryptionStatusKeySource |
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_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
Field | Description |
---|---|
identity EncryptionIdentity_StatusARM |
Identity: The identity to be used with service-side encryption at rest. |
keySource EncryptionStatusKeySource |
KeySource: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault |
keyvaultproperties KeyVaultProperties_StatusARM |
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_StatusARM |
Services: List of services which support encryption. |
Endpoints_Status
(Appears on:StorageAccount_Status)
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_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
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_StatusARM |
InternetEndpoints: Gets the internet routing storage endpoints |
microsoftEndpoints StorageAccountMicrosoftEndpoints_StatusARM |
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:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ExtendedLocation
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType |
Type: The type of the extended location. |
ExtendedLocationARM
(Appears on:StorageAccounts_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ExtendedLocation
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, ExtendedLocationARM)
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocationType_Status
(string
alias)
(Appears on:ExtendedLocation_Status, ExtendedLocation_StatusARM)
Value | Description |
---|---|
"EdgeZone" |
ExtendedLocation_Status
(Appears on:StorageAccount_Status)
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_Status |
Type: The type of the extended location. |
ExtendedLocation_StatusARM
(Appears on:StorageAccount_StatusARM)
Field | Description |
---|---|
name string |
Name: The name of the extended location. |
type ExtendedLocationType_Status |
Type: The type of the extended location. |
GeoReplicationStatsStatusStatus
(string
alias)
(Appears on:GeoReplicationStats_Status, GeoReplicationStats_StatusARM)
Value | Description |
---|---|
"Bootstrap" |
|
"Live" |
|
"Unavailable" |
GeoReplicationStats_Status
(Appears on:StorageAccount_Status)
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 GeoReplicationStatsStatusStatus |
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_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
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 GeoReplicationStatsStatusStatus |
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. |
IPRule
(Appears on:NetworkRuleSet)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/IPRule
Field | Description |
---|---|
action IPRuleAction |
Action: The action of IP ACL rule. |
value string |
Value: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
IPRuleARM
(Appears on:NetworkRuleSetARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/IPRule
Field | Description |
---|---|
action IPRuleAction |
Action: The action of IP ACL rule. |
value string |
Value: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. |
IPRuleAction
(string
alias)
(Appears on:IPRule, IPRuleARM)
Value | Description |
---|---|
"Allow" |
IPRuleStatusAction
(string
alias)
(Appears on:IPRule_Status, IPRule_StatusARM)
Value | Description |
---|---|
"Allow" |
IPRule_Status
(Appears on:NetworkRuleSet_Status)
Field | Description |
---|---|
action IPRuleStatusAction |
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_StatusARM
(Appears on:NetworkRuleSet_StatusARM)
Field | Description |
---|---|
action IPRuleStatusAction |
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:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/Identity
Field | Description |
---|---|
type IdentityType |
Type: The identity type. |
IdentityARM
(Appears on:StorageAccounts_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/Identity
Field | Description |
---|---|
type IdentityType |
Type: The identity type. |
IdentityStatusType
(string
alias)
(Appears on:Identity_Status, Identity_StatusARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
IdentityType
(string
alias)
(Appears on:Identity, IdentityARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
Identity_Status
(Appears on:StorageAccount_Status)
Field | Description |
---|---|
principalId string |
PrincipalId: The principal ID of resource identity. |
tenantId string |
TenantId: The tenant ID of resource. |
type IdentityStatusType |
Type: The identity type. |
userAssignedIdentities map[string]./api/storage/v1beta20210401.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_StatusARM
(Appears on:StorageAccount_StatusARM)
Field | Description |
---|---|
principalId string |
PrincipalId: The principal ID of resource identity. |
tenantId string |
TenantId: The tenant ID of resource. |
type IdentityStatusType |
Type: The identity type. |
userAssignedIdentities map[string]./api/storage/v1beta20210401.UserAssignedIdentity_StatusARM |
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. |
ImmutabilityPolicyProperties_Status
(Appears on:BlobContainer_Status)
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 |
etag string |
Etag: ImmutabilityPolicy Etag. |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
state ImmutabilityPolicyPropertyStatusState |
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_StatusARM
(Appears on:ContainerProperties_StatusARM)
Field | Description |
---|---|
etag string |
Etag: ImmutabilityPolicy Etag. |
properties ImmutabilityPolicyProperty_StatusARM |
Properties: The properties of an ImmutabilityPolicy of a blob container. |
updateHistory []UpdateHistoryProperty_StatusARM |
UpdateHistory: The ImmutabilityPolicy update history of the blob container. |
ImmutabilityPolicyPropertyStatusState
(string
alias)
(Appears on:ImmutabilityPolicyProperties_Status, ImmutabilityPolicyProperty_StatusARM)
Value | Description |
---|---|
"Locked" |
|
"Unlocked" |
ImmutabilityPolicyProperty_StatusARM
(Appears on:ImmutabilityPolicyProperties_StatusARM)
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 |
immutabilityPeriodSinceCreationInDays int |
ImmutabilityPeriodSinceCreationInDays: The immutability period for the blobs in the container since the policy creation, in days. |
state ImmutabilityPolicyPropertyStatusState |
State: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. |
ImmutableStorageWithVersioning
(Appears on:StorageAccountsBlobServicesContainers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ImmutableStorageWithVersioning
Field | Description |
---|---|
enabled bool |
Enabled: This is an immutable property, when set to true it enables object level immutability at the container level. |
ImmutableStorageWithVersioningARM
(Appears on:ContainerPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ImmutableStorageWithVersioning
Field | Description |
---|---|
enabled bool |
Enabled: This is an immutable property, when set to true it enables object level immutability at the container level. |
ImmutableStorageWithVersioningStatusMigrationState
(string
alias)
(Appears on:ImmutableStorageWithVersioning_Status, ImmutableStorageWithVersioning_StatusARM)
Value | Description |
---|---|
"Completed" |
|
"InProgress" |
ImmutableStorageWithVersioning_Status
(Appears on:BlobContainer_Status)
Field | Description |
---|---|
enabled bool |
Enabled: This is an immutable property, when set to true it enables object level immutability at the container level. |
migrationState ImmutableStorageWithVersioningStatusMigrationState |
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_StatusARM
(Appears on:ContainerProperties_StatusARM)
Field | Description |
---|---|
enabled bool |
Enabled: This is an immutable property, when set to true it enables object level immutability at the container level. |
migrationState ImmutableStorageWithVersioningStatusMigrationState |
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)
Field | Description |
---|---|
key1 string |
|
key2 string |
KeyCreationTime_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
Field | Description |
---|---|
key1 string |
|
key2 string |
KeyPolicy
(Appears on:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/KeyPolicy
Field | Description |
---|---|
keyExpirationPeriodInDays int |
KeyExpirationPeriodInDays: The key expiration period in days. |
KeyPolicyARM
(Appears on:StorageAccountPropertiesCreateParametersARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/KeyPolicy
Field | Description |
---|---|
keyExpirationPeriodInDays int |
KeyExpirationPeriodInDays: The key expiration period in days. |
KeyPolicy_Status
(Appears on:StorageAccount_Status)
Field | Description |
---|---|
keyExpirationPeriodInDays int |
KeyExpirationPeriodInDays: The key expiration period in days. |
KeyPolicy_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
Field | Description |
---|---|
keyExpirationPeriodInDays int |
KeyExpirationPeriodInDays: The key expiration period in days. |
KeyVaultProperties
(Appears on:Encryption)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/KeyVaultProperties
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. |
KeyVaultPropertiesARM
(Appears on:EncryptionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/KeyVaultProperties
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)
Field | Description |
---|---|
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_StatusARM
(Appears on:Encryption_StatusARM)
Field | Description |
---|---|
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:StorageAccountsBlobServices_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/LastAccessTimeTrackingPolicy
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 LastAccessTimeTrackingPolicyName |
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 |
LastAccessTimeTrackingPolicyARM
(Appears on:BlobServicePropertiesPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/LastAccessTimeTrackingPolicy
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 LastAccessTimeTrackingPolicyName |
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 |
LastAccessTimeTrackingPolicyName
(string
alias)
(Appears on:LastAccessTimeTrackingPolicy, LastAccessTimeTrackingPolicyARM)
Value | Description |
---|---|
"AccessTimeTracking" |
LastAccessTimeTrackingPolicyStatusName
(string
alias)
(Appears on:LastAccessTimeTrackingPolicy_Status, LastAccessTimeTrackingPolicy_StatusARM)
Value | Description |
---|---|
"AccessTimeTracking" |
LastAccessTimeTrackingPolicy_Status
(Appears on:BlobServiceProperties_Status)
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 LastAccessTimeTrackingPolicyStatusName |
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_StatusARM
(Appears on:BlobServiceProperties_Status_PropertiesARM)
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 LastAccessTimeTrackingPolicyStatusName |
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:BlobContainer_Status)
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. |
tags []TagProperty_Status |
Tags: The list of LegalHold tags of a blob container. |
LegalHoldProperties_StatusARM
(Appears on:ContainerProperties_StatusARM)
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. |
tags []TagProperty_StatusARM |
Tags: The list of LegalHold tags of a blob container. |
ManagementPolicyAction
(Appears on:ManagementPolicyDefinition)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyAction
Field | Description |
---|---|
baseBlob ManagementPolicyBaseBlob |
BaseBlob: Management policy action for base blob. |
snapshot ManagementPolicySnapShot |
Snapshot: Management policy action for snapshot. |
version ManagementPolicyVersion |
Version: Management policy action for blob version. |
ManagementPolicyActionARM
(Appears on:ManagementPolicyDefinitionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyAction
Field | Description |
---|---|
baseBlob ManagementPolicyBaseBlobARM |
BaseBlob: Management policy action for base blob. |
snapshot ManagementPolicySnapShotARM |
Snapshot: Management policy action for snapshot. |
version ManagementPolicyVersionARM |
Version: Management policy action for blob version. |
ManagementPolicyAction_Status
(Appears on:ManagementPolicyDefinition_Status)
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_StatusARM
(Appears on:ManagementPolicyDefinition_StatusARM)
Field | Description |
---|---|
baseBlob ManagementPolicyBaseBlob_StatusARM |
BaseBlob: The management policy action for base blob |
snapshot ManagementPolicySnapShot_StatusARM |
Snapshot: The management policy action for snapshot |
version ManagementPolicyVersion_StatusARM |
Version: The management policy action for version |
ManagementPolicyBaseBlob
(Appears on:ManagementPolicyAction)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyBaseBlob
Field | Description |
---|---|
delete DateAfterModification |
Delete: Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. |
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: Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. |
tierToCool DateAfterModification |
TierToCool: Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. |
ManagementPolicyBaseBlobARM
(Appears on:ManagementPolicyActionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyBaseBlob
Field | Description |
---|---|
delete DateAfterModificationARM |
Delete: Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. |
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 DateAfterModificationARM |
TierToArchive: Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. |
tierToCool DateAfterModificationARM |
TierToCool: Object to define the number of days after object last modification Or last access. Properties daysAfterModificationGreaterThan and daysAfterLastAccessTimeGreaterThan are mutually exclusive. |
ManagementPolicyBaseBlob_Status
(Appears on:ManagementPolicyAction_Status)
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. Support blobs currently at Hot or Cool tier |
tierToCool DateAfterModification_Status |
TierToCool: The function to tier blobs to cool storage. Support blobs currently at Hot tier |
ManagementPolicyBaseBlob_StatusARM
(Appears on:ManagementPolicyAction_StatusARM)
Field | Description |
---|---|
delete DateAfterModification_StatusARM |
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_StatusARM |
TierToArchive: The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier |
tierToCool DateAfterModification_StatusARM |
TierToCool: The function to tier blobs to cool storage. Support blobs currently at Hot tier |
ManagementPolicyDefinition
(Appears on:ManagementPolicyRule)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyDefinition
Field | Description |
---|---|
actions ManagementPolicyAction |
Actions: Actions are applied to the filtered blobs when the execution condition is met. |
filters ManagementPolicyFilter |
Filters: 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. |
ManagementPolicyDefinitionARM
(Appears on:ManagementPolicyRuleARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyDefinition
Field | Description |
---|---|
actions ManagementPolicyActionARM |
Actions: Actions are applied to the filtered blobs when the execution condition is met. |
filters ManagementPolicyFilterARM |
Filters: 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. |
ManagementPolicyDefinition_Status
(Appears on:ManagementPolicyRule_Status)
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_StatusARM
(Appears on:ManagementPolicyRule_StatusARM)
Field | Description |
---|---|
actions ManagementPolicyAction_StatusARM |
Actions: An object that defines the action set. |
filters ManagementPolicyFilter_StatusARM |
Filters: An object that defines the filter set. |
ManagementPolicyFilter
(Appears on:ManagementPolicyDefinition)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyFilter
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. |
ManagementPolicyFilterARM
(Appears on:ManagementPolicyDefinitionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyFilter
Field | Description |
---|---|
blobIndexMatch []TagFilterARM |
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)
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_StatusARM
(Appears on:ManagementPolicyDefinition_StatusARM)
Field | Description |
---|---|
blobIndexMatch []TagFilter_StatusARM |
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. |
ManagementPolicyPropertiesARM
(Appears on:StorageAccountsManagementPolicies_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyProperties
Field | Description |
---|---|
policy ManagementPolicySchemaARM |
Policy: The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
ManagementPolicyProperties_StatusARM
(Appears on:ManagementPolicy_StatusARM)
Field | Description |
---|---|
lastModifiedTime string |
LastModifiedTime: Returns the date and time the ManagementPolicies was last modified. |
policy ManagementPolicySchema_StatusARM |
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)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyRule
Field | Description |
---|---|
definition ManagementPolicyDefinition |
Definition: An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. |
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 ManagementPolicyRuleType |
Type: The valid value is Lifecycle |
ManagementPolicyRuleARM
(Appears on:ManagementPolicySchemaARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyRule
Field | Description |
---|---|
definition ManagementPolicyDefinitionARM |
Definition: An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. |
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 ManagementPolicyRuleType |
Type: The valid value is Lifecycle |
ManagementPolicyRuleStatusType
(string
alias)
(Appears on:ManagementPolicyRule_Status, ManagementPolicyRule_StatusARM)
Value | Description |
---|---|
"Lifecycle" |
ManagementPolicyRuleType
(string
alias)
(Appears on:ManagementPolicyRule, ManagementPolicyRuleARM)
Value | Description |
---|---|
"Lifecycle" |
ManagementPolicyRule_Status
(Appears on:ManagementPolicySchema_Status)
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 ManagementPolicyRuleStatusType |
Type: The valid value is Lifecycle |
ManagementPolicyRule_StatusARM
(Appears on:ManagementPolicySchema_StatusARM)
Field | Description |
---|---|
definition ManagementPolicyDefinition_StatusARM |
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 ManagementPolicyRuleStatusType |
Type: The valid value is Lifecycle |
ManagementPolicySchema
(Appears on:StorageAccountsManagementPolicies_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicySchema
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. |
ManagementPolicySchemaARM
(Appears on:ManagementPolicyPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicySchema
Field | Description |
---|---|
rules []ManagementPolicyRuleARM |
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:ManagementPolicy_Status)
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_StatusARM
(Appears on:ManagementPolicyProperties_StatusARM)
Field | Description |
---|---|
rules []ManagementPolicyRule_StatusARM |
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)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicySnapShot
Field | Description |
---|---|
delete DateAfterCreation |
Delete: Object to define the number of days after creation. |
tierToArchive DateAfterCreation |
TierToArchive: Object to define the number of days after creation. |
tierToCool DateAfterCreation |
TierToCool: Object to define the number of days after creation. |
ManagementPolicySnapShotARM
(Appears on:ManagementPolicyActionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicySnapShot
Field | Description |
---|---|
delete DateAfterCreationARM |
Delete: Object to define the number of days after creation. |
tierToArchive DateAfterCreationARM |
TierToArchive: Object to define the number of days after creation. |
tierToCool DateAfterCreationARM |
TierToCool: Object to define the number of days after creation. |
ManagementPolicySnapShot_Status
(Appears on:ManagementPolicyAction_Status)
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. Support blob snapshot currently at Hot or Cool tier |
tierToCool DateAfterCreation_Status |
TierToCool: The function to tier blob snapshot to cool storage. Support blob snapshot currently at Hot tier |
ManagementPolicySnapShot_StatusARM
(Appears on:ManagementPolicyAction_StatusARM)
Field | Description |
---|---|
delete DateAfterCreation_StatusARM |
Delete: The function to delete the blob snapshot |
tierToArchive DateAfterCreation_StatusARM |
TierToArchive: The function to tier blob snapshot to archive storage. Support blob snapshot currently at Hot or Cool tier |
tierToCool DateAfterCreation_StatusARM |
TierToCool: The function to tier blob snapshot to cool storage. Support blob snapshot currently at Hot tier |
ManagementPolicyVersion
(Appears on:ManagementPolicyAction)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyVersion
Field | Description |
---|---|
delete DateAfterCreation |
Delete: Object to define the number of days after creation. |
tierToArchive DateAfterCreation |
TierToArchive: Object to define the number of days after creation. |
tierToCool DateAfterCreation |
TierToCool: Object to define the number of days after creation. |
ManagementPolicyVersionARM
(Appears on:ManagementPolicyActionARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ManagementPolicyVersion
Field | Description |
---|---|
delete DateAfterCreationARM |
Delete: Object to define the number of days after creation. |
tierToArchive DateAfterCreationARM |
TierToArchive: Object to define the number of days after creation. |
tierToCool DateAfterCreationARM |
TierToCool: Object to define the number of days after creation. |
ManagementPolicyVersion_Status
(Appears on:ManagementPolicyAction_Status)
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. Support blob version currently at Hot or Cool tier |
tierToCool DateAfterCreation_Status |
TierToCool: The function to tier blob version to cool storage. Support blob version currently at Hot tier |
ManagementPolicyVersion_StatusARM
(Appears on:ManagementPolicyAction_StatusARM)
Field | Description |
---|---|
delete DateAfterCreation_StatusARM |
Delete: The function to delete the blob version |
tierToArchive DateAfterCreation_StatusARM |
TierToArchive: The function to tier blob version to archive storage. Support blob version currently at Hot or Cool tier |
tierToCool DateAfterCreation_StatusARM |
TierToCool: The function to tier blob version to cool storage. Support blob version currently at Hot tier |
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” |
ManagementPolicy_StatusARM
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_StatusARM |
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” |
NetworkRuleSet
(Appears on:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/NetworkRuleSet
Field | Description |
---|---|
bypass NetworkRuleSetBypass |
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 NetworkRuleSetDefaultAction |
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 |
NetworkRuleSetARM
(Appears on:StorageAccountPropertiesCreateParametersARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/NetworkRuleSet
Field | Description |
---|---|
bypass NetworkRuleSetBypass |
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 NetworkRuleSetDefaultAction |
DefaultAction: Specifies the default action of allow or deny when no other rules match. |
ipRules []IPRuleARM |
IpRules: Sets the IP ACL rules |
resourceAccessRules []ResourceAccessRuleARM |
ResourceAccessRules: Sets the resource access rules |
virtualNetworkRules []VirtualNetworkRuleARM |
VirtualNetworkRules: Sets the virtual network rules |
NetworkRuleSetBypass
(string
alias)
(Appears on:NetworkRuleSet, NetworkRuleSetARM)
Value | Description |
---|---|
"AzureServices" |
|
"Logging" |
|
"Metrics" |
|
"None" |
NetworkRuleSetDefaultAction
(string
alias)
(Appears on:NetworkRuleSet, NetworkRuleSetARM)
Value | Description |
---|---|
"Allow" |
|
"Deny" |
NetworkRuleSetStatusBypass
(string
alias)
(Appears on:NetworkRuleSet_Status, NetworkRuleSet_StatusARM)
Value | Description |
---|---|
"AzureServices" |
|
"Logging" |
|
"Metrics" |
|
"None" |
NetworkRuleSetStatusDefaultAction
(string
alias)
(Appears on:NetworkRuleSet_Status, NetworkRuleSet_StatusARM)
Value | Description |
---|---|
"Allow" |
|
"Deny" |
NetworkRuleSet_Status
(Appears on:StorageAccount_Status)
Field | Description |
---|---|
bypass NetworkRuleSetStatusBypass |
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 NetworkRuleSetStatusDefaultAction |
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_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
Field | Description |
---|---|
bypass NetworkRuleSetStatusBypass |
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 NetworkRuleSetStatusDefaultAction |
DefaultAction: Specifies the default action of allow or deny when no other rules match. |
ipRules []IPRule_StatusARM |
IpRules: Sets the IP ACL rules |
resourceAccessRules []ResourceAccessRule_StatusARM |
ResourceAccessRules: Sets the resource access rules |
virtualNetworkRules []VirtualNetworkRule_StatusARM |
VirtualNetworkRules: Sets the virtual network rules |
PrivateEndpointConnection_Status_SubResourceEmbedded
(Appears on:StorageAccount_Status)
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
PrivateEndpointConnection_Status_SubResourceEmbeddedARM
(Appears on:StorageAccountProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
QueuePropertiesARM
(Appears on:StorageAccountsQueueServicesQueues_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/QueueProperties
Field | Description |
---|---|
metadata map[string]string |
Metadata: A name-value pair that represents queue metadata. |
QueueProperties_StatusARM
(Appears on:StorageQueue_StatusARM)
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. |
QueueServicePropertiesPropertiesARM
(Appears on:StorageAccountsQueueServices_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/QueueServicePropertiesProperties
Field | Description |
---|---|
cors CorsRulesARM |
Cors: Sets the CORS rules. You can include up to five CorsRule elements in the request. |
QueueServiceProperties_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” |
QueueServiceProperties_StatusARM
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 QueueServiceProperties_Status_PropertiesARM |
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” |
QueueServiceProperties_Status_PropertiesARM
(Appears on:QueueServiceProperties_StatusARM)
Field | Description |
---|---|
cors CorsRules_StatusARM |
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. |
ResourceAccessRule
(Appears on:NetworkRuleSet)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ResourceAccessRule
Field | Description |
---|---|
resourceReference genruntime.ResourceReference |
ResourceReference: Resource Id |
tenantId string |
TenantId: Tenant Id |
ResourceAccessRuleARM
(Appears on:NetworkRuleSetARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/ResourceAccessRule
Field | Description |
---|---|
resourceId string |
|
tenantId string |
TenantId: Tenant Id |
ResourceAccessRule_Status
(Appears on:NetworkRuleSet_Status)
Field | Description |
---|---|
resourceId string |
ResourceId: Resource Id |
tenantId string |
TenantId: Tenant Id |
ResourceAccessRule_StatusARM
(Appears on:NetworkRuleSet_StatusARM)
Field | Description |
---|---|
resourceId string |
ResourceId: Resource Id |
tenantId string |
TenantId: Tenant Id |
RestorePolicyProperties
(Appears on:StorageAccountsBlobServices_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/RestorePolicyProperties
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. |
RestorePolicyPropertiesARM
(Appears on:BlobServicePropertiesPropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/RestorePolicyProperties
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:BlobServiceProperties_Status)
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_StatusARM
(Appears on:BlobServiceProperties_Status_PropertiesARM)
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:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/RoutingPreference
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 RoutingPreferenceRoutingChoice |
RoutingChoice: Routing Choice defines the kind of network routing opted by the user. |
RoutingPreferenceARM
(Appears on:StorageAccountPropertiesCreateParametersARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/RoutingPreference
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 RoutingPreferenceRoutingChoice |
RoutingChoice: Routing Choice defines the kind of network routing opted by the user. |
RoutingPreferenceRoutingChoice
(string
alias)
(Appears on:RoutingPreference, RoutingPreferenceARM)
Value | Description |
---|---|
"InternetRouting" |
|
"MicrosoftRouting" |
RoutingPreferenceStatusRoutingChoice
(string
alias)
(Appears on:RoutingPreference_Status, RoutingPreference_StatusARM)
Value | Description |
---|---|
"InternetRouting" |
|
"MicrosoftRouting" |
RoutingPreference_Status
(Appears on:StorageAccount_Status)
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 RoutingPreferenceStatusRoutingChoice |
RoutingChoice: Routing Choice defines the kind of network routing opted by the user. |
RoutingPreference_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
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 RoutingPreferenceStatusRoutingChoice |
RoutingChoice: Routing Choice defines the kind of network routing opted by the user. |
SasPolicy
(Appears on:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/SasPolicy
Field | Description |
---|---|
expirationAction SasPolicyExpirationAction |
ExpirationAction: The SAS expiration action. Can only be Log. |
sasExpirationPeriod string |
SasExpirationPeriod: The SAS expiration period, DD.HH:MM:SS. |
SasPolicyARM
(Appears on:StorageAccountPropertiesCreateParametersARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/SasPolicy
Field | Description |
---|---|
expirationAction SasPolicyExpirationAction |
ExpirationAction: The SAS expiration action. Can only be Log. |
sasExpirationPeriod string |
SasExpirationPeriod: The SAS expiration period, DD.HH:MM:SS. |
SasPolicyExpirationAction
(string
alias)
(Appears on:SasPolicy, SasPolicyARM)
Value | Description |
---|---|
"Log" |
SasPolicyStatusExpirationAction
(string
alias)
(Appears on:SasPolicy_Status, SasPolicy_StatusARM)
Value | Description |
---|---|
"Log" |
SasPolicy_Status
(Appears on:StorageAccount_Status)
Field | Description |
---|---|
expirationAction SasPolicyStatusExpirationAction |
ExpirationAction: The SAS expiration action. Can only be Log. |
sasExpirationPeriod string |
SasExpirationPeriod: The SAS expiration period, DD.HH:MM:SS. |
SasPolicy_StatusARM
(Appears on:StorageAccountProperties_StatusARM)
Field | Description |
---|---|
expirationAction SasPolicyStatusExpirationAction |
ExpirationAction: The SAS expiration action. Can only be Log. |
sasExpirationPeriod string |
SasExpirationPeriod: The SAS expiration period, DD.HH:MM:SS. |
Sku
(Appears on:StorageAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/Sku
Field | Description |
---|---|
name SkuName |
|
tier SkuTier |
SkuARM
(Appears on:StorageAccounts_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/Sku
Field | Description |
---|---|
name SkuName |
|
tier SkuTier |
SkuName
(string
alias)
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, Sku_StatusARM)
Value | Description |
---|---|
"Premium_LRS" |
|
"Premium_ZRS" |
|
"Standard_GRS" |
|
"Standard_GZRS" |
|
"Standard_LRS" |
|
"Standard_RAGRS" |
|
"Standard_RAGZRS" |
|
"Standard_ZRS" |
SkuTier
(string
alias)
Value | Description |
---|---|
"Premium" |
|
"Standard" |
Sku_Status
(Appears on:BlobServiceProperties_Status, StorageAccount_Status)
Field | Description |
---|---|
name SkuName_Status |
|
tier Tier_Status |
Sku_StatusARM
(Appears on:BlobServiceProperties_StatusARM, StorageAccount_StatusARM)
Field | Description |
---|---|
name SkuName_Status |
|
tier Tier_Status |
StorageAccount
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/resourceDefinitions/storageAccounts
Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||
spec StorageAccounts_Spec |
|
||||||||||||||||||||||||||||||||||||||||||||||||||
status StorageAccount_Status |
StorageAccountInternetEndpoints_Status
(Appears on:Endpoints_Status)
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_StatusARM
(Appears on:Endpoints_StatusARM)
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)
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_StatusARM
(Appears on:Endpoints_StatusARM)
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. |
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:StorageAccounts_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
secrets StorageAccountOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
StorageAccountPropertiesCreateParametersARM
(Appears on:StorageAccounts_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/StorageAccountPropertiesCreateParameters
Field | Description |
---|---|
accessTier StorageAccountPropertiesCreateParametersAccessTier |
AccessTier: Required for storage accounts where kind = BlobStorage. The access tier used for billing. |
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. |
azureFilesIdentityBasedAuthentication AzureFilesIdentityBasedAuthenticationARM |
AzureFilesIdentityBasedAuthentication: Settings for Azure Files identity based authentication. |
customDomain CustomDomainARM |
CustomDomain: The custom domain assigned to this storage account. This can be set via Update. |
encryption EncryptionARM |
Encryption: The encryption settings on the storage account. |
isHnsEnabled bool |
IsHnsEnabled: Account HierarchicalNamespace enabled if sets to true. |
isNfsV3Enabled bool |
IsNfsV3Enabled: NFS 3.0 protocol support enabled if set to true. |
keyPolicy KeyPolicyARM |
KeyPolicy: KeyPolicy assigned to the storage account. |
largeFileSharesState StorageAccountPropertiesCreateParametersLargeFileSharesState |
LargeFileSharesState: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. |
minimumTlsVersion StorageAccountPropertiesCreateParametersMinimumTlsVersion |
MinimumTlsVersion: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. |
networkAcls NetworkRuleSetARM |
NetworkAcls: Network rule set |
routingPreference RoutingPreferenceARM |
RoutingPreference: Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing |
sasPolicy SasPolicyARM |
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. |
StorageAccountPropertiesCreateParametersAccessTier
(string
alias)
(Appears on:StorageAccountPropertiesCreateParametersARM, StorageAccounts_Spec)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
StorageAccountPropertiesCreateParametersLargeFileSharesState
(string
alias)
(Appears on:StorageAccountPropertiesCreateParametersARM, StorageAccounts_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountPropertiesCreateParametersMinimumTlsVersion
(string
alias)
(Appears on:StorageAccountPropertiesCreateParametersARM, StorageAccounts_Spec)
Value | Description |
---|---|
"TLS1_0" |
|
"TLS1_1" |
|
"TLS1_2" |
StorageAccountPropertiesStatusAccessTier
(string
alias)
(Appears on:StorageAccountProperties_StatusARM, StorageAccount_Status)
Value | Description |
---|---|
"Cool" |
|
"Hot" |
StorageAccountPropertiesStatusLargeFileSharesState
(string
alias)
(Appears on:StorageAccountProperties_StatusARM, StorageAccount_Status)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
StorageAccountPropertiesStatusMinimumTlsVersion
(string
alias)
(Appears on:StorageAccountProperties_StatusARM, StorageAccount_Status)
Value | Description |
---|---|
"TLS1_0" |
|
"TLS1_1" |
|
"TLS1_2" |
StorageAccountPropertiesStatusProvisioningState
(string
alias)
(Appears on:StorageAccountProperties_StatusARM, StorageAccount_Status)
Value | Description |
---|---|
"Creating" |
|
"ResolvingDNS" |
|
"Succeeded" |
StorageAccountPropertiesStatusStatusOfPrimary
(string
alias)
(Appears on:StorageAccountProperties_StatusARM, StorageAccount_Status)
Value | Description |
---|---|
"available" |
|
"unavailable" |
StorageAccountPropertiesStatusStatusOfSecondary
(string
alias)
(Appears on:StorageAccountProperties_StatusARM, StorageAccount_Status)
Value | Description |
---|---|
"available" |
|
"unavailable" |
StorageAccountProperties_StatusARM
(Appears on:StorageAccount_StatusARM)
Field | Description |
---|---|
accessTier StorageAccountPropertiesStatusAccessTier |
AccessTier: Required for storage accounts where kind = BlobStorage. The access tier used for billing. |
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. |
azureFilesIdentityBasedAuthentication AzureFilesIdentityBasedAuthentication_StatusARM |
AzureFilesIdentityBasedAuthentication: Provides the identity based authentication settings for Azure Files. |
blobRestoreStatus BlobRestoreStatus_StatusARM |
BlobRestoreStatus: Blob restore status |
creationTime string |
CreationTime: Gets the creation date and time of the storage account in UTC. |
customDomain CustomDomain_StatusARM |
CustomDomain: Gets the custom domain the user assigned to this storage account. |
encryption Encryption_StatusARM |
Encryption: Gets the encryption settings on the account. If unspecified, the account is unencrypted. |
failoverInProgress bool |
FailoverInProgress: If the failover is in progress, the value will be true, otherwise, it will be null. |
geoReplicationStats GeoReplicationStats_StatusARM |
GeoReplicationStats: Geo Replication Stats |
isHnsEnabled bool |
IsHnsEnabled: Account HierarchicalNamespace enabled if sets to true. |
isNfsV3Enabled bool |
IsNfsV3Enabled: NFS 3.0 protocol support enabled if set to true. |
keyCreationTime KeyCreationTime_StatusARM |
KeyCreationTime: Storage account keys creation time. |
keyPolicy KeyPolicy_StatusARM |
KeyPolicy: KeyPolicy assigned to the storage account. |
largeFileSharesState StorageAccountPropertiesStatusLargeFileSharesState |
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 StorageAccountPropertiesStatusMinimumTlsVersion |
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_StatusARM |
NetworkAcls: Network rule set |
primaryEndpoints Endpoints_StatusARM |
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_SubResourceEmbeddedARM |
PrivateEndpointConnections: List of private endpoint connection associated with the specified storage account |
provisioningState StorageAccountPropertiesStatusProvisioningState |
ProvisioningState: Gets the status of the storage account at the time the operation was called. |
routingPreference RoutingPreference_StatusARM |
RoutingPreference: Maintains information about the network routing choice opted by the user for data transfer |
sasPolicy SasPolicy_StatusARM |
SasPolicy: SasPolicy assigned to the storage account. |
secondaryEndpoints Endpoints_StatusARM |
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 StorageAccountPropertiesStatusStatusOfPrimary |
StatusOfPrimary: Gets the status indicating whether the primary location of the storage account is available or unavailable. |
statusOfSecondary StorageAccountPropertiesStatusStatusOfSecondary |
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. |
supportsHttpsTrafficOnly bool |
SupportsHttpsTrafficOnly: Allows https traffic only to storage service if sets to true. |
StorageAccountStatusKind
(string
alias)
(Appears on:StorageAccount_Status, StorageAccount_StatusARM)
Value | Description |
---|---|
"BlobStorage" |
|
"BlockBlobStorage" |
|
"FileStorage" |
|
"Storage" |
|
"StorageV2" |
StorageAccount_Status
(Appears on:StorageAccount)
Field | Description |
---|---|
accessTier StorageAccountPropertiesStatusAccessTier |
AccessTier: Required for storage accounts where kind = BlobStorage. The access tier used for billing. |
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. |
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. |
encryption Encryption_Status |
Encryption: Gets the encryption settings on the account. If unspecified, the account is unencrypted. |
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. |
isHnsEnabled bool |
IsHnsEnabled: Account HierarchicalNamespace enabled if sets to true. |
isNfsV3Enabled bool |
IsNfsV3Enabled: NFS 3.0 protocol support enabled if set to true. |
keyCreationTime KeyCreationTime_Status |
KeyCreationTime: Storage account keys creation time. |
keyPolicy KeyPolicy_Status |
KeyPolicy: KeyPolicy assigned to the storage account. |
kind StorageAccountStatusKind |
Kind: Gets the Kind. |
largeFileSharesState StorageAccountPropertiesStatusLargeFileSharesState |
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 StorageAccountPropertiesStatusMinimumTlsVersion |
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_SubResourceEmbedded |
PrivateEndpointConnections: List of private endpoint connection associated with the specified storage account |
provisioningState StorageAccountPropertiesStatusProvisioningState |
ProvisioningState: Gets the status of the storage account at the time the operation was called. |
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 StorageAccountPropertiesStatusStatusOfPrimary |
StatusOfPrimary: Gets the status indicating whether the primary location of the storage account is available or unavailable. |
statusOfSecondary StorageAccountPropertiesStatusStatusOfSecondary |
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. |
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_StatusARM
Field | Description |
---|---|
extendedLocation ExtendedLocation_StatusARM |
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_StatusARM |
Identity: The identity of the resource. |
kind StorageAccountStatusKind |
Kind: Gets the Kind. |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
properties StorageAccountProperties_StatusARM |
Properties: Properties of the storage account. |
sku Sku_StatusARM |
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” |
StorageAccountsBlobService
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/resourceDefinitions/storageAccounts_blobServices
Field | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||
spec StorageAccountsBlobServices_Spec |
|
||||||||||||||||||||||||
status BlobServiceProperties_Status |
StorageAccountsBlobServicesContainer
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/resourceDefinitions/storageAccounts_blobServices_containers
Field | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||
spec StorageAccountsBlobServicesContainers_Spec |
|
||||||||||||||||||
status BlobContainer_Status |
StorageAccountsBlobServicesContainers_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. |
immutableStorageWithVersioning ImmutableStorageWithVersioning |
ImmutableStorageWithVersioning: Object level immutability properties of the container. |
location string |
Location: Location to deploy resource to |
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 ContainerPropertiesPublicAccess |
PublicAccess: Specifies whether data in the container may be accessed publicly and the level of access. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsBlobServicesContainers_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. |
properties ContainerPropertiesARM |
Properties: The properties of a container. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsBlobServices_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 service properties for soft delete. |
cors CorsRules |
Cors: Sets the CORS rules. You can include up to five CorsRule elements in the request. |
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 service properties for soft delete. |
isVersioningEnabled bool |
IsVersioningEnabled: Versioning is enabled if set to true. |
lastAccessTimeTrackingPolicy LastAccessTimeTrackingPolicy |
LastAccessTimeTrackingPolicy: The blob service properties for Last access time based tracking policy. |
location string |
Location: Location to deploy resource to |
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 |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsBlobServices_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the blob Service within the specified storage account. Blob Service Name must be ‘default’ |
properties BlobServicePropertiesPropertiesARM |
Properties: The properties of a storage account’s Blob service. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsManagementPolicies_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 ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsManagementPolicies_SpecARM
Field | Description |
---|---|
name string |
Name: The name of the Storage Account Management Policy. It should always be ‘default’ |
properties ManagementPolicyPropertiesARM |
Properties: The Storage Account ManagementPolicy properties. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsManagementPolicy
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/resourceDefinitions/storageAccounts_managementPolicies
Field | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
spec StorageAccountsManagementPolicies_Spec |
|
||||||
status ManagementPolicy_Status |
StorageAccountsQueueService
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/resourceDefinitions/storageAccounts_queueServices
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec StorageAccountsQueueServices_Spec |
|
||||||||
status QueueServiceProperties_Status |
StorageAccountsQueueServicesQueue
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/resourceDefinitions/storageAccounts_queueServices_queues
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
spec StorageAccountsQueueServicesQueues_Spec |
|
||||||||||
status StorageQueue_Status |
StorageAccountsQueueServicesQueues_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. |
location string |
Location: Location to deploy resource to |
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 |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsQueueServicesQueues_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters. |
properties QueuePropertiesARM |
|
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsQueueServices_Spec
(Appears on:StorageAccountsQueueService)
Field | Description |
---|---|
cors CorsRules |
Cors: Sets the CORS rules. You can include up to five CorsRule elements in the request. |
location string |
Location: Location to deploy resource to |
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 |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsQueueServices_SpecARM
Field | Description |
---|---|
location string |
Location: Location to deploy resource to |
name string |
Name: The name of the Queue Service within the specified storage account. Queue Service Name must be ‘default’ |
properties QueueServicePropertiesPropertiesARM |
Properties: The properties of a storage account’s Queue service. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
StorageAccountsSpecKind
(string
alias)
(Appears on:StorageAccounts_Spec, StorageAccounts_SpecARM)
Value | Description |
---|---|
"BlobStorage" |
|
"BlockBlobStorage" |
|
"FileStorage" |
|
"Storage" |
|
"StorageV2" |
StorageAccounts_Spec
(Appears on:StorageAccount)
Field | Description |
---|---|
accessTier StorageAccountPropertiesCreateParametersAccessTier |
AccessTier: Required for storage accounts where kind = BlobStorage. The access tier used for billing. |
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. |
azureFilesIdentityBasedAuthentication AzureFilesIdentityBasedAuthentication |
AzureFilesIdentityBasedAuthentication: Settings for Azure Files identity based authentication. |
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: The custom domain assigned to this storage account. This can be set via Update. |
encryption Encryption |
Encryption: The encryption settings on the storage account. |
extendedLocation ExtendedLocation |
ExtendedLocation: The complex type of the extended location. |
identity Identity |
Identity: Identity for the resource. |
isHnsEnabled bool |
IsHnsEnabled: Account HierarchicalNamespace enabled if sets to true. |
isNfsV3Enabled bool |
IsNfsV3Enabled: NFS 3.0 protocol support enabled if set to true. |
keyPolicy KeyPolicy |
KeyPolicy: KeyPolicy assigned to the storage account. |
kind StorageAccountsSpecKind |
Kind: Required. Indicates the type of storage account. |
largeFileSharesState StorageAccountPropertiesCreateParametersLargeFileSharesState |
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 StorageAccountPropertiesCreateParametersMinimumTlsVersion |
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 |
routingPreference RoutingPreference |
RoutingPreference: Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing |
sasPolicy SasPolicy |
SasPolicy: SasPolicy assigned to the storage account. |
sku Sku |
Sku: The SKU of 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. |
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. |
StorageAccounts_SpecARM
Field | Description |
---|---|
extendedLocation ExtendedLocationARM |
ExtendedLocation: The complex type of the extended location. |
identity IdentityARM |
Identity: Identity for the resource. |
kind StorageAccountsSpecKind |
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 |
Name: The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. |
properties StorageAccountPropertiesCreateParametersARM |
Properties: The parameters used to create the storage account. |
sku SkuARM |
Sku: The SKU of the storage account. |
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. |
StorageQueue_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” |
StorageQueue_StatusARM
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_StatusARM |
Properties: Queue resource properties. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
TagFilter
(Appears on:ManagementPolicyFilter)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/TagFilter
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 |
TagFilterARM
(Appears on:ManagementPolicyFilterARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/TagFilter
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)
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_StatusARM
(Appears on:ManagementPolicyFilter_StatusARM)
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)
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_StatusARM
(Appears on:LegalHoldProperties_StatusARM)
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_Status
(string
alias)
(Appears on:Sku_Status, Sku_StatusARM)
Value | Description |
---|---|
"Premium" |
|
"Standard" |
UpdateHistoryPropertyStatusUpdate
(string
alias)
(Appears on:UpdateHistoryProperty_Status, UpdateHistoryProperty_StatusARM)
Value | Description |
---|---|
"extend" |
|
"lock" |
|
"put" |
UpdateHistoryProperty_Status
(Appears on:ImmutabilityPolicyProperties_Status)
Field | Description |
---|---|
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 UpdateHistoryPropertyStatusUpdate |
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_StatusARM
(Appears on:ImmutabilityPolicyProperties_StatusARM)
Field | Description |
---|---|
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 UpdateHistoryPropertyStatusUpdate |
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. |
UserAssignedIdentity_Status
(Appears on:Identity_Status)
Field | Description |
---|---|
clientId string |
ClientId: The client ID of the identity. |
principalId string |
PrincipalId: The principal ID of the identity. |
UserAssignedIdentity_StatusARM
(Appears on:Identity_StatusARM)
Field | Description |
---|---|
clientId string |
ClientId: The client ID of the identity. |
principalId string |
PrincipalId: The principal ID of the identity. |
VirtualNetworkRule
(Appears on:NetworkRuleSet)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/VirtualNetworkRule
Field | Description |
---|---|
action VirtualNetworkRuleAction |
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 VirtualNetworkRuleState |
State: Gets the state of virtual network rule. |
VirtualNetworkRuleARM
(Appears on:NetworkRuleSetARM)
Generated from: https://schema.management.azure.com/schemas/2021-04-01/Microsoft.Storage.json#/definitions/VirtualNetworkRule
Field | Description |
---|---|
action VirtualNetworkRuleAction |
Action: The action of virtual network rule. |
id string |
|
state VirtualNetworkRuleState |
State: Gets the state of virtual network rule. |
VirtualNetworkRuleAction
(string
alias)
(Appears on:VirtualNetworkRule, VirtualNetworkRuleARM)
Value | Description |
---|---|
"Allow" |
VirtualNetworkRuleState
(string
alias)
(Appears on:VirtualNetworkRule, VirtualNetworkRuleARM)
Value | Description |
---|---|
"Deprovisioning" |
|
"Failed" |
|
"NetworkSourceDeleted" |
|
"Provisioning" |
|
"Succeeded" |
VirtualNetworkRuleStatusAction
(string
alias)
(Appears on:VirtualNetworkRule_Status, VirtualNetworkRule_StatusARM)
Value | Description |
---|---|
"Allow" |
VirtualNetworkRuleStatusState
(string
alias)
(Appears on:VirtualNetworkRule_Status, VirtualNetworkRule_StatusARM)
Value | Description |
---|---|
"Deprovisioning" |
|
"Failed" |
|
"NetworkSourceDeleted" |
|
"Provisioning" |
|
"Succeeded" |
VirtualNetworkRule_Status
(Appears on:NetworkRuleSet_Status)
Field | Description |
---|---|
action VirtualNetworkRuleStatusAction |
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 VirtualNetworkRuleStatusState |
State: Gets the state of virtual network rule. |
VirtualNetworkRule_StatusARM
(Appears on:NetworkRuleSet_StatusARM)
Field | Description |
---|---|
action VirtualNetworkRuleStatusAction |
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 VirtualNetworkRuleStatusState |
State: Gets the state of virtual network rule. |