Microsoft.Storage (stable:2024-01-01)

2025/02/06 • 104 new methods

BlobServices_List (new)
Description :  List blob services of storage account. It returns a collection of one object named default.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blob services returned. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a storage account’s Blob service. ,
Required: False ,
}
{
cors:
{
Description: 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. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
defaultServiceVersion:
{
Description: 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. ,
Required: False ,
}
string ,
deleteRetentionPolicy:
{
Description: The blob service properties for blob soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
isVersioningEnabled:
{
Description: Versioning is enabled if set to true. ,
Required: False ,
}
boolean ,
automaticSnapshotPolicyEnabled:
{
Description: Deprecated in favor of isVersioningEnabled property. ,
Required: False ,
}
boolean ,
changeFeed:
{
Description: The blob service properties for change feed events. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether change feed event logging is enabled for the Blob service. ,
Required: False ,
}
boolean ,
retentionInDays:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
restorePolicy:
{
Description: The blob service properties for blob restore policy. ,
Required: False ,
}
{
enabled:
{
Description: Blob restore is enabled if set to true. ,
Required: True ,
}
boolean ,
days:
{
Description: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. ,
Required: False ,
}
integer ,
lastEnabledTime:
{
Description: Deprecated in favor of minRestoreTime property. ,
Format: date-time ,
Required: False ,
}
string ,
minRestoreTime:
{
Description: Returns the minimum date and time that the restore can be started. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
containerDeleteRetentionPolicy:
{
Description: The blob service properties for container soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
lastAccessTimeTrackingPolicy:
{
Description: The blob service property to configure last access time based tracking policy. ,
Required: False ,
}
{
enable:
{
Description: When set to true last access time based tracking is enabled. ,
Required: True ,
}
boolean ,
name:
{
Description: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only ,
Enum:
{
AccessTimeTracking: No description available. ,
}
,
Required: False ,
}
enum ,
trackingGranularityInDays:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
blobType:
{
Description: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sku:
{
Description: Sku name and tier. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
BlobServices_SetServiceProperties (new)
Description :  Sets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
BlobServicesName:
{
Description: The name of the blob Service within the specified storage account. Blob Service Name must be 'default' ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ,
Required: True ,
}
{
properties:
{
Description: The properties of a storage account’s Blob service. ,
Required: False ,
}
{
cors:
{
Description: 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. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
defaultServiceVersion:
{
Description: 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. ,
Required: False ,
}
string ,
deleteRetentionPolicy:
{
Description: The blob service properties for blob soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
isVersioningEnabled:
{
Description: Versioning is enabled if set to true. ,
Required: False ,
}
boolean ,
automaticSnapshotPolicyEnabled:
{
Description: Deprecated in favor of isVersioningEnabled property. ,
Required: False ,
}
boolean ,
changeFeed:
{
Description: The blob service properties for change feed events. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether change feed event logging is enabled for the Blob service. ,
Required: False ,
}
boolean ,
retentionInDays:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
restorePolicy:
{
Description: The blob service properties for blob restore policy. ,
Required: False ,
}
{
enabled:
{
Description: Blob restore is enabled if set to true. ,
Required: True ,
}
boolean ,
days:
{
Description: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. ,
Required: False ,
}
integer ,
lastEnabledTime:
{
Description: Deprecated in favor of minRestoreTime property. ,
Format: date-time ,
Required: False ,
}
string ,
minRestoreTime:
{
Description: Returns the minimum date and time that the restore can be started. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
containerDeleteRetentionPolicy:
{
Description: The blob service properties for container soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
lastAccessTimeTrackingPolicy:
{
Description: The blob service property to configure last access time based tracking policy. ,
Required: False ,
}
{
enable:
{
Description: When set to true last access time based tracking is enabled. ,
Required: True ,
}
boolean ,
name:
{
Description: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only ,
Enum:
{
AccessTimeTracking: No description available. ,
}
,
Required: False ,
}
enum ,
trackingGranularityInDays:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
blobType:
{
Description: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sku:
{
Description: Sku name and tier. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a storage account’s Blob service. ,
Required: False ,
}
{
cors:
{
Description: 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. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
defaultServiceVersion:
{
Description: 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. ,
Required: False ,
}
string ,
deleteRetentionPolicy:
{
Description: The blob service properties for blob soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
isVersioningEnabled:
{
Description: Versioning is enabled if set to true. ,
Required: False ,
}
boolean ,
automaticSnapshotPolicyEnabled:
{
Description: Deprecated in favor of isVersioningEnabled property. ,
Required: False ,
}
boolean ,
changeFeed:
{
Description: The blob service properties for change feed events. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether change feed event logging is enabled for the Blob service. ,
Required: False ,
}
boolean ,
retentionInDays:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
restorePolicy:
{
Description: The blob service properties for blob restore policy. ,
Required: False ,
}
{
enabled:
{
Description: Blob restore is enabled if set to true. ,
Required: True ,
}
boolean ,
days:
{
Description: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. ,
Required: False ,
}
integer ,
lastEnabledTime:
{
Description: Deprecated in favor of minRestoreTime property. ,
Format: date-time ,
Required: False ,
}
string ,
minRestoreTime:
{
Description: Returns the minimum date and time that the restore can be started. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
containerDeleteRetentionPolicy:
{
Description: The blob service properties for container soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
lastAccessTimeTrackingPolicy:
{
Description: The blob service property to configure last access time based tracking policy. ,
Required: False ,
}
{
enable:
{
Description: When set to true last access time based tracking is enabled. ,
Required: True ,
}
boolean ,
name:
{
Description: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only ,
Enum:
{
AccessTimeTracking: No description available. ,
}
,
Required: False ,
}
enum ,
trackingGranularityInDays:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
blobType:
{
Description: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sku:
{
Description: Sku name and tier. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
BlobServices_GetServiceProperties (new)
Description :  Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
BlobServicesName:
{
Description: The name of the blob Service within the specified storage account. Blob Service Name must be 'default' ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a storage account’s Blob service. ,
Required: False ,
}
{
cors:
{
Description: 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. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
defaultServiceVersion:
{
Description: 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. ,
Required: False ,
}
string ,
deleteRetentionPolicy:
{
Description: The blob service properties for blob soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
isVersioningEnabled:
{
Description: Versioning is enabled if set to true. ,
Required: False ,
}
boolean ,
automaticSnapshotPolicyEnabled:
{
Description: Deprecated in favor of isVersioningEnabled property. ,
Required: False ,
}
boolean ,
changeFeed:
{
Description: The blob service properties for change feed events. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether change feed event logging is enabled for the Blob service. ,
Required: False ,
}
boolean ,
retentionInDays:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
restorePolicy:
{
Description: The blob service properties for blob restore policy. ,
Required: False ,
}
{
enabled:
{
Description: Blob restore is enabled if set to true. ,
Required: True ,
}
boolean ,
days:
{
Description: how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. ,
Required: False ,
}
integer ,
lastEnabledTime:
{
Description: Deprecated in favor of minRestoreTime property. ,
Format: date-time ,
Required: False ,
}
string ,
minRestoreTime:
{
Description: Returns the minimum date and time that the restore can be started. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
containerDeleteRetentionPolicy:
{
Description: The blob service properties for container soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
lastAccessTimeTrackingPolicy:
{
Description: The blob service property to configure last access time based tracking policy. ,
Required: False ,
}
{
enable:
{
Description: When set to true last access time based tracking is enabled. ,
Required: True ,
}
boolean ,
name:
{
Description: Name of the policy. The valid value is AccessTimeTracking. This field is currently read only ,
Enum:
{
AccessTimeTracking: No description available. ,
}
,
Required: False ,
}
enum ,
trackingGranularityInDays:
{
Description: 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 ,
Format: int32 ,
Required: False ,
}
integer ,
blobType:
{
Description: An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
sku:
{
Description: Sku name and tier. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
BlobContainers_List (new)
Description :  Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional. Specified maximum number of containers that can be included in the list. ,
Required: False ,
}
string ,
$filter:
{
Description: Optional. When specified, only container names starting with the filter will be listed. ,
Required: False ,
}
string ,
$include:
{
Description: Optional, used to include the properties for soft deleted blob containers. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blobs containers returned. ,
Required: False ,
}
[
{
properties:
{
Description: The blob container properties be listed out. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted blob container. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the blob container was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: Blob container deletion time. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for soft deleted blob container. ,
Required: False ,
}
integer ,
defaultEncryptionScope:
{
Description: Default the container to use specified encryption scope for all writes. ,
Required: False ,
}
string ,
denyEncryptionScopeOverride:
{
Description: Block override of encryption scope from the container default. ,
Required: False ,
}
boolean ,
publicAccess:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access. ,
Enum:
{
Container: No description available. ,
Blob: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedTime:
{
Description: Returns the date and time the container was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
leaseStatus:
{
Description: The lease status of the container. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the container. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: A name-value pair to associate with the container as metadata. ,
Required: False ,
}
object ,
immutabilityPolicy:
{
Description: The ImmutabilityPolicy property of the container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: ImmutabilityPolicy Etag. ,
Required: False ,
}
string ,
updateHistory:
{
Description: The ImmutabilityPolicy update history of the blob container. ,
Required: False ,
}
[
{
update:
{
Description: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. ,
Enum:
{
put: No description available. ,
lock: No description available. ,
extend: No description available. ,
}
,
Required: False ,
}
enum ,
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
timestamp:
{
Description: Returns the date and time the ImmutabilityPolicy was updated. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
legalHold:
{
Description: The LegalHold property of the container. ,
Required: False ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: The list of LegalHold tags of a blob container. ,
Required: False ,
}
[
{
tag:
{
Description: The tag value. ,
Required: False ,
}
string ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who added the tag. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who added the tag. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who added the tag. ,
Required: False ,
}
string ,
}
,
]
,
protectedAppendWritesHistory:
{
Description: Protected append blob writes history. ,
Required: False ,
}
{
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
hasImmutabilityPolicy:
{
Description: 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. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: This is an immutable property, when set to true it enables object level immutability at the container level. ,
Required: False ,
}
boolean ,
timeStamp:
{
Description: Returns the date and time the object level immutability was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
migrationState:
{
Description: This property denotes the container level immutability to object level immutability migration state. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableNfsV3RootSquash:
{
Description: Enable NFSv3 root squash on blob container. ,
Required: False ,
}
boolean ,
enableNfsV3AllSquash:
{
Description: Enable NFSv3 all squash on blob container. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of containers. Returned when total number of requested containers exceed maximum page size. ,
Required: False ,
}
string ,
}
BlobContainers_Create (new)
Description :  Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
blobContainer:
{
Description: Properties of the blob container to create. ,
Required: True ,
}
{
properties:
{
Description: Properties of the blob container. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted blob container. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the blob container was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: Blob container deletion time. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for soft deleted blob container. ,
Required: False ,
}
integer ,
defaultEncryptionScope:
{
Description: Default the container to use specified encryption scope for all writes. ,
Required: False ,
}
string ,
denyEncryptionScopeOverride:
{
Description: Block override of encryption scope from the container default. ,
Required: False ,
}
boolean ,
publicAccess:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access. ,
Enum:
{
Container: No description available. ,
Blob: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedTime:
{
Description: Returns the date and time the container was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
leaseStatus:
{
Description: The lease status of the container. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the container. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: A name-value pair to associate with the container as metadata. ,
Required: False ,
}
object ,
immutabilityPolicy:
{
Description: The ImmutabilityPolicy property of the container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: ImmutabilityPolicy Etag. ,
Required: False ,
}
string ,
updateHistory:
{
Description: The ImmutabilityPolicy update history of the blob container. ,
Required: False ,
}
[
{
update:
{
Description: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. ,
Enum:
{
put: No description available. ,
lock: No description available. ,
extend: No description available. ,
}
,
Required: False ,
}
enum ,
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
timestamp:
{
Description: Returns the date and time the ImmutabilityPolicy was updated. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
legalHold:
{
Description: The LegalHold property of the container. ,
Required: False ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: The list of LegalHold tags of a blob container. ,
Required: False ,
}
[
{
tag:
{
Description: The tag value. ,
Required: False ,
}
string ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who added the tag. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who added the tag. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who added the tag. ,
Required: False ,
}
string ,
}
,
]
,
protectedAppendWritesHistory:
{
Description: Protected append blob writes history. ,
Required: False ,
}
{
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
hasImmutabilityPolicy:
{
Description: 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. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: This is an immutable property, when set to true it enables object level immutability at the container level. ,
Required: False ,
}
boolean ,
timeStamp:
{
Description: Returns the date and time the object level immutability was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
migrationState:
{
Description: This property denotes the container level immutability to object level immutability migration state. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableNfsV3RootSquash:
{
Description: Enable NFSv3 root squash on blob container. ,
Required: False ,
}
boolean ,
enableNfsV3AllSquash:
{
Description: Enable NFSv3 all squash on blob container. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the blob container. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted blob container. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the blob container was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: Blob container deletion time. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for soft deleted blob container. ,
Required: False ,
}
integer ,
defaultEncryptionScope:
{
Description: Default the container to use specified encryption scope for all writes. ,
Required: False ,
}
string ,
denyEncryptionScopeOverride:
{
Description: Block override of encryption scope from the container default. ,
Required: False ,
}
boolean ,
publicAccess:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access. ,
Enum:
{
Container: No description available. ,
Blob: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedTime:
{
Description: Returns the date and time the container was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
leaseStatus:
{
Description: The lease status of the container. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the container. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: A name-value pair to associate with the container as metadata. ,
Required: False ,
}
object ,
immutabilityPolicy:
{
Description: The ImmutabilityPolicy property of the container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: ImmutabilityPolicy Etag. ,
Required: False ,
}
string ,
updateHistory:
{
Description: The ImmutabilityPolicy update history of the blob container. ,
Required: False ,
}
[
{
update:
{
Description: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. ,
Enum:
{
put: No description available. ,
lock: No description available. ,
extend: No description available. ,
}
,
Required: False ,
}
enum ,
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
timestamp:
{
Description: Returns the date and time the ImmutabilityPolicy was updated. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
legalHold:
{
Description: The LegalHold property of the container. ,
Required: False ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: The list of LegalHold tags of a blob container. ,
Required: False ,
}
[
{
tag:
{
Description: The tag value. ,
Required: False ,
}
string ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who added the tag. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who added the tag. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who added the tag. ,
Required: False ,
}
string ,
}
,
]
,
protectedAppendWritesHistory:
{
Description: Protected append blob writes history. ,
Required: False ,
}
{
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
hasImmutabilityPolicy:
{
Description: 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. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: This is an immutable property, when set to true it enables object level immutability at the container level. ,
Required: False ,
}
boolean ,
timeStamp:
{
Description: Returns the date and time the object level immutability was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
migrationState:
{
Description: This property denotes the container level immutability to object level immutability migration state. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableNfsV3RootSquash:
{
Description: Enable NFSv3 root squash on blob container. ,
Required: False ,
}
boolean ,
enableNfsV3AllSquash:
{
Description: Enable NFSv3 all squash on blob container. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the blob container. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted blob container. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the blob container was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: Blob container deletion time. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for soft deleted blob container. ,
Required: False ,
}
integer ,
defaultEncryptionScope:
{
Description: Default the container to use specified encryption scope for all writes. ,
Required: False ,
}
string ,
denyEncryptionScopeOverride:
{
Description: Block override of encryption scope from the container default. ,
Required: False ,
}
boolean ,
publicAccess:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access. ,
Enum:
{
Container: No description available. ,
Blob: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedTime:
{
Description: Returns the date and time the container was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
leaseStatus:
{
Description: The lease status of the container. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the container. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: A name-value pair to associate with the container as metadata. ,
Required: False ,
}
object ,
immutabilityPolicy:
{
Description: The ImmutabilityPolicy property of the container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: ImmutabilityPolicy Etag. ,
Required: False ,
}
string ,
updateHistory:
{
Description: The ImmutabilityPolicy update history of the blob container. ,
Required: False ,
}
[
{
update:
{
Description: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. ,
Enum:
{
put: No description available. ,
lock: No description available. ,
extend: No description available. ,
}
,
Required: False ,
}
enum ,
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
timestamp:
{
Description: Returns the date and time the ImmutabilityPolicy was updated. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
legalHold:
{
Description: The LegalHold property of the container. ,
Required: False ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: The list of LegalHold tags of a blob container. ,
Required: False ,
}
[
{
tag:
{
Description: The tag value. ,
Required: False ,
}
string ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who added the tag. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who added the tag. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who added the tag. ,
Required: False ,
}
string ,
}
,
]
,
protectedAppendWritesHistory:
{
Description: Protected append blob writes history. ,
Required: False ,
}
{
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
hasImmutabilityPolicy:
{
Description: 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. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: This is an immutable property, when set to true it enables object level immutability at the container level. ,
Required: False ,
}
boolean ,
timeStamp:
{
Description: Returns the date and time the object level immutability was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
migrationState:
{
Description: This property denotes the container level immutability to object level immutability migration state. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableNfsV3RootSquash:
{
Description: Enable NFSv3 root squash on blob container. ,
Required: False ,
}
boolean ,
enableNfsV3AllSquash:
{
Description: Enable NFSv3 all squash on blob container. ,
Required: False ,
}
boolean ,
}
,
}
BlobContainers_Update (new)
Description :  Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn't already exist.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
blobContainer:
{
Description: Properties to update for the blob container. ,
Required: True ,
}
{
properties:
{
Description: Properties of the blob container. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted blob container. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the blob container was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: Blob container deletion time. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for soft deleted blob container. ,
Required: False ,
}
integer ,
defaultEncryptionScope:
{
Description: Default the container to use specified encryption scope for all writes. ,
Required: False ,
}
string ,
denyEncryptionScopeOverride:
{
Description: Block override of encryption scope from the container default. ,
Required: False ,
}
boolean ,
publicAccess:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access. ,
Enum:
{
Container: No description available. ,
Blob: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedTime:
{
Description: Returns the date and time the container was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
leaseStatus:
{
Description: The lease status of the container. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the container. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: A name-value pair to associate with the container as metadata. ,
Required: False ,
}
object ,
immutabilityPolicy:
{
Description: The ImmutabilityPolicy property of the container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: ImmutabilityPolicy Etag. ,
Required: False ,
}
string ,
updateHistory:
{
Description: The ImmutabilityPolicy update history of the blob container. ,
Required: False ,
}
[
{
update:
{
Description: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. ,
Enum:
{
put: No description available. ,
lock: No description available. ,
extend: No description available. ,
}
,
Required: False ,
}
enum ,
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
timestamp:
{
Description: Returns the date and time the ImmutabilityPolicy was updated. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
legalHold:
{
Description: The LegalHold property of the container. ,
Required: False ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: The list of LegalHold tags of a blob container. ,
Required: False ,
}
[
{
tag:
{
Description: The tag value. ,
Required: False ,
}
string ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who added the tag. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who added the tag. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who added the tag. ,
Required: False ,
}
string ,
}
,
]
,
protectedAppendWritesHistory:
{
Description: Protected append blob writes history. ,
Required: False ,
}
{
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
hasImmutabilityPolicy:
{
Description: 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. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: This is an immutable property, when set to true it enables object level immutability at the container level. ,
Required: False ,
}
boolean ,
timeStamp:
{
Description: Returns the date and time the object level immutability was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
migrationState:
{
Description: This property denotes the container level immutability to object level immutability migration state. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableNfsV3RootSquash:
{
Description: Enable NFSv3 root squash on blob container. ,
Required: False ,
}
boolean ,
enableNfsV3AllSquash:
{
Description: Enable NFSv3 all squash on blob container. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the blob container. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted blob container. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the blob container was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: Blob container deletion time. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for soft deleted blob container. ,
Required: False ,
}
integer ,
defaultEncryptionScope:
{
Description: Default the container to use specified encryption scope for all writes. ,
Required: False ,
}
string ,
denyEncryptionScopeOverride:
{
Description: Block override of encryption scope from the container default. ,
Required: False ,
}
boolean ,
publicAccess:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access. ,
Enum:
{
Container: No description available. ,
Blob: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedTime:
{
Description: Returns the date and time the container was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
leaseStatus:
{
Description: The lease status of the container. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the container. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: A name-value pair to associate with the container as metadata. ,
Required: False ,
}
object ,
immutabilityPolicy:
{
Description: The ImmutabilityPolicy property of the container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: ImmutabilityPolicy Etag. ,
Required: False ,
}
string ,
updateHistory:
{
Description: The ImmutabilityPolicy update history of the blob container. ,
Required: False ,
}
[
{
update:
{
Description: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. ,
Enum:
{
put: No description available. ,
lock: No description available. ,
extend: No description available. ,
}
,
Required: False ,
}
enum ,
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
timestamp:
{
Description: Returns the date and time the ImmutabilityPolicy was updated. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
legalHold:
{
Description: The LegalHold property of the container. ,
Required: False ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: The list of LegalHold tags of a blob container. ,
Required: False ,
}
[
{
tag:
{
Description: The tag value. ,
Required: False ,
}
string ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who added the tag. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who added the tag. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who added the tag. ,
Required: False ,
}
string ,
}
,
]
,
protectedAppendWritesHistory:
{
Description: Protected append blob writes history. ,
Required: False ,
}
{
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
hasImmutabilityPolicy:
{
Description: 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. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: This is an immutable property, when set to true it enables object level immutability at the container level. ,
Required: False ,
}
boolean ,
timeStamp:
{
Description: Returns the date and time the object level immutability was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
migrationState:
{
Description: This property denotes the container level immutability to object level immutability migration state. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableNfsV3RootSquash:
{
Description: Enable NFSv3 root squash on blob container. ,
Required: False ,
}
boolean ,
enableNfsV3AllSquash:
{
Description: Enable NFSv3 all squash on blob container. ,
Required: False ,
}
boolean ,
}
,
}
BlobContainers_Get (new)
Description :  Gets properties of a specified container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the blob container. ,
Required: False ,
}
{
version:
{
Description: The version of the deleted blob container. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the blob container was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: Blob container deletion time. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for soft deleted blob container. ,
Required: False ,
}
integer ,
defaultEncryptionScope:
{
Description: Default the container to use specified encryption scope for all writes. ,
Required: False ,
}
string ,
denyEncryptionScopeOverride:
{
Description: Block override of encryption scope from the container default. ,
Required: False ,
}
boolean ,
publicAccess:
{
Description: Specifies whether data in the container may be accessed publicly and the level of access. ,
Enum:
{
Container: No description available. ,
Blob: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedTime:
{
Description: Returns the date and time the container was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
leaseStatus:
{
Description: The lease status of the container. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the container. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a container is of infinite or fixed duration, only when the container is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: A name-value pair to associate with the container as metadata. ,
Required: False ,
}
object ,
immutabilityPolicy:
{
Description: The ImmutabilityPolicy property of the container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
etag:
{
Description: ImmutabilityPolicy Etag. ,
Required: False ,
}
string ,
updateHistory:
{
Description: The ImmutabilityPolicy update history of the blob container. ,
Required: False ,
}
[
{
update:
{
Description: The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. ,
Enum:
{
put: No description available. ,
lock: No description available. ,
extend: No description available. ,
}
,
Required: False ,
}
enum ,
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
timestamp:
{
Description: Returns the date and time the ImmutabilityPolicy was updated. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who updated the ImmutabilityPolicy. ,
Required: False ,
}
string ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
legalHold:
{
Description: The LegalHold property of the container. ,
Required: False ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: The list of LegalHold tags of a blob container. ,
Required: False ,
}
[
{
tag:
{
Description: The tag value. ,
Required: False ,
}
string ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
objectIdentifier:
{
Description: Returns the Object ID of the user who added the tag. ,
Required: False ,
}
string ,
tenantId:
{
Description: Returns the Tenant ID that issued the token for the user who added the tag. ,
Required: False ,
}
string ,
upn:
{
Description: Returns the User Principal Name of the user who added the tag. ,
Required: False ,
}
string ,
}
,
]
,
protectedAppendWritesHistory:
{
Description: Protected append blob writes history. ,
Required: False ,
}
{
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
timestamp:
{
Description: Returns the date and time the tag was added. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
hasImmutabilityPolicy:
{
Description: 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. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: 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. ,
Required: False ,
}
{
enabled:
{
Description: This is an immutable property, when set to true it enables object level immutability at the container level. ,
Required: False ,
}
boolean ,
timeStamp:
{
Description: Returns the date and time the object level immutability was enabled. ,
Format: date-time ,
Required: False ,
}
string ,
migrationState:
{
Description: This property denotes the container level immutability to object level immutability migration state. ,
Enum:
{
InProgress: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enableNfsV3RootSquash:
{
Description: Enable NFSv3 root squash on blob container. ,
Required: False ,
}
boolean ,
enableNfsV3AllSquash:
{
Description: Enable NFSv3 all squash on blob container. ,
Required: False ,
}
boolean ,
}
,
}
BlobContainers_Delete (new)
Description :  Deletes specified container under its account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
BlobContainers_SetLegalHold (new)
Description :  Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
LegalHold:
{
Description: The LegalHold property that will be set to a blob container. ,
Required: True ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP. ,
Required: True ,
}
[
string ,
]
,
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP. ,
Required: True ,
}
[
string ,
]
,
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
BlobContainers_ClearLegalHold (new)
Description :  Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
LegalHold:
{
Description: The LegalHold property that will be clear from a blob container. ,
Required: True ,
}
{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP. ,
Required: True ,
}
[
string ,
]
,
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
hasLegalHold:
{
Description: 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. ,
Required: False ,
}
boolean ,
tags:
{
Description: Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP. ,
Required: True ,
}
[
string ,
]
,
allowProtectedAppendWritesAll:
{
Description: When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
BlobContainers_CreateOrUpdateImmutabilityPolicy (new)
Description :  Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
immutabilityPolicyName:
{
Description: The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: The ImmutabilityPolicy Properties that will be created or updated to a blob container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: True ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag. ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: True ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
}
,
}
BlobContainers_GetImmutabilityPolicy (new)
Description :  Gets the existing immutability policy along with the corresponding ETag in response headers and body.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
immutabilityPolicyName:
{
Description: The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag. ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: True ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
}
,
}
BlobContainers_DeleteImmutabilityPolicy (new)
Description :  Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, the only way is to delete the container after deleting all expired blobs inside the policy locked container.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/{immutabilityPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
immutabilityPolicyName:
{
Description: The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be 'default' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag. ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: True ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
}
,
}
BlobContainers_LockImmutabilityPolicy (new)
Description :  Sets the ImmutabilityPolicy to Locked state. The only action allowed on a Locked policy is ExtendImmutabilityPolicy action. ETag in If-Match is required for this operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/lock
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag. ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: True ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
}
,
}
BlobContainers_ExtendImmutabilityPolicy (new)
Description :  Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/immutabilityPolicies/default/extend
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: The ImmutabilityPolicy Properties that will be extended for a blob container. ,
Required: False ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: True ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: The ImmutabilityPolicy property of a blob container, including Id, resource name, resource type, Etag. ,
}
{
properties:
{
Description: The properties of an ImmutabilityPolicy of a blob container. ,
Required: True ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowProtectedAppendWritesAll:
{
Description: This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. ,
Required: False ,
}
boolean ,
}
,
}
,
}
BlobContainers_Lease (new)
Description :  The Lease Container operation establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/lease
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Lease Container request body. ,
Required: False ,
}
{
action:
{
Description: Specifies the lease action. Can be one of the available actions. ,
Enum:
{
Acquire: No description available. ,
Renew: No description available. ,
Change: No description available. ,
Release: No description available. ,
Break: No description available. ,
}
,
Required: True ,
}
enum ,
leaseId:
{
Description: Identifies the lease. Can be specified in any valid GUID string format. ,
Required: False ,
}
string ,
breakPeriod:
{
Description: Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. ,
Required: False ,
}
integer ,
leaseDuration:
{
Description: Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. ,
Required: False ,
}
integer ,
proposedLeaseId:
{
Description: Optional for acquire, required for change. Proposed lease ID, in a GUID string format. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
leaseId:
{
Description: Returned unique lease ID that must be included with any request to delete the container, or to renew, change, or release the lease. ,
Required: False ,
}
string ,
leaseTimeSeconds:
{
Description: Approximate time remaining in the lease period, in seconds. ,
Required: False ,
}
string ,
}
BlobContainers_ObjectLevelWorm (new)
Description :  This operation migrates a blob container from container level WORM to object level immutability enabled container. Prerequisites require a container level immutability policy either in locked or unlocked state, Account level versioning must be enabled and there should be no Legal hold on the container.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/migrate
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
containerName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileServices_List (new)
Description :  List all file services in storage accounts
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of file services returned. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of File services in storage account. ,
Required: False ,
}
{
cors:
{
Description: Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
shareDeleteRetentionPolicy:
{
Description: The file service properties for share soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
protocolSettings:
{
Description: Protocol settings for file service ,
Required: False ,
}
{
smb:
{
Description: Setting for SMB protocol ,
Required: False ,
}
{
multichannel:
{
Description: Multichannel setting. Applies to Premium FileStorage only. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether multichannel is enabled ,
Required: False ,
}
boolean ,
}
,
versions:
{
Description: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
authenticationMethods:
{
Description: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
kerberosTicketEncryption:
{
Description: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' ,
Required: False ,
}
string ,
channelEncryption:
{
Description: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku name and tier. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileServices_SetServiceProperties (new)
Description :  Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
FileServicesName:
{
Description: The name of the file Service within the specified storage account. File Service Name must be "default" ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. ,
Required: True ,
}
{
properties:
{
Description: The properties of File services in storage account. ,
Required: False ,
}
{
cors:
{
Description: Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
shareDeleteRetentionPolicy:
{
Description: The file service properties for share soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
protocolSettings:
{
Description: Protocol settings for file service ,
Required: False ,
}
{
smb:
{
Description: Setting for SMB protocol ,
Required: False ,
}
{
multichannel:
{
Description: Multichannel setting. Applies to Premium FileStorage only. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether multichannel is enabled ,
Required: False ,
}
boolean ,
}
,
versions:
{
Description: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
authenticationMethods:
{
Description: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
kerberosTicketEncryption:
{
Description: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' ,
Required: False ,
}
string ,
channelEncryption:
{
Description: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku name and tier. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of File services in storage account. ,
Required: False ,
}
{
cors:
{
Description: Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
shareDeleteRetentionPolicy:
{
Description: The file service properties for share soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
protocolSettings:
{
Description: Protocol settings for file service ,
Required: False ,
}
{
smb:
{
Description: Setting for SMB protocol ,
Required: False ,
}
{
multichannel:
{
Description: Multichannel setting. Applies to Premium FileStorage only. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether multichannel is enabled ,
Required: False ,
}
boolean ,
}
,
versions:
{
Description: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
authenticationMethods:
{
Description: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
kerberosTicketEncryption:
{
Description: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' ,
Required: False ,
}
string ,
channelEncryption:
{
Description: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku name and tier. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileServices_GetServiceProperties (new)
Description :  Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
FileServicesName:
{
Description: The name of the file Service within the specified storage account. File Service Name must be "default" ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of File services in storage account. ,
Required: False ,
}
{
cors:
{
Description: Specifies CORS rules for the File service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the File service. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
shareDeleteRetentionPolicy:
{
Description: The file service properties for share soft delete. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether DeleteRetentionPolicy is enabled. ,
Required: False ,
}
boolean ,
days:
{
Description: 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. ,
Required: False ,
}
integer ,
allowPermanentDelete:
{
Description: This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. ,
Required: False ,
}
boolean ,
}
,
protocolSettings:
{
Description: Protocol settings for file service ,
Required: False ,
}
{
smb:
{
Description: Setting for SMB protocol ,
Required: False ,
}
{
multichannel:
{
Description: Multichannel setting. Applies to Premium FileStorage only. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether multichannel is enabled ,
Required: False ,
}
boolean ,
}
,
versions:
{
Description: SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
authenticationMethods:
{
Description: SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
kerberosTicketEncryption:
{
Description: Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' ,
Required: False ,
}
string ,
channelEncryption:
{
Description: SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: Sku name and tier. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileServices_ListServiceUsages (new)
Description :  Gets the usages of file service in storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}/usages
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
FileServicesName:
{
Description: The name of the file Service within the specified storage account. File Service Name must be "default" ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of file service usages to be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: List of file service usages returned. ,
Required: False ,
}
[
{
properties:
{
Description: File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula. ,
Required: False ,
}
{
storageAccountLimits:
{
Description: Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account. ,
Required: False ,
}
{
maxFileShares:
{
Description: The maximum number of file shares limit for the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedStorageGiB:
{
Description: The maximum provisioned storage quota limit in gibibytes for the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedIOPS:
{
Description: The maximum provisioned IOPS limit for the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedBandwidthMiBPerSec:
{
Description: The maximum provisioned bandwidth limit in mebibytes per second for the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
fileShareLimits:
{
Description: Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account. ,
Required: False ,
}
{
minProvisionedStorageGiB:
{
Description: The minimum provisioned storage quota limit in gibibytes for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedStorageGiB:
{
Description: The maximum provisioned storage quota limit in gibibytes for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
minProvisionedIOPS:
{
Description: The minimum provisioned IOPS limit for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedIOPS:
{
Description: The maximum provisioned IOPS limit for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
minProvisionedBandwidthMiBPerSec:
{
Description: The minimum provisioned bandwidth limit in mebibytes per second for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedBandwidthMiBPerSec:
{
Description: The maximum provisioned bandwidth limit in mebibytes per second for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
fileShareRecommendations:
{
Description: Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account. ,
Required: False ,
}
{
baseIOPS:
{
Description: The base IOPS in the file share provisioned IOPS recommendation formula. ,
Format: int32 ,
Required: False ,
}
integer ,
ioScalar:
{
Description: The scalar for IO in the file share provisioned IOPS recommendation formula. ,
Format: double ,
Required: False ,
}
number ,
baseBandwidthMiBPerSec:
{
Description: The base bandwidth in the file share provisioned bandwidth recommendation formula. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidthScalar:
{
Description: The scalar for bandwidth in the file share provisioned bandwidth recommendation formula. ,
Format: double ,
Required: False ,
}
number ,
}
,
burstingConstants:
{
Description: Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account. ,
Required: False ,
}
{
burstFloorIOPS:
{
Description: The guaranteed floor of burst IOPS for small file shares. ,
Format: int32 ,
Required: False ,
}
integer ,
burstIOScalar:
{
Description: The scalar against provisioned IOPS in the file share included burst IOPS formula. ,
Format: double ,
Required: False ,
}
number ,
burstTimeframeSeconds:
{
Description: The time frame for bursting in seconds in the file share maximum burst credits for IOPS formula. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageAccountUsage:
{
Description: Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account. ,
Required: False ,
}
{
liveShares:
{
Description: Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account. ,
Required: False ,
}
{
fileShareCount:
{
Description: The total number of file shares. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageGiB:
{
Description: The total provisioned storage quota in gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPS:
{
Description: The total provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMiBPerSec:
{
Description: The total provisioned bandwidth in mebibytes per second. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
softDeletedShares:
{
Description: Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account. ,
Required: False ,
}
{
fileShareCount:
{
Description: The total number of file shares. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageGiB:
{
Description: The total provisioned storage quota in gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPS:
{
Description: The total provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMiBPerSec:
{
Description: The total provisioned bandwidth in mebibytes per second. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of file service usages. Returned when total number of requested file service usages exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileServices_GetServiceUsage (new)
Description :  Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/{FileServicesName}/usages/{fileServiceUsagesName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
FileServicesName:
{
Description: The name of the file Service within the specified storage account. File Service Name must be "default" ,
Required: True ,
}
string ,
fileServiceUsagesName:
{
Description: The name of the file service usage. File Service Usage Name must be "default" ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: File service usage in storage account including account limits, file share limits and constants used in recommendations and bursting formula. ,
Required: False ,
}
{
storageAccountLimits:
{
Description: Maximum provisioned storage, IOPS, bandwidth and number of file shares limits for the storage account. ,
Required: False ,
}
{
maxFileShares:
{
Description: The maximum number of file shares limit for the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedStorageGiB:
{
Description: The maximum provisioned storage quota limit in gibibytes for the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedIOPS:
{
Description: The maximum provisioned IOPS limit for the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedBandwidthMiBPerSec:
{
Description: The maximum provisioned bandwidth limit in mebibytes per second for the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
fileShareLimits:
{
Description: Minimum and maximum provisioned storage, IOPS and bandwidth limits for a file share in the storage account. ,
Required: False ,
}
{
minProvisionedStorageGiB:
{
Description: The minimum provisioned storage quota limit in gibibytes for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedStorageGiB:
{
Description: The maximum provisioned storage quota limit in gibibytes for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
minProvisionedIOPS:
{
Description: The minimum provisioned IOPS limit for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedIOPS:
{
Description: The maximum provisioned IOPS limit for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
minProvisionedBandwidthMiBPerSec:
{
Description: The minimum provisioned bandwidth limit in mebibytes per second for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
maxProvisionedBandwidthMiBPerSec:
{
Description: The maximum provisioned bandwidth limit in mebibytes per second for a file share in the storage account. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
fileShareRecommendations:
{
Description: Constants used for calculating recommended provisioned IOPS and bandwidth for a file share in the storage account. ,
Required: False ,
}
{
baseIOPS:
{
Description: The base IOPS in the file share provisioned IOPS recommendation formula. ,
Format: int32 ,
Required: False ,
}
integer ,
ioScalar:
{
Description: The scalar for IO in the file share provisioned IOPS recommendation formula. ,
Format: double ,
Required: False ,
}
number ,
baseBandwidthMiBPerSec:
{
Description: The base bandwidth in the file share provisioned bandwidth recommendation formula. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidthScalar:
{
Description: The scalar for bandwidth in the file share provisioned bandwidth recommendation formula. ,
Format: double ,
Required: False ,
}
number ,
}
,
burstingConstants:
{
Description: Constants used for calculating included burst IOPS and maximum burst credits for IOPS for a file share in the storage account. ,
Required: False ,
}
{
burstFloorIOPS:
{
Description: The guaranteed floor of burst IOPS for small file shares. ,
Format: int32 ,
Required: False ,
}
integer ,
burstIOScalar:
{
Description: The scalar against provisioned IOPS in the file share included burst IOPS formula. ,
Format: double ,
Required: False ,
}
number ,
burstTimeframeSeconds:
{
Description: The time frame for bursting in seconds in the file share maximum burst credits for IOPS formula. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
storageAccountUsage:
{
Description: Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares and soft-deleted shares in the account. ,
Required: False ,
}
{
liveShares:
{
Description: Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account. ,
Required: False ,
}
{
fileShareCount:
{
Description: The total number of file shares. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageGiB:
{
Description: The total provisioned storage quota in gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPS:
{
Description: The total provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMiBPerSec:
{
Description: The total provisioned bandwidth in mebibytes per second. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
softDeletedShares:
{
Description: Usage of provisioned storage, IOPS, bandwidth and number of file shares across all live shares or soft-deleted shares in the account. ,
Required: False ,
}
{
fileShareCount:
{
Description: The total number of file shares. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageGiB:
{
Description: The total provisioned storage quota in gibibytes. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPS:
{
Description: The total provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMiBPerSec:
{
Description: The total provisioned bandwidth in mebibytes per second. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_List (new)
Description :  Lists all shares.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional. Specified maximum number of shares that can be included in the list. ,
Required: False ,
}
string ,
$filter:
{
Description: Optional. When specified, only share names starting with the filter will be listed. ,
Required: False ,
}
string ,
$expand:
{
Description: Optional, used to expand the properties within share's properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ',' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of file shares returned. ,
Required: False ,
}
[
{
properties:
{
Description: The file share properties be listed out. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
Description: The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
Description: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
Description: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
Description: Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
Description: Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
Description: Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
Description: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
Description: Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
Description: The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
Description: The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of shares. Returned when total number of requested shares exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Create (new)
Description :  Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the file share within the specified storage account. File share 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. ,
Required: True ,
}
string ,
fileShare:
{
Description: Properties of the file share to create. ,
Required: True ,
}
{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
Description: The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
Description: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
Description: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
Description: Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
Description: Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
Description: Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
Description: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
Description: Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
Description: The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
Description: The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
$expand:
{
Description: Optional, used to expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ',' ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
Description: The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
Description: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
Description: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
Description: Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
Description: Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
Description: Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
Description: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
Description: Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
Description: The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
Description: The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
Description: The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
Description: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
Description: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
Description: Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
Description: Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
Description: Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
Description: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
Description: Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
Description: The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
Description: The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Update (new)
Description :  Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the file share within the specified storage account. File share 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. ,
Required: True ,
}
string ,
fileShare:
{
Description: Properties to update for the file share. ,
Required: True ,
}
{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
Description: The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
Description: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
Description: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
Description: Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
Description: Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
Description: Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
Description: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
Description: Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
Description: The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
Description: The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
Description: The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
Description: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
Description: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
Description: Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
Description: Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
Description: Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
Description: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
Description: Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
Description: The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
Description: The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Get (new)
Description :  Gets properties of a specified share.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the file share within the specified storage account. File share 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: Optional, used to expand the properties within share's properties. Valid values are: stats. Should be passed as a string with delimiter ','. ,
Required: False ,
}
string ,
x-ms-snapshot:
{
Description: Optional, used to retrieve properties of a snapshot. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the file share. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the share was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: A name-value pair to associate with the share as metadata. ,
Required: False ,
}
object ,
shareQuota:
{
Description: The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIops:
{
Description: The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedBandwidthMibps:
{
Description: The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth. ,
Format: int32 ,
Required: False ,
}
integer ,
includedBurstIops:
{
Description: The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstCreditsForIops:
{
Description: The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: int64 ,
Required: False ,
}
integer ,
nextAllowedQuotaDowngradeTime:
{
Description: Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedIopsDowngradeTime:
{
Description: Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
nextAllowedProvisionedBandwidthDowngradeTime:
{
Description: Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type. ,
Format: date-time ,
Required: False ,
}
string ,
enabledProtocols:
{
Description: The authentication protocol that is used for the file share. Can only be specified when creating a share. ,
Enum:
{
SMB: No description available. ,
NFS: No description available. ,
}
,
Required: False ,
}
enum ,
rootSquash:
{
Description: The property is for NFS share only. The default is NoRootSquash. ,
Enum:
{
NoRootSquash: No description available. ,
RootSquash: No description available. ,
AllSquash: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The version of the share. ,
Required: False ,
}
string ,
deleted:
{
Description: Indicates whether the share was deleted. ,
Required: False ,
}
boolean ,
deletedTime:
{
Description: The deleted time if the share was deleted. ,
Format: date-time ,
Required: False ,
}
string ,
remainingRetentionDays:
{
Description: Remaining retention days for share that was soft deleted. ,
Required: False ,
}
integer ,
accessTier:
{
Description: Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. ,
Enum:
{
TransactionOptimized: No description available. ,
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
accessTierChangeTime:
{
Description: Indicates the last modification time for share access tier. ,
Format: date-time ,
Required: False ,
}
string ,
accessTierStatus:
{
Description: Indicates if there is a pending transition for access tier. ,
Required: False ,
}
string ,
shareUsageBytes:
{
Description: The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files. ,
Format: int64 ,
Required: False ,
}
integer ,
leaseStatus:
{
Description: The lease status of the share. ,
Enum:
{
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
leaseState:
{
Description: Lease state of the share. ,
Enum:
{
Available: No description available. ,
Leased: No description available. ,
Expired: No description available. ,
Breaking: No description available. ,
Broken: No description available. ,
}
,
Required: False ,
}
enum ,
leaseDuration:
{
Description: Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased. ,
Enum:
{
Infinite: No description available. ,
Fixed: No description available. ,
}
,
Required: False ,
}
enum ,
signedIdentifiers:
{
Description: List of stored access policies specified on the share. ,
Required: False ,
}
[
{
id:
{
Description: An unique identifier of the stored access policy. ,
Required: False ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: List of abbreviated permissions. ,
Required: False ,
}
string ,
}
,
}
,
]
,
snapshotTime:
{
Description: Creation time of share snapshot returned in the response of list shares with expand param "snapshots". ,
Format: date-time ,
Required: False ,
}
string ,
fileSharePaidBursting:
{
Description: File Share Paid Bursting properties. ,
Required: False ,
}
{
paidBurstingEnabled:
{
Description: Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. ,
Required: False ,
}
boolean ,
paidBurstingMaxIops:
{
Description: The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
paidBurstingMaxBandwidthMibps:
{
Description: The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Delete (new)
Description :  Deletes specified share under its account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the file share within the specified storage account. File share 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
x-ms-snapshot:
{
Description: Optional, used to delete a snapshot. ,
Required: False ,
}
string ,
$include:
{
Description: Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Restore (new)
Description :  Restore a file share within a valid retention days if share soft delete is enabled
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/restore
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the file share within the specified storage account. File share 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. ,
Required: True ,
}
string ,
deletedShare:
{
Required: True ,
}
{
deletedShareName:
{
Description: Required. Identify the name of the deleted share that will be restored. ,
Required: True ,
}
string ,
deletedShareVersion:
{
Description: Required. Identify the version of the deleted share that will be restored. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
FileShares_Lease (new)
Description :  The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}/lease
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
shareName:
{
Description: The name of the file share within the specified storage account. File share 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Lease Share request body. ,
Required: False ,
}
{
action:
{
Description: Specifies the lease action. Can be one of the available actions. ,
Enum:
{
Acquire: No description available. ,
Renew: No description available. ,
Change: No description available. ,
Release: No description available. ,
Break: No description available. ,
}
,
Required: True ,
}
enum ,
leaseId:
{
Description: Identifies the lease. Can be specified in any valid GUID string format. ,
Required: False ,
}
string ,
breakPeriod:
{
Description: Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. ,
Format: int32 ,
Required: False ,
}
integer ,
leaseDuration:
{
Description: Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. ,
Format: int32 ,
Required: False ,
}
integer ,
proposedLeaseId:
{
Description: Optional for acquire, required for change. Proposed lease ID, in a GUID string format. ,
Required: False ,
}
string ,
}
,
x-ms-snapshot:
{
Description: Optional. Specify the snapshot time to lease a snapshot. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. ,
}
string ,
}
,
$schema:
{
Description: Lease Share response schema. ,
}
{
leaseId:
{
Description: Returned unique lease ID that must be included with any request to delete the share, or to renew, change, or release the lease. ,
Required: False ,
}
string ,
leaseTimeSeconds:
{
Description: Approximate time remaining in the lease period, in seconds. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_List (new)
Description :  Gets list of effective NetworkSecurityPerimeterConfiguration for storage account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Network Security Perimeter configurations ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Network Security Perimeter Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of provisioning issue ,
Required: False ,
}
{
issueType:
{
Description: Type of issue ,
Enum:
{
Unknown: No description available. ,
ConfigurationPropagationFailure: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the issue. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: NetworkSecurityPerimeter related information ,
Required: False ,
}
{
id:
{
Description: The ARM identifier of the resource ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Network Security Perimeter profile ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Required: False ,
}
number ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The ARM identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The ARM identifier of the resource ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Diagnostic settings version ,
Required: False ,
}
number ,
enabledLogCategories:
{
Description: Enabled logging categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Get (new)
Description :  Gets effective NetworkSecurityPerimeterConfiguration for association
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
networkSecurityPerimeterConfigurationName:
{
Description: The name for Network Security Perimeter configuration ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Network Security Perimeter Configuration ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of Network Security Perimeter configuration propagation ,
Enum:
{
Accepted: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of Provisioning Issues if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Properties of provisioning issue ,
Required: False ,
}
{
issueType:
{
Description: Type of issue ,
Enum:
{
Unknown: No description available. ,
ConfigurationPropagationFailure: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the issue. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: NetworkSecurityPerimeter related information ,
Required: False ,
}
{
id:
{
Description: The ARM identifier of the resource ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access Mode of the resource association ,
Enum:
{
Enforced: No description available. ,
Learning: No description available. ,
Audit: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Network Security Perimeter profile ,
Required: False ,
}
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Required: False ,
}
number ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the resource ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: No description available. ,
Outbound: No description available. ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The ARM identifier of subscription ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: NetworkSecurityPerimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The ARM identifier of the resource ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Guid of the resource ,
Required: False ,
}
string ,
location:
{
Description: Location of the resource ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: FQDN for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Diagnostic settings version ,
Required: False ,
}
number ,
enabledLogCategories:
{
Description: Enabled logging categories ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkSecurityPerimeterConfigurations_Reconcile (new)
Description :  Refreshes any information about the association.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
networkSecurityPerimeterConfigurationName:
{
Description: The name for Network Security Perimeter configuration ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
QueueServices_List (new)
Description :  List all queue services for the storage account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of queue services returned. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a storage account’s Queue service. ,
Required: False ,
}
{
cors:
{
Description: 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. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
QueueServices_SetServiceProperties (new)
Description :  Sets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queueServiceName:
{
Description: The name of the Queue Service within the specified storage account. Queue Service Name must be 'default' ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of a storage account’s Queue service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified. ,
Required: True ,
}
{
properties:
{
Description: The properties of a storage account’s Queue service. ,
Required: False ,
}
{
cors:
{
Description: 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. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a storage account’s Queue service. ,
Required: False ,
}
{
cors:
{
Description: 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. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
QueueServices_GetServiceProperties (new)
Description :  Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/{queueServiceName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queueServiceName:
{
Description: The name of the Queue Service within the specified storage account. Queue Service Name must be 'default' ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a storage account’s Queue service. ,
Required: False ,
}
{
cors:
{
Description: 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. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Queue_Create (new)
Description :  Creates a new queue with the specified queue name, under the specified account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queueName:
{
Description: 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. ,
Required: True ,
}
string ,
queue:
{
Description: Queue properties and metadata to be created with ,
Required: True ,
}
{
properties:
{
Description: Queue resource properties. ,
Required: False ,
}
{
metadata:
{
Description: A name-value pair that represents queue metadata. ,
Required: False ,
}
object ,
approximateMessageCount:
{
Description: 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. ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Queue resource properties. ,
Required: False ,
}
{
metadata:
{
Description: A name-value pair that represents queue metadata. ,
Required: False ,
}
object ,
approximateMessageCount:
{
Description: 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. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Queue_Update (new)
Description :  Creates a new queue with the specified queue name, under the specified account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queueName:
{
Description: 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. ,
Required: True ,
}
string ,
queue:
{
Description: Queue properties and metadata to be created with ,
Required: True ,
}
{
properties:
{
Description: Queue resource properties. ,
Required: False ,
}
{
metadata:
{
Description: A name-value pair that represents queue metadata. ,
Required: False ,
}
object ,
approximateMessageCount:
{
Description: 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. ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Queue resource properties. ,
Required: False ,
}
{
metadata:
{
Description: A name-value pair that represents queue metadata. ,
Required: False ,
}
object ,
approximateMessageCount:
{
Description: 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. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Queue_Get (new)
Description :  Gets the queue with the specified queue name, under the specified account if it exists.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queueName:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Queue resource properties. ,
Required: False ,
}
{
metadata:
{
Description: A name-value pair that represents queue metadata. ,
Required: False ,
}
object ,
approximateMessageCount:
{
Description: 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. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Queue_Delete (new)
Description :  Deletes the queue with the specified queue name, under the specified account if it exists.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues/{queueName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
queueName:
{
Description: 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. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Queue_List (new)
Description :  Gets a list of all the queues under the specified storage account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/queueServices/default/queues
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, a maximum number of queues that should be included in a list queue response ,
Required: False ,
}
string ,
$filter:
{
Description: Optional, When specified, only the queues with a name starting with the given filter will be listed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of queues returned. ,
Required: False ,
}
[
{
properties:
{
Description: List Queue resource properties. ,
Required: False ,
}
{
metadata:
{
Description: A name-value pair that represents queue metadata. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to list next page of queues ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Lists all of the available Storage Rest API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Storage/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Storage operations supported by the Storage resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: Display metadata associated with the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft Storage. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed etc. ,
Required: False ,
}
string ,
operation:
{
Description: Type of operation: get, read, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin of operations. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of operation, include metric specifications. ,
Required: False ,
}
{
serviceSpecification:
{
Description: One property of operation, include metric specifications. ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specifications of operation. ,
Required: False ,
}
[
{
name:
{
Description: Name of metric specification. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of metric specification. ,
Required: False ,
}
string ,
displayDescription:
{
Description: Display description of metric specification. ,
Required: False ,
}
string ,
unit:
{
Description: Unit could be Bytes or Count. ,
Required: False ,
}
string ,
dimensions:
{
Description: Dimensions of blobs, including blob type and access tier. ,
Required: False ,
}
[
{
name:
{
Description: Display name of dimension. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of dimension. ,
Required: False ,
}
string ,
}
,
]
,
aggregationType:
{
Description: Aggregation type could be Average. ,
Required: False ,
}
string ,
fillGapWithZero:
{
Description: The property to decide fill gap with zero or not. ,
Required: False ,
}
boolean ,
category:
{
Description: The category this metric specification belong to, could be Capacity. ,
Required: False ,
}
string ,
resourceIdDimensionNameOverride:
{
Description: Account Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}
Skus_List (new)
Description :  Lists the available SKUs supported by Microsoft.Storage for given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Storage/skus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Get the list result of storage SKUs and their properties. ,
Required: False ,
}
[
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
resourceType:
{
Description: The type of the resource, usually it is 'storageAccounts'. ,
Required: False ,
}
string ,
kind:
{
Description: Indicates the type of storage account. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
locations:
{
Description: The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). ,
Required: False ,
}
[
string ,
]
,
capabilities:
{
Description: The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. ,
Required: False ,
}
[
{
name:
{
Description: The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc. ,
Required: False ,
}
string ,
value:
{
Description: A string value to indicate states of given capability. Possibly 'true' or 'false'. ,
Required: False ,
}
string ,
}
,
]
,
restrictions:
{
Description: The restrictions because of which SKU cannot be used. This is empty if there are no restrictions. ,
Required: False ,
}
[
{
type:
{
Description: The type of restrictions. As of now only possible value for this is location. ,
Required: False ,
}
string ,
values:
{
Description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
reasonCode:
{
Description: The reason for the restriction. As of now this can be "QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. The "NotAvailableForSubscription" is related to capacity at DC. ,
Enum:
{
QuotaId: No description available. ,
NotAvailableForSubscription: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
StorageAccounts_CheckNameAvailability (new)
Description :  Checks that the storage account name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability
{
accountName:
{
Description: 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. ,
Required: True ,
}
{
name:
{
Description: The storage account name. ,
Required: True ,
}
string ,
type:
{
Description: The type of resource, Microsoft.Storage/storageAccounts ,
Enum:
{
Microsoft.Storage/storageAccounts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used. ,
Required: False ,
}
boolean ,
reason:
{
Description: Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false. ,
Enum:
{
AccountNameInvalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Gets an error message explaining the Reason value in more detail. ,
Required: False ,
}
string ,
}
StorageAccounts_Create (new)
Description :  Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the created account. ,
Required: True ,
}
{
sku:
{
Description: Required. Gets or sets the SKU name. ,
Required: True ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Required. Indicates the type of storage account. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: True ,
}
enum ,
location:
{
Description: 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. ,
Required: True ,
}
string ,
extendedLocation:
{
Description: Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: 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. ,
Required: False ,
}
object ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The parameters used to create the storage account. ,
Required: False ,
}
{
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
customDomain:
{
Description: User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Required if directoryServiceOptions are AD, optional if they are AADKERB. ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. ,
Required: True ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. ,
Required: True ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID). ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01. ,
Required: False ,
}
boolean ,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the new containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Required if directoryServiceOptions are AD, optional if they are AADKERB. ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. ,
Required: True ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. ,
Required: True ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID). ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}
StorageAccounts_Delete (new)
Description :  Deletes a storage account in Microsoft Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
StorageAccounts_GetProperties (new)
Description :  Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: May be used to expand the properties within account's properties. By default, data is not included when fetching properties. Currently we only support geoReplicationStats and blobRestoreStatus. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Required if directoryServiceOptions are AD, optional if they are AADKERB. ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. ,
Required: True ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. ,
Required: True ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID). ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}
StorageAccounts_Update (new)
Description :  The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for the updated account. ,
Required: True ,
}
{
sku:
{
Description: Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can accounts of those SKU names be updated to any other value. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Gets or sets a list of key value pairs that describe the resource. These tags can be used in 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 no greater in length than 128 characters and a value no greater in length than 256 characters. ,
Required: False ,
}
object ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The parameters used when updating a storage account. ,
Required: False ,
}
{
customDomain:
{
Description: Custom domain assigned to the storage account by the user. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
encryption:
{
Description: Not applicable. Azure Storage encryption at rest is enabled by default for all storage accounts and cannot be disabled. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Required if directoryServiceOptions are AD, optional if they are AADKERB. ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. ,
Required: True ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. ,
Required: True ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID). ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. Value is optional but if passed in, must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Optional. Indicates the type of storage account. Currently only StorageV2 value supported by server. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Required if directoryServiceOptions are AD, optional if they are AADKERB. ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. ,
Required: True ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. ,
Required: True ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID). ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}
DeletedAccounts_List (new)
Description :  Lists deleted accounts under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Storage/deletedAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of deleted accounts and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the deleted account. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Full resource id of the original storage account. ,
Required: False ,
}
string ,
location:
{
Description: Location of the deleted account. ,
Required: False ,
}
string ,
restoreReference:
{
Description: Can be used to attempt recovering this deleted account via PutStorageAccount API. ,
Required: False ,
}
string ,
creationTime:
{
Description: Creation time of the deleted account. ,
Required: False ,
}
string ,
deletionTime:
{
Description: Deletion time of the deleted account. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of deleted accounts. Returned when total number of requested deleted accounts exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
DeletedAccounts_Get (new)
Description :  Get properties of specified deleted account resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/deletedAccounts/{deletedAccountName}
{
deletedAccountName:
{
Description: Name of the deleted storage account. ,
Required: True ,
}
string ,
location:
{
Description: The location of the deleted storage account. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the deleted account. ,
Required: False ,
}
{
storageAccountResourceId:
{
Description: Full resource id of the original storage account. ,
Required: False ,
}
string ,
location:
{
Description: Location of the deleted account. ,
Required: False ,
}
string ,
restoreReference:
{
Description: Can be used to attempt recovering this deleted account via PutStorageAccount API. ,
Required: False ,
}
string ,
creationTime:
{
Description: Creation time of the deleted account. ,
Required: False ,
}
string ,
deletionTime:
{
Description: Deletion time of the deleted account. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
StorageAccounts_List (new)
Description :  Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of storage accounts and their properties. ,
Required: False ,
}
[
{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Required if directoryServiceOptions are AD, optional if they are AADKERB. ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. ,
Required: True ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. ,
Required: True ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID). ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of storage accounts. Returned when total number of requested storage accounts exceed maximum page size. ,
Required: False ,
}
string ,
}
StorageAccounts_ListByResourceGroup (new)
Description :  Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of storage accounts and their properties. ,
Required: False ,
}
[
{
sku:
{
Description: Gets the SKU. ,
Required: False ,
}
{
name:
{
Description: The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
tier:
{
Description: The SKU tier. This is based on the SKU name. ,
Enum:
{
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Gets the Kind. ,
Enum:
{
Storage: No description available. ,
StorageV2: No description available. ,
BlobStorage: No description available. ,
FileStorage: No description available. ,
BlockBlobStorage: No description available. ,
}
,
Required: False ,
}
enum ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: The extendedLocation of the resource. ,
Required: False ,
}
{
name:
{
Description: The name of the extended location. ,
Required: False ,
}
string ,
type:
{
Description: The type of the extended location. ,
Enum:
{
EdgeZone: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: Properties of the storage account. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the status of the storage account at the time the operation was called. ,
Enum:
{
Creating: No description available. ,
ResolvingDNS: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
primaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
primaryLocation:
{
Description: Gets the location of the primary data center for the storage account. ,
Required: False ,
}
string ,
statusOfPrimary:
{
Description: Gets the status indicating whether the primary location of the storage account is available or unavailable. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastGeoFailoverTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
secondaryLocation:
{
Description: Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS. ,
Required: False ,
}
string ,
statusOfSecondary:
{
Description: 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. ,
Enum:
{
available: No description available. ,
unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the storage account in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
customDomain:
{
Description: Gets the custom domain the user assigned to this storage account. ,
Required: False ,
}
{
name:
{
Description: Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. ,
Required: True ,
}
string ,
useSubDomainName:
{
Description: Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. ,
Required: False ,
}
boolean ,
}
,
sasPolicy:
{
Description: SasPolicy assigned to the storage account. ,
Required: False ,
}
{
sasExpirationPeriod:
{
Description: The SAS expiration period, DD.HH:MM:SS. ,
Required: True ,
}
string ,
expirationAction:
{
Description: The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. ,
Enum:
{
Log: No description available. ,
Block: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
keyPolicy:
{
Description: KeyPolicy assigned to the storage account. ,
Required: False ,
}
{
keyExpirationPeriodInDays:
{
Description: The key expiration period in days. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
keyCreationTime:
{
Description: Storage account keys creation time. ,
Required: False ,
}
{
key1:
{
Format: date-time ,
Required: False ,
}
string ,
key2:
{
Format: date-time ,
Required: False ,
}
string ,
}
,
secondaryEndpoints:
{
Description: 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. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
microsoftEndpoints:
{
Description: Gets the microsoft routing storage endpoints. ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
queue:
{
Description: Gets the queue endpoint. ,
Required: False ,
}
string ,
table:
{
Description: Gets the table endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
internetEndpoints:
{
Description: Gets the internet routing storage endpoints ,
Required: False ,
}
{
blob:
{
Description: Gets the blob endpoint. ,
Required: False ,
}
string ,
file:
{
Description: Gets the file endpoint. ,
Required: False ,
}
string ,
web:
{
Description: Gets the web endpoint. ,
Required: False ,
}
string ,
dfs:
{
Description: Gets the dfs endpoint. ,
Required: False ,
}
string ,
}
,
}
,
encryption:
{
Description: Encryption settings to be used for server-side encryption for the storage account. ,
Required: False ,
}
{
services:
{
Description: List of services which support encryption. ,
Required: False ,
}
{
blob:
{
Description: The encryption function of the blob storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
file:
{
Description: The encryption function of the file storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
table:
{
Description: The encryption function of the table storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
queue:
{
Description: The encryption function of the queue storage service. ,
Required: False ,
}
{
enabled:
{
Description: A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. ,
Required: False ,
}
boolean ,
lastEnabledTime:
{
Description: Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: 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. ,
Enum:
{
Service: No description available. ,
Account: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.Keyvault: No description available. ,
}
,
Required: False ,
}
enum ,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
keyvaultproperties:
{
Description: Properties provided by key vault. ,
Required: False ,
}
{
keyname:
{
Description: The name of KeyVault key. ,
Required: False ,
}
string ,
keyversion:
{
Description: The version of KeyVault key. ,
Required: False ,
}
string ,
keyvaulturi:
{
Description: The Uri of KeyVault. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
currentVersionedKeyExpirationTimestamp:
{
Description: This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity to be used with service-side encryption at rest. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. ,
Required: False ,
}
string ,
federatedIdentityClientId:
{
Description: ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. ,
Required: False ,
}
string ,
}
,
}
,
accessTier:
{
Description: Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type. ,
Enum:
{
Hot: No description available. ,
Cool: No description available. ,
Premium: No description available. ,
Cold: No description available. ,
}
,
Required: False ,
}
enum ,
azureFilesIdentityBasedAuthentication:
{
Description: Provides the identity based authentication settings for Azure Files. ,
Required: False ,
}
{
directoryServiceOptions:
{
Description: Indicates the directory service used. Note that this enum may be extended in the future. ,
Enum:
{
None: No description available. ,
AADDS: No description available. ,
AD: No description available. ,
AADKERB: No description available. ,
}
,
Required: True ,
}
enum ,
activeDirectoryProperties:
{
Description: Required if directoryServiceOptions are AD, optional if they are AADKERB. ,
Required: False ,
}
{
domainName:
{
Description: Specifies the primary domain that the AD DNS server is authoritative for. ,
Required: True ,
}
string ,
netBiosDomainName:
{
Description: Specifies the NetBIOS domain name. ,
Required: False ,
}
string ,
forestName:
{
Description: Specifies the Active Directory forest to get. ,
Required: False ,
}
string ,
domainGuid:
{
Description: Specifies the domain GUID. ,
Required: True ,
}
string ,
domainSid:
{
Description: Specifies the security identifier (SID). ,
Required: False ,
}
string ,
azureStorageSid:
{
Description: Specifies the security identifier (SID) for Azure Storage. ,
Required: False ,
}
string ,
samAccountName:
{
Description: Specifies the Active Directory SAMAccountName for Azure Storage. ,
Required: False ,
}
string ,
accountType:
{
Description: Specifies the Active Directory account type for Azure Storage. ,
Enum:
{
User: No description available. ,
Computer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
defaultSharePermission:
{
Description: Default share permission for users using Kerberos authentication if RBAC role is not assigned. ,
Enum:
{
None: No description available. ,
StorageFileDataSmbShareReader: No description available. ,
StorageFileDataSmbShareContributor: No description available. ,
StorageFileDataSmbShareElevatedContributor: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsHttpsTrafficOnly:
{
Description: Allows https traffic only to storage service if sets to true. ,
Required: False ,
}
boolean ,
networkAcls:
{
Description: Network rule set ,
Required: False ,
}
{
bypass:
{
Description: 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. ,
Enum:
{
None: No description available. ,
Logging: No description available. ,
Metrics: No description available. ,
AzureServices: No description available. ,
}
,
Required: False ,
}
enum ,
resourceAccessRules:
{
Description: Sets the resource access rules ,
Required: False ,
}
[
{
tenantId:
{
Description: Tenant Id ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
]
,
virtualNetworkRules:
{
Description: Sets the virtual network rules ,
Required: False ,
}
[
{
id:
{
Description: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. ,
Required: True ,
}
string ,
action:
{
Description: The action of virtual network rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: Gets the state of virtual network rule. ,
Enum:
{
Provisioning: No description available. ,
Deprovisioning: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
NetworkSourceDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipRules:
{
Description: Sets the IP ACL rules ,
Required: False ,
}
[
{
value:
{
Description: Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. ,
Required: True ,
}
string ,
action:
{
Description: The action of IP ACL rule. ,
Enum:
{
Allow: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultAction:
{
Description: Specifies the default action of allow or deny when no other rules match. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
isSftpEnabled:
{
Description: Enables Secure File Transfer Protocol, if set to true ,
Required: False ,
}
boolean ,
isLocalUserEnabled:
{
Description: Enables local users feature, if set to true ,
Required: False ,
}
boolean ,
enableExtendedGroups:
{
Description: Enables extended group support with local users feature, if set to true ,
Required: False ,
}
boolean ,
isHnsEnabled:
{
Description: Account HierarchicalNamespace enabled if sets to true. ,
Required: False ,
}
boolean ,
geoReplicationStats:
{
Description: Geo Replication Stats ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
Live: No description available. ,
Bootstrap: No description available. ,
Unavailable: No description available. ,
}
,
Required: False ,
}
enum ,
lastSyncTime:
{
Description: 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. ,
Format: date-time ,
Required: False ,
}
string ,
canFailover:
{
Description: A boolean flag which indicates whether or not account failover is supported for the account. ,
Required: False ,
}
boolean ,
canPlannedFailover:
{
Description: A boolean flag which indicates whether or not planned account failover is supported for the account. ,
Required: False ,
}
boolean ,
postFailoverRedundancy:
{
Description: The redundancy type of the account after an account failover is performed. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
postPlannedFailoverRedundancy:
{
Description: The redundancy type of the account after a planned account failover is performed. ,
Enum:
{
Standard_GRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_RAGZRS: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
failoverInProgress:
{
Description: If the failover is in progress, the value will be true, otherwise, it will be null. ,
Required: False ,
}
boolean ,
largeFileSharesState:
{
Description: Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: List of private endpoint connection associated with the specified storage account ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
routingPreference:
{
Description: Maintains information about the network routing choice opted by the user for data transfer ,
Required: False ,
}
{
routingChoice:
{
Description: Routing Choice defines the kind of network routing opted by the user. ,
Enum:
{
MicrosoftRouting: No description available. ,
InternetRouting: No description available. ,
}
,
Required: False ,
}
enum ,
publishMicrosoftEndpoints:
{
Description: A boolean flag which indicates whether microsoft routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
publishInternetEndpoints:
{
Description: A boolean flag which indicates whether internet routing storage endpoints are to be published ,
Required: False ,
}
boolean ,
}
,
blobRestoreStatus:
{
Description: Blob restore status ,
Required: False ,
}
{
status:
{
Description: 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. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
allowBlobPublicAccess:
{
Description: Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
minimumTlsVersion:
{
Description: Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. ,
Enum:
{
TLS1_0: No description available. ,
TLS1_1: No description available. ,
TLS1_2: No description available. ,
TLS1_3: No description available. ,
}
,
Required: False ,
}
enum ,
allowSharedKeyAccess:
{
Description: 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. ,
Required: False ,
}
boolean ,
isNfsV3Enabled:
{
Description: NFS 3.0 protocol support enabled if set to true. ,
Required: False ,
}
boolean ,
allowCrossTenantReplication:
{
Description: Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default. ,
Required: False ,
}
boolean ,
defaultToOAuthAuthentication:
{
Description: A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property. ,
Required: False ,
}
boolean ,
publicNetworkAccess:
{
Description: Allow, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
SecuredByPerimeter: No description available. ,
}
,
Required: False ,
}
enum ,
immutableStorageWithVersioning:
{
Description: The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the containers in the account by default. ,
Required: False ,
}
{
enabled:
{
Description: A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. ,
Required: False ,
}
boolean ,
immutabilityPolicy:
{
Description: Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. ,
Required: False ,
}
{
immutabilityPeriodSinceCreationInDays:
{
Description: The immutability period for the blobs in the container since the policy creation, in days. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. ,
Enum:
{
Unlocked: No description available. ,
Locked: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
allowProtectedAppendWrites:
{
Description: This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. ,
Required: False ,
}
boolean ,
}
,
}
,
allowedCopyScope:
{
Description: Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. ,
Enum:
{
PrivateLink: No description available. ,
AAD: No description available. ,
}
,
Required: False ,
}
enum ,
storageAccountSkuConversionStatus:
{
Description: This property is readOnly and is set by server during asynchronous storage account sku conversion operations. ,
Required: False ,
}
{
skuConversionStatus:
{
Description: This property indicates the current sku conversion status. ,
Enum:
{
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
targetSkuName:
{
Description: This property represents the target sku name to which the account sku is being converted asynchronously. ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: This property represents the sku conversion start time. ,
Required: False ,
}
string ,
endTime:
{
Description: This property represents the sku conversion end time. ,
Required: False ,
}
string ,
}
,
dnsEndpointType:
{
Description: Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier. ,
Enum:
{
Standard: No description available. ,
AzureDnsZone: No description available. ,
}
,
Required: False ,
}
enum ,
isSkuConversionBlocked:
{
Description: This property will be set to true or false on an event of ongoing migration. Default value is null. ,
Required: False ,
}
boolean ,
accountMigrationInProgress:
{
Description: If customer initiated account migration is in progress, the value will be true else it will be null. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of storage accounts. Returned when total number of requested storage accounts exceed maximum page size. ,
Required: False ,
}
string ,
}
StorageAccounts_ListKeys (new)
Description :  Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: Specifies type of the key to be listed. Possible value is kerb. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
keys:
{
Description: Gets the list of storage account keys and their properties for the specified storage account. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: False ,
}
string ,
value:
{
Description: Base 64-encoded value of the key. ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions for the key -- read-only or full permissions. ,
Enum:
{
Read: No description available. ,
Full: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Creation time of the key, in round trip date format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
StorageAccounts_RegenerateKey (new)
Description :  Regenerates one of the access keys or Kerberos keys for the specified storage account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
regenerateKey:
{
Description: Specifies name of the key which should be regenerated -- key1, key2, kerb1, kerb2. ,
Required: True ,
}
{
keyName:
{
Description: The name of storage keys that want to be regenerated, possible values are key1, key2, kerb1, kerb2. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
keys:
{
Description: Gets the list of storage account keys and their properties for the specified storage account. ,
Required: False ,
}
[
{
keyName:
{
Description: Name of the key. ,
Required: False ,
}
string ,
value:
{
Description: Base 64-encoded value of the key. ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions for the key -- read-only or full permissions. ,
Enum:
{
Read: No description available. ,
Full: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Creation time of the key, in round trip date format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
Usages_ListByLocation (new)
Description :  Gets the current usage count and the limit for the resources of the location under the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Storage/locations/{location}/usages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: The location of the Azure Storage resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of Storage Resource Usages. ,
Required: False ,
}
[
{
unit:
{
Description: Gets the unit of measurement. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountsPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
currentValue:
{
Description: Gets the current count of the allocated resources in the subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
limit:
{
Description: Gets the maximum count of the resources that can be allocated in the subscription. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: Gets the name of the type of usage. ,
Required: False ,
}
{
value:
{
Description: Gets a string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Gets a localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
StorageAccounts_ListAccountSAS (new)
Description :  List SAS credentials of a storage account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide to list SAS credentials for the storage account. ,
Required: True ,
}
{
signedServices:
{
Description: The signed services accessible with the account SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f). ,
Enum:
{
b: No description available. ,
q: No description available. ,
t: No description available. ,
f: No description available. ,
}
,
Required: True ,
}
enum ,
signedResourceTypes:
{
Description: The signed resource types that are accessible with the account SAS. Service (s): Access to service-level APIs; Container (c): Access to container-level APIs; Object (o): Access to object-level APIs for blobs, queue messages, table entities, and files. ,
Enum:
{
s: No description available. ,
c: No description available. ,
o: No description available. ,
}
,
Required: True ,
}
enum ,
signedPermission:
{
Description: The signed permissions for the account SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). ,
Enum:
{
r: No description available. ,
d: No description available. ,
w: No description available. ,
l: No description available. ,
a: No description available. ,
c: No description available. ,
u: No description available. ,
p: No description available. ,
}
,
Required: True ,
}
enum ,
signedIp:
{
Description: An IP address or a range of IP addresses from which to accept requests. ,
Required: False ,
}
string ,
signedProtocol:
{
Description: The protocol permitted for a request made with the account SAS. ,
Enum:
{
https,http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
signedStart:
{
Description: The time at which the SAS becomes valid. ,
Format: date-time ,
Required: False ,
}
string ,
signedExpiry:
{
Description: The time at which the shared access signature becomes invalid. ,
Format: date-time ,
Required: True ,
}
string ,
keyToSign:
{
Description: The key to sign the account SAS token with. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
accountSasToken:
{
Description: List SAS credentials of storage account. ,
Required: False ,
}
string ,
}
StorageAccounts_ListServiceSAS (new)
Description :  List service SAS credentials of a specific resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide to list service SAS credentials. ,
Required: True ,
}
{
canonicalizedResource:
{
Description: The canonical path to the signed resource. ,
Required: True ,
}
string ,
signedResource:
{
Description: The signed services accessible with the service SAS. Possible values include: Blob (b), Container (c), File (f), Share (s). ,
Enum:
{
b: No description available. ,
c: No description available. ,
f: No description available. ,
s: No description available. ,
}
,
Required: False ,
}
enum ,
signedPermission:
{
Description: The signed permissions for the service SAS. Possible values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create (c), Update (u) and Process (p). ,
Enum:
{
r: No description available. ,
d: No description available. ,
w: No description available. ,
l: No description available. ,
a: No description available. ,
c: No description available. ,
u: No description available. ,
p: No description available. ,
}
,
Required: False ,
}
enum ,
signedIp:
{
Description: An IP address or a range of IP addresses from which to accept requests. ,
Required: False ,
}
string ,
signedProtocol:
{
Description: The protocol permitted for a request made with the account SAS. ,
Enum:
{
https,http: No description available. ,
https: No description available. ,
}
,
Required: False ,
}
enum ,
signedStart:
{
Description: The time at which the SAS becomes valid. ,
Format: date-time ,
Required: False ,
}
string ,
signedExpiry:
{
Description: The time at which the shared access signature becomes invalid. ,
Format: date-time ,
Required: False ,
}
string ,
signedIdentifier:
{
Description: A unique value up to 64 characters in length that correlates to an access policy specified for the container, queue, or table. ,
Required: False ,
}
string ,
startPk:
{
Description: The start of partition key. ,
Required: False ,
}
string ,
endPk:
{
Description: The end of partition key. ,
Required: False ,
}
string ,
startRk:
{
Description: The start of row key. ,
Required: False ,
}
string ,
endRk:
{
Description: The end of row key. ,
Required: False ,
}
string ,
keyToSign:
{
Description: The key to sign the account SAS token with. ,
Required: False ,
}
string ,
rscc:
{
Description: The response header override for cache control. ,
Required: False ,
}
string ,
rscd:
{
Description: The response header override for content disposition. ,
Required: False ,
}
string ,
rsce:
{
Description: The response header override for content encoding. ,
Required: False ,
}
string ,
rscl:
{
Description: The response header override for content language. ,
Required: False ,
}
string ,
rsct:
{
Description: The response header override for content type. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
serviceSasToken:
{
Description: List service SAS credentials of specific resource. ,
Required: False ,
}
string ,
}
StorageAccounts_Failover (new)
Description :  A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/en-us/azure/storage/common/storage-disaster-recovery-guidance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
failoverType:
{
Description: The parameter is set to 'Planned' to indicate whether a Planned failover is requested. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
StorageAccounts_HierarchicalNamespaceMigration (new)
Description :  Live Migration of storage account to enable Hns
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/hnsonmigration
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
requestType:
{
Description: Required. Hierarchical namespace migration type can either be a hierarchical namespace validation request 'HnsOnValidationRequest' or a hydration request 'HnsOnHydrationRequest'. The validation request will validate the migration whereas the hydration request will migrate the account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
StorageAccounts_AbortHierarchicalNamespaceMigration (new)
Description :  Abort live Migration of storage account to enable Hns
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/aborthnsonmigration
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
StorageAccounts_CustomerInitiatedMigration (new)
Description :  Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/startAccountMigration
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters required to perform storage account migration. ,
Required: True ,
}
{
id:
{
Description: Migration Resource Id ,
Required: False ,
}
string ,
name:
{
Description: current value is 'default' for customer initiated migration ,
Required: False ,
}
string ,
type:
{
Description: SrpAccountMigrationType in ARM contract which is 'accountMigrations' ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a storage account’s ongoing or enqueued migration. ,
Required: True ,
}
{
targetSkuName:
{
Description: Target sku name for the account ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
migrationStatus:
{
Description: Current status of migration ,
Enum:
{
Invalid: No description available. ,
SubmittedForConversion: No description available. ,
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
migrationFailedReason:
{
Description: Error code for migration failure ,
Required: False ,
}
string ,
migrationFailedDetailedReason:
{
Description: Reason for migration failure ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAccounts_GetCustomerInitiatedMigration (new)
Description :  Gets the status of the ongoing migration for the specified storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{migrationName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
migrationName:
{
Description: The name of the Storage Account Migration. It should always be 'default' ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Migration Resource Id ,
Required: False ,
}
string ,
name:
{
Description: current value is 'default' for customer initiated migration ,
Required: False ,
}
string ,
type:
{
Description: SrpAccountMigrationType in ARM contract which is 'accountMigrations' ,
Required: False ,
}
string ,
properties:
{
Description: The properties of a storage account’s ongoing or enqueued migration. ,
Required: True ,
}
{
targetSkuName:
{
Description: Target sku name for the account ,
Enum:
{
Standard_LRS: No description available. ,
Standard_GRS: No description available. ,
Standard_RAGRS: No description available. ,
Standard_ZRS: No description available. ,
Premium_LRS: No description available. ,
Premium_ZRS: No description available. ,
Standard_GZRS: No description available. ,
Standard_RAGZRS: No description available. ,
StandardV2_LRS: No description available. ,
StandardV2_GRS: No description available. ,
StandardV2_ZRS: No description available. ,
StandardV2_GZRS: No description available. ,
PremiumV2_LRS: No description available. ,
PremiumV2_ZRS: No description available. ,
}
,
Required: True ,
}
enum ,
migrationStatus:
{
Description: Current status of migration ,
Enum:
{
Invalid: No description available. ,
SubmittedForConversion: No description available. ,
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
migrationFailedReason:
{
Description: Error code for migration failure ,
Required: False ,
}
string ,
migrationFailedDetailedReason:
{
Description: Reason for migration failure ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageAccounts_RestoreBlobRanges (new)
Description :  Restore blobs in the specified blob ranges
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/restoreBlobRanges
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide for restore blob ranges. ,
Required: True ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
status:
{
Description: 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. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
status:
{
Description: 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. ,
Enum:
{
InProgress: No description available. ,
Complete: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Failure reason when blob restore is failed. ,
Required: False ,
}
string ,
restoreId:
{
Description: Id for tracking blob restore request. ,
Required: False ,
}
string ,
parameters:
{
Description: Blob restore request parameters. ,
Required: False ,
}
{
timeToRestore:
{
Description: Restore blob to the specified time. ,
Format: date-time ,
Required: True ,
}
string ,
blobRanges:
{
Description: Blob ranges to restore. ,
Required: True ,
}
[
{
startRange:
{
Description: Blob start range. This is inclusive. Empty means account start. ,
Required: True ,
}
string ,
endRange:
{
Description: Blob end range. This is exclusive. Empty means account end. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
ManagementPolicies_Get (new)
Description :  Gets the managementpolicy associated with the specified storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
managementPolicyName:
{
Description: The name of the Storage Account Management Policy. It should always be 'default' ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Returns the Storage Account Data Policies Rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the ManagementPolicies was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ,
Required: True ,
}
{
rules:
{
Description: The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled if set to true. ,
Required: False ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
type:
{
Description: The valid value is Lifecycle ,
Enum:
{
Lifecycle: No description available. ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: An object that defines the Lifecycle rule. ,
Required: True ,
}
{
actions:
{
Description: An object that defines the action set. ,
Required: True ,
}
{
baseBlob:
{
Description: The management policy action for base blob ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blobs to cool storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blobs to archive storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
enableAutoTierToHotFromCool:
{
Description: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. ,
Required: False ,
}
boolean ,
}
,
snapshot:
{
Description: The management policy action for snapshot ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob snapshot to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob snapshot to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob snapshot ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
version:
{
Description: The management policy action for version ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob version to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob version to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob version ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
}
,
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings for prefixes to be match. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. ,
Required: True ,
}
[
string ,
]
,
blobIndexMatch:
{
Description: An array of blob index tag based filters, there can be at most 10 tag filters ,
Required: False ,
}
[
{
name:
{
Description: This is the filter tag name, it can have 1 - 128 characters ,
Required: True ,
}
string ,
op:
{
Description: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported ,
Required: True ,
}
string ,
value:
{
Description: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}
,
}
,
}
ManagementPolicies_CreateOrUpdate (new)
Description :  Sets the managementpolicy to the specified storage account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
managementPolicyName:
{
Description: The name of the Storage Account Management Policy. It should always be 'default' ,
Required: True ,
}
string ,
properties:
{
Description: The ManagementPolicy set to a storage account. ,
Required: True ,
}
{
properties:
{
Description: Returns the Storage Account Data Policies Rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the ManagementPolicies was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ,
Required: True ,
}
{
rules:
{
Description: The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled if set to true. ,
Required: False ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
type:
{
Description: The valid value is Lifecycle ,
Enum:
{
Lifecycle: No description available. ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: An object that defines the Lifecycle rule. ,
Required: True ,
}
{
actions:
{
Description: An object that defines the action set. ,
Required: True ,
}
{
baseBlob:
{
Description: The management policy action for base blob ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blobs to cool storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blobs to archive storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
enableAutoTierToHotFromCool:
{
Description: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. ,
Required: False ,
}
boolean ,
}
,
snapshot:
{
Description: The management policy action for snapshot ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob snapshot to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob snapshot to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob snapshot ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
version:
{
Description: The management policy action for version ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob version to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob version to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob version ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
}
,
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings for prefixes to be match. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. ,
Required: True ,
}
[
string ,
]
,
blobIndexMatch:
{
Description: An array of blob index tag based filters, there can be at most 10 tag filters ,
Required: False ,
}
[
{
name:
{
Description: This is the filter tag name, it can have 1 - 128 characters ,
Required: True ,
}
string ,
op:
{
Description: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported ,
Required: True ,
}
string ,
value:
{
Description: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Returns the Storage Account Data Policies Rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the date and time the ManagementPolicies was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The Storage Account ManagementPolicy, in JSON format. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ,
Required: True ,
}
{
rules:
{
Description: The Storage Account ManagementPolicies Rules. See more details in: https://docs.microsoft.com/en-us/azure/storage/common/storage-lifecycle-managment-concepts. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled if set to true. ,
Required: False ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
type:
{
Description: The valid value is Lifecycle ,
Enum:
{
Lifecycle: No description available. ,
}
,
Required: True ,
}
enum ,
definition:
{
Description: An object that defines the Lifecycle rule. ,
Required: True ,
}
{
actions:
{
Description: An object that defines the action set. ,
Required: True ,
}
{
baseBlob:
{
Description: The management policy action for base blob ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blobs to cool storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blobs to archive storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob ,
Required: False ,
}
{
daysAfterModificationGreaterThan:
{
Description: Value indicating the age in days after last modification ,
Required: False ,
}
number ,
daysAfterLastAccessTimeGreaterThan:
{
Description: Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy ,
Required: False ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after blob creation. ,
Required: False ,
}
number ,
}
,
enableAutoTierToHotFromCool:
{
Description: This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. ,
Required: False ,
}
boolean ,
}
,
snapshot:
{
Description: The management policy action for snapshot ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob snapshot to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob snapshot to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob snapshot ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
version:
{
Description: The management policy action for version ,
Required: False ,
}
{
tierToCool:
{
Description: The function to tier blob version to cool storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToArchive:
{
Description: The function to tier blob version to archive storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToCold:
{
Description: The function to tier blobs to cold storage. ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
tierToHot:
{
Description: The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
delete:
{
Description: The function to delete the blob version ,
Required: False ,
}
{
daysAfterCreationGreaterThan:
{
Description: Value indicating the age in days after creation ,
Required: True ,
}
number ,
daysAfterLastTierChangeGreaterThan:
{
Description: Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. ,
Required: False ,
}
number ,
}
,
}
,
}
,
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings for prefixes to be match. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. ,
Required: True ,
}
[
string ,
]
,
blobIndexMatch:
{
Description: An array of blob index tag based filters, there can be at most 10 tag filters ,
Required: False ,
}
[
{
name:
{
Description: This is the filter tag name, it can have 1 - 128 characters ,
Required: True ,
}
string ,
op:
{
Description: This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported ,
Required: True ,
}
string ,
value:
{
Description: This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}
,
}
,
}
ManagementPolicies_Delete (new)
Description :  Deletes the managementpolicy associated with the specified storage account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/managementPolicies/{managementPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
managementPolicyName:
{
Description: The name of the Storage Account Management Policy. It should always be 'default' ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
BlobInventoryPolicies_Get (new)
Description :  Gets the blob inventory policy associated with the specified storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
blobInventoryPolicyName:
{
Description: The name of the storage account blob inventory policy. It should always be 'default' ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Returns the storage account blob inventory policy rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the last modified date and time of the blob inventory policy. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The storage account blob inventory policy object. It is composed of policy rules. ,
Required: True ,
}
{
enabled:
{
Description: Policy is enabled if set to true. ,
Required: True ,
}
boolean ,
destination:
{
Description: Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination' ,
Required: False ,
}
string ,
type:
{
Description: The valid value is Inventory ,
Enum:
{
Inventory: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: The storage account blob inventory policy rules. The rule is applied when it is enabled. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled when set to true. ,
Required: True ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
destination:
{
Description: Container name where blob inventory files are stored. Must be pre-created. ,
Required: True ,
}
string ,
definition:
{
Description: An object that defines the blob inventory policy rule. ,
Required: True ,
}
{
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings with maximum 10 blob prefixes to be included in the inventory. ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: An array of strings with maximum 10 blob prefixes to be excluded from the inventory. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. ,
Required: False ,
}
[
string ,
]
,
includeBlobVersions:
{
Description: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. ,
Required: False ,
}
boolean ,
includeSnapshots:
{
Description: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. ,
Required: False ,
}
boolean ,
includeDeleted:
{
Description: For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: This property is used to filter objects based on the object creation time ,
Required: False ,
}
{
lastNDays:
{
Description: When set the policy filters the objects that are created in the last N days. Where N is an integer value between 1 to 36500. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
format:
{
Description: This is a required field, it specifies the format for the inventory files. ,
Enum:
{
Csv: No description available. ,
Parquet: No description available. ,
}
,
Required: True ,
}
enum ,
schedule:
{
Description: This is a required field. This field is used to schedule an inventory formation. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: True ,
}
enum ,
objectType:
{
Description: This is a required field. This field specifies the scope of the inventory created either at the blob or container level. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
}
,
Required: True ,
}
enum ,
schemaFields:
{
Description: This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BlobInventoryPolicies_CreateOrUpdate (new)
Description :  Sets the blob inventory policy to the specified storage account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
blobInventoryPolicyName:
{
Description: The name of the storage account blob inventory policy. It should always be 'default' ,
Required: True ,
}
string ,
properties:
{
Description: The blob inventory policy set to a storage account. ,
Required: True ,
}
{
properties:
{
Description: Returns the storage account blob inventory policy rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the last modified date and time of the blob inventory policy. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The storage account blob inventory policy object. It is composed of policy rules. ,
Required: True ,
}
{
enabled:
{
Description: Policy is enabled if set to true. ,
Required: True ,
}
boolean ,
destination:
{
Description: Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination' ,
Required: False ,
}
string ,
type:
{
Description: The valid value is Inventory ,
Enum:
{
Inventory: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: The storage account blob inventory policy rules. The rule is applied when it is enabled. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled when set to true. ,
Required: True ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
destination:
{
Description: Container name where blob inventory files are stored. Must be pre-created. ,
Required: True ,
}
string ,
definition:
{
Description: An object that defines the blob inventory policy rule. ,
Required: True ,
}
{
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings with maximum 10 blob prefixes to be included in the inventory. ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: An array of strings with maximum 10 blob prefixes to be excluded from the inventory. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. ,
Required: False ,
}
[
string ,
]
,
includeBlobVersions:
{
Description: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. ,
Required: False ,
}
boolean ,
includeSnapshots:
{
Description: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. ,
Required: False ,
}
boolean ,
includeDeleted:
{
Description: For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: This property is used to filter objects based on the object creation time ,
Required: False ,
}
{
lastNDays:
{
Description: When set the policy filters the objects that are created in the last N days. Where N is an integer value between 1 to 36500. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
format:
{
Description: This is a required field, it specifies the format for the inventory files. ,
Enum:
{
Csv: No description available. ,
Parquet: No description available. ,
}
,
Required: True ,
}
enum ,
schedule:
{
Description: This is a required field. This field is used to schedule an inventory formation. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: True ,
}
enum ,
objectType:
{
Description: This is a required field. This field specifies the scope of the inventory created either at the blob or container level. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
}
,
Required: True ,
}
enum ,
schemaFields:
{
Description: This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Returns the storage account blob inventory policy rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the last modified date and time of the blob inventory policy. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The storage account blob inventory policy object. It is composed of policy rules. ,
Required: True ,
}
{
enabled:
{
Description: Policy is enabled if set to true. ,
Required: True ,
}
boolean ,
destination:
{
Description: Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination' ,
Required: False ,
}
string ,
type:
{
Description: The valid value is Inventory ,
Enum:
{
Inventory: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: The storage account blob inventory policy rules. The rule is applied when it is enabled. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled when set to true. ,
Required: True ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
destination:
{
Description: Container name where blob inventory files are stored. Must be pre-created. ,
Required: True ,
}
string ,
definition:
{
Description: An object that defines the blob inventory policy rule. ,
Required: True ,
}
{
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings with maximum 10 blob prefixes to be included in the inventory. ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: An array of strings with maximum 10 blob prefixes to be excluded from the inventory. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. ,
Required: False ,
}
[
string ,
]
,
includeBlobVersions:
{
Description: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. ,
Required: False ,
}
boolean ,
includeSnapshots:
{
Description: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. ,
Required: False ,
}
boolean ,
includeDeleted:
{
Description: For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: This property is used to filter objects based on the object creation time ,
Required: False ,
}
{
lastNDays:
{
Description: When set the policy filters the objects that are created in the last N days. Where N is an integer value between 1 to 36500. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
format:
{
Description: This is a required field, it specifies the format for the inventory files. ,
Enum:
{
Csv: No description available. ,
Parquet: No description available. ,
}
,
Required: True ,
}
enum ,
schedule:
{
Description: This is a required field. This field is used to schedule an inventory formation. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: True ,
}
enum ,
objectType:
{
Description: This is a required field. This field specifies the scope of the inventory created either at the blob or container level. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
}
,
Required: True ,
}
enum ,
schemaFields:
{
Description: This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BlobInventoryPolicies_Delete (new)
Description :  Deletes the blob inventory policy associated with the specified storage account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies/{blobInventoryPolicyName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
blobInventoryPolicyName:
{
Description: The name of the storage account blob inventory policy. It should always be 'default' ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
BlobInventoryPolicies_List (new)
Description :  Gets the blob inventory policy associated with the specified storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/inventoryPolicies
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of blob inventory policies. ,
Required: False ,
}
[
{
properties:
{
Description: Returns the storage account blob inventory policy rules. ,
Required: False ,
}
{
lastModifiedTime:
{
Description: Returns the last modified date and time of the blob inventory policy. ,
Format: date-time ,
Required: False ,
}
string ,
policy:
{
Description: The storage account blob inventory policy object. It is composed of policy rules. ,
Required: True ,
}
{
enabled:
{
Description: Policy is enabled if set to true. ,
Required: True ,
}
boolean ,
destination:
{
Description: Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination' ,
Required: False ,
}
string ,
type:
{
Description: The valid value is Inventory ,
Enum:
{
Inventory: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: The storage account blob inventory policy rules. The rule is applied when it is enabled. ,
Required: True ,
}
[
{
enabled:
{
Description: Rule is enabled when set to true. ,
Required: True ,
}
boolean ,
name:
{
Description: A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. ,
Required: True ,
}
string ,
destination:
{
Description: Container name where blob inventory files are stored. Must be pre-created. ,
Required: True ,
}
string ,
definition:
{
Description: An object that defines the blob inventory policy rule. ,
Required: True ,
}
{
filters:
{
Description: An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: An array of strings with maximum 10 blob prefixes to be included in the inventory. ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: An array of strings with maximum 10 blob prefixes to be excluded from the inventory. ,
Required: False ,
}
[
string ,
]
,
blobTypes:
{
Description: An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. ,
Required: False ,
}
[
string ,
]
,
includeBlobVersions:
{
Description: Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. ,
Required: False ,
}
boolean ,
includeSnapshots:
{
Description: Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. ,
Required: False ,
}
boolean ,
includeDeleted:
{
Description: For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded. ,
Required: False ,
}
boolean ,
creationTime:
{
Description: This property is used to filter objects based on the object creation time ,
Required: False ,
}
{
lastNDays:
{
Description: When set the policy filters the objects that are created in the last N days. Where N is an integer value between 1 to 36500. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
format:
{
Description: This is a required field, it specifies the format for the inventory files. ,
Enum:
{
Csv: No description available. ,
Parquet: No description available. ,
}
,
Required: True ,
}
enum ,
schedule:
{
Description: This is a required field. This field is used to schedule an inventory formation. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
}
,
Required: True ,
}
enum ,
objectType:
{
Description: This is a required field. This field specifies the scope of the inventory created either at the blob or container level. ,
Enum:
{
Blob: No description available. ,
Container: No description available. ,
}
,
Required: True ,
}
enum ,
schemaFields:
{
Description: This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_List (new)
Description :  List all the private endpoint connections associated with the storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
PrivateEndpointConnections_Get (new)
Description :  Gets the specified private endpoint connection associated with the storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Put (new)
Description :  Update the state of specified private endpoint connection associated with the storage account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
properties:
{
Description: The private endpoint connection properties. ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateEndpointConnections_Delete (new)
Description :  Deletes the specified private endpoint connection associated with the storage account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection associated with the Azure resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
PrivateLinkResources_ListByStorageAccount (new)
Description :  Gets the private link resources that need to be created for a storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/privateLinkResources
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
ObjectReplicationPolicies_List (new)
Description :  List the object replication policies associated with the storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The replication policy between two storage accounts. ,
Required: False ,
}
[
{
properties:
{
Description: Returns the Storage Account Object Replication Policy. ,
Required: False ,
}
{
policyId:
{
Description: A unique id for object replication policy. ,
Required: False ,
}
string ,
enabledTime:
{
Description: Indicates when the policy is enabled on the source account. ,
Format: date-time ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. ,
Required: True ,
}
string ,
destinationAccount:
{
Description: Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. ,
Required: True ,
}
string ,
rules:
{
Description: The storage account object replication rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. ,
Required: False ,
}
string ,
sourceContainer:
{
Description: Required. Source container name. ,
Required: True ,
}
string ,
destinationContainer:
{
Description: Required. Destination container name. ,
Required: True ,
}
string ,
filters:
{
Description: Optional. An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ,
Required: False ,
}
[
string ,
]
,
minCreationTime:
{
Description: Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z ,
Required: False ,
}
string ,
}
,
}
,
]
,
metrics:
{
Description: Optional. The object replication policy metrics feature options. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether object replication metrics feature is enabled for the policy. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
ObjectReplicationPolicies_Get (new)
Description :  Get the object replication policy of the storage account by policy ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
objectReplicationPolicyId:
{
Description: For the destination account, provide the value 'default'. Configure the policy on the destination account first. For the source account, provide the value of the policy ID that is returned when you download the policy that was defined on the destination account. The policy is downloaded as a JSON file. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Returns the Storage Account Object Replication Policy. ,
Required: False ,
}
{
policyId:
{
Description: A unique id for object replication policy. ,
Required: False ,
}
string ,
enabledTime:
{
Description: Indicates when the policy is enabled on the source account. ,
Format: date-time ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. ,
Required: True ,
}
string ,
destinationAccount:
{
Description: Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. ,
Required: True ,
}
string ,
rules:
{
Description: The storage account object replication rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. ,
Required: False ,
}
string ,
sourceContainer:
{
Description: Required. Source container name. ,
Required: True ,
}
string ,
destinationContainer:
{
Description: Required. Destination container name. ,
Required: True ,
}
string ,
filters:
{
Description: Optional. An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ,
Required: False ,
}
[
string ,
]
,
minCreationTime:
{
Description: Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z ,
Required: False ,
}
string ,
}
,
}
,
]
,
metrics:
{
Description: Optional. The object replication policy metrics feature options. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether object replication metrics feature is enabled for the policy. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
ObjectReplicationPolicies_CreateOrUpdate (new)
Description :  Create or update the object replication policy of the storage account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
objectReplicationPolicyId:
{
Description: For the destination account, provide the value 'default'. Configure the policy on the destination account first. For the source account, provide the value of the policy ID that is returned when you download the policy that was defined on the destination account. The policy is downloaded as a JSON file. ,
Required: True ,
}
string ,
properties:
{
Description: The object replication policy set to a storage account. A unique policy ID will be created if absent. ,
Required: True ,
}
{
properties:
{
Description: Returns the Storage Account Object Replication Policy. ,
Required: False ,
}
{
policyId:
{
Description: A unique id for object replication policy. ,
Required: False ,
}
string ,
enabledTime:
{
Description: Indicates when the policy is enabled on the source account. ,
Format: date-time ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. ,
Required: True ,
}
string ,
destinationAccount:
{
Description: Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. ,
Required: True ,
}
string ,
rules:
{
Description: The storage account object replication rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. ,
Required: False ,
}
string ,
sourceContainer:
{
Description: Required. Source container name. ,
Required: True ,
}
string ,
destinationContainer:
{
Description: Required. Destination container name. ,
Required: True ,
}
string ,
filters:
{
Description: Optional. An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ,
Required: False ,
}
[
string ,
]
,
minCreationTime:
{
Description: Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z ,
Required: False ,
}
string ,
}
,
}
,
]
,
metrics:
{
Description: Optional. The object replication policy metrics feature options. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether object replication metrics feature is enabled for the policy. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Returns the Storage Account Object Replication Policy. ,
Required: False ,
}
{
policyId:
{
Description: A unique id for object replication policy. ,
Required: False ,
}
string ,
enabledTime:
{
Description: Indicates when the policy is enabled on the source account. ,
Format: date-time ,
Required: False ,
}
string ,
sourceAccount:
{
Description: Required. Source account name. It should be full resource id if allowCrossTenantReplication set to false. ,
Required: True ,
}
string ,
destinationAccount:
{
Description: Required. Destination account name. It should be full resource id if allowCrossTenantReplication set to false. ,
Required: True ,
}
string ,
rules:
{
Description: The storage account object replication rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. ,
Required: False ,
}
string ,
sourceContainer:
{
Description: Required. Source container name. ,
Required: True ,
}
string ,
destinationContainer:
{
Description: Required. Destination container name. ,
Required: True ,
}
string ,
filters:
{
Description: Optional. An object that defines the filter set. ,
Required: False ,
}
{
prefixMatch:
{
Description: Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. ,
Required: False ,
}
[
string ,
]
,
minCreationTime:
{
Description: Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z ,
Required: False ,
}
string ,
}
,
}
,
]
,
metrics:
{
Description: Optional. The object replication policy metrics feature options. ,
Required: False ,
}
{
enabled:
{
Description: Indicates whether object replication metrics feature is enabled for the policy. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
ObjectReplicationPolicies_Delete (new)
Description :  Deletes the object replication policy associated with the specified storage account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/objectReplicationPolicies/{objectReplicationPolicyId}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
objectReplicationPolicyId:
{
Description: For the destination account, provide the value 'default'. Configure the policy on the destination account first. For the source account, provide the value of the policy ID that is returned when you download the policy that was defined on the destination account. The policy is downloaded as a JSON file. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
StorageAccounts_RevokeUserDelegationKeys (new)
Description :  Revoke user delegation keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/revokeUserDelegationKeys
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}
LocalUsers_List (new)
Description :  List the local users associated with the storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of local users that will be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: Optional. When specified, only local user names starting with the filter will be listed. ,
Required: False ,
}
string ,
$include:
{
Description: Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of local users associated with the storage account. ,
Required: False ,
}
[
{
properties:
{
Description: Storage account local user properties. ,
Required: False ,
}
{
permissionScopes:
{
Description: The permission scopes of the local user. ,
Required: False ,
}
[
{
permissions:
{
Description: The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p). ,
Required: True ,
}
string ,
service:
{
Description: The service used by the local user, e.g. blob, file. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of resource, normally the container name or the file share name, used by the local user. ,
Required: True ,
}
string ,
}
,
]
,
homeDirectory:
{
Description: Optional, local user home directory. ,
Required: False ,
}
string ,
sshAuthorizedKeys:
{
Description: Optional, local user ssh authorized keys for SFTP. ,
Required: False ,
}
[
{
description:
{
Description: Optional. It is used to store the function/usage of the key ,
Required: False ,
}
string ,
key:
{
Description: Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB ,
Required: False ,
}
string ,
}
,
]
,
sid:
{
Description: A unique Security Identifier that is generated by the server. ,
Required: False ,
}
string ,
hasSharedKey:
{
Description: Indicates whether shared key exists. Set it to false to remove existing shared key. ,
Required: False ,
}
boolean ,
hasSshKey:
{
Description: Indicates whether ssh key exists. Set it to false to remove existing SSH key. ,
Required: False ,
}
boolean ,
hasSshPassword:
{
Description: Indicates whether ssh password exists. Set it to false to remove existing SSH password. ,
Required: False ,
}
boolean ,
userId:
{
Description: A unique Identifier that is generated by the server. ,
Format: int32 ,
Required: False ,
}
integer ,
groupId:
{
Description: An identifier for associating a group of users. ,
Format: int32 ,
Required: False ,
}
integer ,
allowAclAuthorization:
{
Description: Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization. ,
Required: False ,
}
boolean ,
extendedGroups:
{
Description: Supplementary group membership. Only applicable for local users enabled for NFSv3 access. ,
Required: False ,
}
[
integer ,
]
,
isNFSv3Enabled:
{
Description: Indicates if the local user is enabled for access with NFSv3 protocol. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of local users. Returned when total number of requested local users exceeds the maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
LocalUsers_Get (new)
Description :  Get the local user of the storage account by username.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
username:
{
Description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Storage account local user properties. ,
Required: False ,
}
{
permissionScopes:
{
Description: The permission scopes of the local user. ,
Required: False ,
}
[
{
permissions:
{
Description: The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p). ,
Required: True ,
}
string ,
service:
{
Description: The service used by the local user, e.g. blob, file. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of resource, normally the container name or the file share name, used by the local user. ,
Required: True ,
}
string ,
}
,
]
,
homeDirectory:
{
Description: Optional, local user home directory. ,
Required: False ,
}
string ,
sshAuthorizedKeys:
{
Description: Optional, local user ssh authorized keys for SFTP. ,
Required: False ,
}
[
{
description:
{
Description: Optional. It is used to store the function/usage of the key ,
Required: False ,
}
string ,
key:
{
Description: Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB ,
Required: False ,
}
string ,
}
,
]
,
sid:
{
Description: A unique Security Identifier that is generated by the server. ,
Required: False ,
}
string ,
hasSharedKey:
{
Description: Indicates whether shared key exists. Set it to false to remove existing shared key. ,
Required: False ,
}
boolean ,
hasSshKey:
{
Description: Indicates whether ssh key exists. Set it to false to remove existing SSH key. ,
Required: False ,
}
boolean ,
hasSshPassword:
{
Description: Indicates whether ssh password exists. Set it to false to remove existing SSH password. ,
Required: False ,
}
boolean ,
userId:
{
Description: A unique Identifier that is generated by the server. ,
Format: int32 ,
Required: False ,
}
integer ,
groupId:
{
Description: An identifier for associating a group of users. ,
Format: int32 ,
Required: False ,
}
integer ,
allowAclAuthorization:
{
Description: Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization. ,
Required: False ,
}
boolean ,
extendedGroups:
{
Description: Supplementary group membership. Only applicable for local users enabled for NFSv3 access. ,
Required: False ,
}
[
integer ,
]
,
isNFSv3Enabled:
{
Description: Indicates if the local user is enabled for access with NFSv3 protocol. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
LocalUsers_CreateOrUpdate (new)
Description :  Create or update the properties of a local user associated with the storage account. Properties for NFSv3 enablement and extended groups cannot be set with other properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
username:
{
Description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. ,
Required: True ,
}
string ,
properties:
{
Description: The local user associated with a storage account. ,
Required: True ,
}
{
properties:
{
Description: Storage account local user properties. ,
Required: False ,
}
{
permissionScopes:
{
Description: The permission scopes of the local user. ,
Required: False ,
}
[
{
permissions:
{
Description: The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p). ,
Required: True ,
}
string ,
service:
{
Description: The service used by the local user, e.g. blob, file. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of resource, normally the container name or the file share name, used by the local user. ,
Required: True ,
}
string ,
}
,
]
,
homeDirectory:
{
Description: Optional, local user home directory. ,
Required: False ,
}
string ,
sshAuthorizedKeys:
{
Description: Optional, local user ssh authorized keys for SFTP. ,
Required: False ,
}
[
{
description:
{
Description: Optional. It is used to store the function/usage of the key ,
Required: False ,
}
string ,
key:
{
Description: Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB ,
Required: False ,
}
string ,
}
,
]
,
sid:
{
Description: A unique Security Identifier that is generated by the server. ,
Required: False ,
}
string ,
hasSharedKey:
{
Description: Indicates whether shared key exists. Set it to false to remove existing shared key. ,
Required: False ,
}
boolean ,
hasSshKey:
{
Description: Indicates whether ssh key exists. Set it to false to remove existing SSH key. ,
Required: False ,
}
boolean ,
hasSshPassword:
{
Description: Indicates whether ssh password exists. Set it to false to remove existing SSH password. ,
Required: False ,
}
boolean ,
userId:
{
Description: A unique Identifier that is generated by the server. ,
Format: int32 ,
Required: False ,
}
integer ,
groupId:
{
Description: An identifier for associating a group of users. ,
Format: int32 ,
Required: False ,
}
integer ,
allowAclAuthorization:
{
Description: Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization. ,
Required: False ,
}
boolean ,
extendedGroups:
{
Description: Supplementary group membership. Only applicable for local users enabled for NFSv3 access. ,
Required: False ,
}
[
integer ,
]
,
isNFSv3Enabled:
{
Description: Indicates if the local user is enabled for access with NFSv3 protocol. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Storage account local user properties. ,
Required: False ,
}
{
permissionScopes:
{
Description: The permission scopes of the local user. ,
Required: False ,
}
[
{
permissions:
{
Description: The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p). ,
Required: True ,
}
string ,
service:
{
Description: The service used by the local user, e.g. blob, file. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of resource, normally the container name or the file share name, used by the local user. ,
Required: True ,
}
string ,
}
,
]
,
homeDirectory:
{
Description: Optional, local user home directory. ,
Required: False ,
}
string ,
sshAuthorizedKeys:
{
Description: Optional, local user ssh authorized keys for SFTP. ,
Required: False ,
}
[
{
description:
{
Description: Optional. It is used to store the function/usage of the key ,
Required: False ,
}
string ,
key:
{
Description: Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB ,
Required: False ,
}
string ,
}
,
]
,
sid:
{
Description: A unique Security Identifier that is generated by the server. ,
Required: False ,
}
string ,
hasSharedKey:
{
Description: Indicates whether shared key exists. Set it to false to remove existing shared key. ,
Required: False ,
}
boolean ,
hasSshKey:
{
Description: Indicates whether ssh key exists. Set it to false to remove existing SSH key. ,
Required: False ,
}
boolean ,
hasSshPassword:
{
Description: Indicates whether ssh password exists. Set it to false to remove existing SSH password. ,
Required: False ,
}
boolean ,
userId:
{
Description: A unique Identifier that is generated by the server. ,
Format: int32 ,
Required: False ,
}
integer ,
groupId:
{
Description: An identifier for associating a group of users. ,
Format: int32 ,
Required: False ,
}
integer ,
allowAclAuthorization:
{
Description: Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization. ,
Required: False ,
}
boolean ,
extendedGroups:
{
Description: Supplementary group membership. Only applicable for local users enabled for NFSv3 access. ,
Required: False ,
}
[
integer ,
]
,
isNFSv3Enabled:
{
Description: Indicates if the local user is enabled for access with NFSv3 protocol. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
LocalUsers_Delete (new)
Description :  Deletes the local user associated with the specified storage account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
username:
{
Description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
LocalUsers_ListKeys (new)
Description :  List SSH authorized keys and shared key of the local user.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/listKeys
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
username:
{
Description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sshAuthorizedKeys:
{
Description: Optional, local user ssh authorized keys for SFTP. ,
Required: False ,
}
[
{
description:
{
Description: Optional. It is used to store the function/usage of the key ,
Required: False ,
}
string ,
key:
{
Description: Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB ,
Required: False ,
}
string ,
}
,
]
,
sharedKey:
{
Description: Auto generated by the server for SMB authentication. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
LocalUsers_RegeneratePassword (new)
Description :  Regenerate the local user SSH password.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/localUsers/{username}/regeneratePassword
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
username:
{
Description: The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sshPassword:
{
Description: Auto generated password by the server for SSH authentication if hasSshPassword is set to true on the creation of local user. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
EncryptionScopes_Put (new)
Description :  Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
encryptionScopeName:
{
Description: The name of the encryption scope within the specified storage account. Encryption scope 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. ,
Required: True ,
}
string ,
encryptionScope:
{
Description: Encryption scope properties to be used for the create or update. ,
Required: True ,
}
{
properties:
{
Description: Properties of the encryption scope. ,
Required: False ,
}
{
source:
{
Description: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modification date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyUri:
{
Description: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the encryption scope. ,
Required: False ,
}
{
source:
{
Description: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modification date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyUri:
{
Description: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the encryption scope. ,
Required: False ,
}
{
source:
{
Description: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modification date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyUri:
{
Description: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
EncryptionScopes_Patch (new)
Description :  Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
encryptionScopeName:
{
Description: The name of the encryption scope within the specified storage account. Encryption scope 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. ,
Required: True ,
}
string ,
encryptionScope:
{
Description: Encryption scope properties to be used for the update. ,
Required: True ,
}
{
properties:
{
Description: Properties of the encryption scope. ,
Required: False ,
}
{
source:
{
Description: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modification date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyUri:
{
Description: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the encryption scope. ,
Required: False ,
}
{
source:
{
Description: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modification date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyUri:
{
Description: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
EncryptionScopes_Get (new)
Description :  Returns the properties for the specified encryption scope.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes/{encryptionScopeName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
encryptionScopeName:
{
Description: The name of the encryption scope within the specified storage account. Encryption scope 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. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the encryption scope. ,
Required: False ,
}
{
source:
{
Description: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modification date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyUri:
{
Description: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure Storage Resource Provider error response body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
}
,
}
EncryptionScopes_List (new)
Description :  Lists all the encryption scopes available under the specified storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/encryptionScopes
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of encryption scopes that will be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: Optional. When specified, only encryption scope names starting with the filter will be listed. ,
Required: False ,
}
string ,
$include:
{
Description: Optional, when specified, will list encryption scopes with the specific state. Defaults to All ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of encryption scopes requested. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the encryption scope. ,
Required: False ,
}
{
source:
{
Description: The provider for the encryption scope. Possible values (case-insensitive): Microsoft.Storage, Microsoft.KeyVault. ,
Enum:
{
Microsoft.Storage: No description available. ,
Microsoft.KeyVault: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the encryption scope. Possible values (case-insensitive): Enabled, Disabled. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
creationTime:
{
Description: Gets the creation date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedTime:
{
Description: Gets the last modification date and time of the encryption scope in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
keyVaultProperties:
{
Description: The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyUri:
{
Description: The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope. ,
Required: False ,
}
string ,
currentVersionedKeyIdentifier:
{
Description: The object identifier of the current versioned Key Vault Key in use. ,
Required: False ,
}
string ,
lastKeyRotationTimestamp:
{
Description: Timestamp of last rotation of the Key Vault Key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
requireInfrastructureEncryption:
{
Description: A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of encryption scopes. Returned when total number of requested encryption scopes exceeds the maximum page size. ,
Required: False ,
}
string ,
}
StorageTaskAssignments_Create (new)
Description :  Asynchronously creates a new storage task assignment sub-resource with the specified parameters. If a storage task assignment is already created and a subsequent create request is issued with different properties, the storage task assignment properties will be updated. If a storage task assignment is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
storageTaskAssignmentName:
{
Description: The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to create a Storage Task Assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
Description: When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: int32 ,
Required: False ,
}
integer ,
intervalUnit:
{
Description: Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
Description: When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
Description: When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: int32 ,
Required: False ,
}
integer ,
intervalUnit:
{
Description: Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
Description: When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
Description: When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: int32 ,
Required: False ,
}
integer ,
intervalUnit:
{
Description: Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
Description: When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignments_Update (new)
Description :  Update storage task assignment properties
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
storageTaskAssignmentName:
{
Description: The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to update a Storage Task Assignment. ,
Required: True ,
}
{
properties:
{
Description: Properties of the storage task assignment. ,
Required: False ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Required: False ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: False ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: False ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: False ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: False ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: False ,
}
{
startFrom:
{
Description: When to start task execution. This is a mutable field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Run interval of task execution. This is a mutable field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: int32 ,
Required: False ,
}
integer ,
intervalUnit:
{
Description: Run interval unit of task execution. This is a mutable field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
Description: When to end task execution. This is a mutable field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is a mutable field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: False ,
}
{
prefix:
{
Description: The prefix of the storage task assignment report ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
Description: When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: int32 ,
Required: False ,
}
integer ,
intervalUnit:
{
Description: Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
Description: When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignments_Get (new)
Description :  Get the storage task assignment properties
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
storageTaskAssignmentName:
{
Description: The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
Description: When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: int32 ,
Required: False ,
}
integer ,
intervalUnit:
{
Description: Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
Description: When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignments_Delete (new)
Description :  Delete the storage task assignment sub-resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
storageTaskAssignmentName:
{
Description: The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignments_List (new)
Description :  List all the storage task assignments in an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of storage task assignment Ids to be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of storage task assignments and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the storage task assignment. ,
Required: True ,
}
{
taskId:
{
Description: Id of the corresponding storage task ,
Format: arm-id ,
Required: True ,
}
string ,
enabled:
{
Description: Whether the storage task assignment is enabled or not ,
Required: True ,
}
boolean ,
description:
{
Description: Text that describes the purpose of the storage task assignment ,
Required: True ,
}
string ,
executionContext:
{
Description: The storage task assignment execution context ,
Required: True ,
}
{
target:
{
Description: Execution target of the storage task assignment ,
Required: False ,
}
{
prefix:
{
Description: Required list of object prefixes to be included for task execution ,
Required: False ,
}
[
string ,
]
,
excludePrefix:
{
Description: List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor ,
Required: False ,
}
[
string ,
]
,
}
,
trigger:
{
Description: Execution trigger of the storage task assignment ,
Required: True ,
}
{
type:
{
Description: The trigger type of the storage task assignment execution ,
Enum:
{
RunOnce: No description available. ,
OnSchedule: No description available. ,
}
,
Required: True ,
}
enum ,
parameters:
{
Description: The trigger parameters of the storage task assignment execution ,
Required: True ,
}
{
startFrom:
{
Description: When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: int32 ,
Required: False ,
}
integer ,
intervalUnit:
{
Description: Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Enum:
{
Days: No description available. ,
}
,
Required: False ,
}
enum ,
endBy:
{
Description: When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' ,
Format: date-time ,
Required: False ,
}
string ,
startOn:
{
Description: When to start task execution. This is an optional field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
report:
{
Description: The storage task assignment report ,
Required: True ,
}
{
prefix:
{
Description: The container prefix for the location of storage task assignment report ,
Required: True ,
}
string ,
}
,
provisioningState:
{
Description: Represents the provisioning state of the storage task assignment. ,
Enum:
{
ValidateSubscriptionQuotaBegin: No description available. ,
ValidateSubscriptionQuotaEnd: No description available. ,
Creating: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
runStatus:
{
Description: Run status of storage task assignment ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of storage task assignments. Returned when total number of requested storage task assignments exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignmentsInstancesReport_List (new)
Description :  Fetch the report summary of all the storage task assignments and instances in an account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/reports
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of storage task assignment instances to be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets storage tasks run result summary. ,
Required: False ,
}
[
{
properties:
{
Description: Storage task execution report for a run instance. ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of storage task run results summary. Returned when the number of run instances and summary reports exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StorageTaskAssignmentInstancesReport_List (new)
Description :  Fetch the report summary of a single storage task assignment's instances
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/storageTaskAssignments/{storageTaskAssignmentName}/reports
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
storageTaskAssignmentName:
{
Description: The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ,
Required: True ,
}
string ,
$maxpagesize:
{
Description: Optional, specifies the maximum number of storage task assignment instances to be included in the list response. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: Optional. When specified, it can be used to query using reporting properties. See [Constructing Filter Strings](https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#constructing-filter-strings) for details. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets storage tasks run result summary. ,
Required: False ,
}
[
{
properties:
{
Description: Storage task execution report for a run instance. ,
Required: False ,
}
{
taskAssignmentId:
{
Description: Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountId:
{
Description: Represents the Storage Account Id where the storage task definition was applied and executed. ,
Format: arm-id ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
finishTime:
{
Description: End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsTargetedCount:
{
Description: Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsOperatedOnCount:
{
Description: Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectFailedCount:
{
Description: Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
objectsSucceededCount:
{
Description: Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/en-us/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators ,
Required: False ,
}
string ,
runStatusError:
{
Description: Well known Azure Storage error code that represents the error encountered during execution of the run instance. ,
Required: False ,
}
string ,
runStatusEnum:
{
Description: Represents the status of the execution. ,
Enum:
{
InProgress: No description available. ,
Finished: No description available. ,
}
,
Required: False ,
}
enum ,
summaryReportPath:
{
Description: Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. ,
Required: False ,
}
string ,
taskId:
{
Description: Storage Task Arm Id. ,
Format: arm-id ,
Required: False ,
}
string ,
taskVersion:
{
Description: Storage Task Version ,
Required: False ,
}
string ,
runResult:
{
Description: Represents the overall result of the execution for the run instance ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of storage task run results summary. Returned when the number of run instances and summary reports exceed maximum page size. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TableServices_List (new)
Description :  List all table services for the storage account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of table services returned. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a storage account’s Table service. ,
Required: False ,
}
{
cors:
{
Description: Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TableServices_SetServiceProperties (new)
Description :  Sets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
tableServiceName:
{
Description: The name of the Table Service within the specified storage account. Table Service Name must be 'default' ,
Required: True ,
}
string ,
parameters:
{
Description: The properties of a storage account’s Table service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified. ,
Required: True ,
}
{
properties:
{
Description: The properties of a storage account’s Table service. ,
Required: False ,
}
{
cors:
{
Description: Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a storage account’s Table service. ,
Required: False ,
}
{
cors:
{
Description: Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
TableServices_GetServiceProperties (new)
Description :  Gets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/{tableServiceName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
tableServiceName:
{
Description: The name of the Table Service within the specified storage account. Table Service Name must be 'default' ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a storage account’s Table service. ,
Required: False ,
}
{
cors:
{
Description: Specifies CORS rules for the Table service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Table service. ,
Required: False ,
}
{
corsRules:
{
Description: The List of CORS rules. You can include up to five CorsRule elements in the request. ,
Required: False ,
}
[
{
allowedOrigins:
{
Description: Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains ,
Required: True ,
}
[
string ,
]
,
allowedMethods:
{
Description: Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. ,
Required: True ,
}
integer ,
exposedHeaders:
{
Description: Required if CorsRule element is present. A list of response headers to expose to CORS clients. ,
Required: True ,
}
[
string ,
]
,
allowedHeaders:
{
Description: Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Table_Create (new)
Description :  Creates a new table with the specified table name, under the specified account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide to create a table. ,
Required: False ,
}
{
properties:
{
Description: Table resource properties. ,
Required: False ,
}
{
tableName:
{
Description: Table name under the specified account ,
Required: False ,
}
string ,
signedIdentifiers:
{
Description: List of stored access policies specified on the table. ,
Required: False ,
}
[
{
id:
{
Description: unique-64-character-value of the stored access policy. ,
Required: True ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
tableName:
{
Description: A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Table resource properties. ,
Required: False ,
}
{
tableName:
{
Description: Table name under the specified account ,
Required: False ,
}
string ,
signedIdentifiers:
{
Description: List of stored access policies specified on the table. ,
Required: False ,
}
[
{
id:
{
Description: unique-64-character-value of the stored access policy. ,
Required: True ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Table_Update (new)
Description :  Creates a new table with the specified table name, under the specified account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters to provide to create a table. ,
Required: False ,
}
{
properties:
{
Description: Table resource properties. ,
Required: False ,
}
{
tableName:
{
Description: Table name under the specified account ,
Required: False ,
}
string ,
signedIdentifiers:
{
Description: List of stored access policies specified on the table. ,
Required: False ,
}
[
{
id:
{
Description: unique-64-character-value of the stored access policy. ,
Required: True ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
tableName:
{
Description: A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Table resource properties. ,
Required: False ,
}
{
tableName:
{
Description: Table name under the specified account ,
Required: False ,
}
string ,
signedIdentifiers:
{
Description: List of stored access policies specified on the table. ,
Required: False ,
}
[
{
id:
{
Description: unique-64-character-value of the stored access policy. ,
Required: True ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Table_Get (new)
Description :  Gets the table with the specified table name, under the specified account if it exists.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
tableName:
{
Description: A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Table resource properties. ,
Required: False ,
}
{
tableName:
{
Description: Table name under the specified account ,
Required: False ,
}
string ,
signedIdentifiers:
{
Description: List of stored access policies specified on the table. ,
Required: False ,
}
[
{
id:
{
Description: unique-64-character-value of the stored access policy. ,
Required: True ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Table_Delete (new)
Description :  Deletes the table with the specified table name, under the specified account if it exists.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables/{tableName}
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
tableName:
{
Description: A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Table_List (new)
Description :  Gets a list of all the tables under the specified storage account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/tableServices/default/tables
{
resourceGroupName:
{
Description: The name of the resource group within the user's subscription. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: 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. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of tables returned. ,
Required: False ,
}
[
{
properties:
{
Description: Table resource properties. ,
Required: False ,
}
{
tableName:
{
Description: Table name under the specified account ,
Required: False ,
}
string ,
signedIdentifiers:
{
Description: List of stored access policies specified on the table. ,
Required: False ,
}
[
{
id:
{
Description: unique-64-character-value of the stored access policy. ,
Required: True ,
}
string ,
accessPolicy:
{
Description: Access policy ,
Required: False ,
}
{
startTime:
{
Description: Start time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
expiryTime:
{
Description: Expiry time of the access policy ,
Format: date-time ,
Required: False ,
}
string ,
permission:
{
Description: Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page of tables ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from the Storage service. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}