StorageAccountResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Class representing a StorageAccount along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a StorageAccountResource from an instance of ArmClient using the GetStorageAccountResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetStorageAccount method.
public class StorageAccountResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Storage.StorageAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Storage.StorageAccountData>public class StorageAccountResource : Azure.ResourceManager.ArmResourcetype StorageAccountResource = class
inherit ArmResource
interface IJsonModel<StorageAccountData>
interface IPersistableModel<StorageAccountData>type StorageAccountResource = class
inherit ArmResourcePublic Class StorageAccountResource
Inherits ArmResource
Implements IJsonModel(Of StorageAccountData), IPersistableModel(Of StorageAccountData)Public Class StorageAccountResource
Inherits ArmResource- Inheritance
- Implements
Constructors
| StorageAccountResource() |
Initializes a new instance of the StorageAccountResource class for mocking. |
Fields
| ResourceType |
Gets the resource type for the operations. |
Properties
| Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
| Data |
Gets the data representing this Feature. |
| Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
| Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
| HasData |
Gets whether or not the current instance has data. |
| Id |
Gets the resource identifier. (Inherited from ArmResource) |
| Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
| AbortHierarchicalNamespaceMigration(WaitUntil, CancellationToken) |
Abort live Migration of storage account to enable Hns
|
| AbortHierarchicalNamespaceMigrationAsync(WaitUntil, CancellationToken) |
Abort live Migration of storage account to enable Hns
|
| AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
| AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
| CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
| CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a StorageAccountResource instance. |
| CustomerInitiatedMigration(WaitUntil, StorageAccountMigrationData, CancellationToken) |
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.
|
| CustomerInitiatedMigrationAsync(WaitUntil, StorageAccountMigrationData, CancellationToken) |
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.
|
| Delete(WaitUntil, CancellationToken) |
Deletes a storage account in Microsoft Azure.
|
| DeleteAsync(WaitUntil, CancellationToken) |
Deletes a storage account in Microsoft Azure.
|
| EnableHierarchicalNamespace(WaitUntil, String, CancellationToken) |
Live Migration of storage account to enable Hns
|
| EnableHierarchicalNamespaceAsync(WaitUntil, String, CancellationToken) |
Live Migration of storage account to enable Hns
|
| Failover(WaitUntil, CancellationToken) |
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://video2.skills-academy.com/en-us/azure/storage/common/storage-disaster-recovery-guidance
|
| Failover(WaitUntil, Nullable<StorageAccountFailoverType>, CancellationToken) |
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://video2.skills-academy.com/en-us/azure/storage/common/storage-disaster-recovery-guidance
|
| FailoverAsync(WaitUntil, CancellationToken) |
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://video2.skills-academy.com/en-us/azure/storage/common/storage-disaster-recovery-guidance
|
| FailoverAsync(WaitUntil, Nullable<StorageAccountFailoverType>, CancellationToken) |
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://video2.skills-academy.com/en-us/azure/storage/common/storage-disaster-recovery-guidance
|
| Get(Nullable<StorageAccountExpand>, CancellationToken) |
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.
|
| GetAccountSas(AccountSasContent, CancellationToken) |
List SAS credentials of a storage account.
|
| GetAccountSasAsync(AccountSasContent, CancellationToken) |
List SAS credentials of a storage account.
|
| GetAsync(Nullable<StorageAccountExpand>, CancellationToken) |
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.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetBlobInventoryPolicy() |
Gets an object representing a BlobInventoryPolicyResource along with the instance operations that can be performed on it in the StorageAccount. |
| GetBlobService() |
Gets an object representing a BlobServiceResource along with the instance operations that can be performed on it in the StorageAccount. |
| GetEncryptionScope(String, CancellationToken) |
Returns the properties for the specified encryption scope.
|
| GetEncryptionScopeAsync(String, CancellationToken) |
Returns the properties for the specified encryption scope.
|
| GetEncryptionScopes() |
Gets a collection of EncryptionScopeResources in the StorageAccount. |
| GetFileService() |
Gets an object representing a FileServiceResource along with the instance operations that can be performed on it in the StorageAccount. |
| GetKeys(Nullable<StorageListKeyExpand>, CancellationToken) |
Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.
|
| GetKeysAsync(Nullable<StorageListKeyExpand>, CancellationToken) |
Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.
|
| GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
| GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
| GetNetworkSecurityPerimeterConfiguration(String, CancellationToken) |
Gets effective NetworkSecurityPerimeterConfiguration for association
|
| GetNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken) |
Gets effective NetworkSecurityPerimeterConfiguration for association
|
| GetNetworkSecurityPerimeterConfigurations() |
Gets a collection of NetworkSecurityPerimeterConfigurationResources in the StorageAccount. |
| GetObjectReplicationPolicies() |
Gets a collection of ObjectReplicationPolicyResources in the StorageAccount. |
| GetObjectReplicationPolicy(String, CancellationToken) |
Get the object replication policy of the storage account by policy ID.
|
| GetObjectReplicationPolicyAsync(String, CancellationToken) |
Get the object replication policy of the storage account by policy ID.
|
| GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
| GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
| GetPrivateLinkResources(CancellationToken) |
Gets the private link resources that need to be created for a storage account.
|
| GetPrivateLinkResourcesAsync(CancellationToken) |
Gets the private link resources that need to be created for a storage account.
|
| GetQueueService() |
Gets an object representing a QueueServiceResource along with the instance operations that can be performed on it in the StorageAccount. |
| GetServiceSas(ServiceSasContent, CancellationToken) |
List service SAS credentials of a specific resource.
|
| GetServiceSasAsync(ServiceSasContent, CancellationToken) |
List service SAS credentials of a specific resource.
|
| GetStorageAccountLocalUser(String, CancellationToken) |
Get the local user of the storage account by username.
|
| GetStorageAccountLocalUserAsync(String, CancellationToken) |
Get the local user of the storage account by username.
|
| GetStorageAccountLocalUsers() |
Gets a collection of StorageAccountLocalUserResources in the StorageAccount. |
| GetStorageAccountManagementPolicy() |
Gets an object representing a StorageAccountManagementPolicyResource along with the instance operations that can be performed on it in the StorageAccount. |
| GetStorageAccountMigration(StorageAccountMigrationName, CancellationToken) |
Gets the status of the ongoing migration for the specified storage account.
|
| GetStorageAccountMigrationAsync(StorageAccountMigrationName, CancellationToken) |
Gets the status of the ongoing migration for the specified storage account.
|
| GetStorageAccountMigrations() |
Gets a collection of StorageAccountMigrationResources in the StorageAccount. |
| GetStoragePrivateEndpointConnection(String, CancellationToken) |
Gets the specified private endpoint connection associated with the storage account.
|
| GetStoragePrivateEndpointConnectionAsync(String, CancellationToken) |
Gets the specified private endpoint connection associated with the storage account.
|
| GetStoragePrivateEndpointConnections() |
Gets a collection of StoragePrivateEndpointConnectionResources in the StorageAccount. |
| GetStorageTaskAssignment(String, CancellationToken) |
Get the storage task assignment properties
|
| GetStorageTaskAssignmentAsync(String, CancellationToken) |
Get the storage task assignment properties
|
| GetStorageTaskAssignments() |
Gets a collection of StorageTaskAssignmentResources in the StorageAccount. |
| GetStorageTaskAssignmentsInstancesReports(Nullable<Int32>, String, CancellationToken) |
Fetch the report summary of all the storage task assignments and instances in an account
|
| GetStorageTaskAssignmentsInstancesReportsAsync(Nullable<Int32>, String, CancellationToken) |
Fetch the report summary of all the storage task assignments and instances in an account
|
| GetTableService() |
Gets an object representing a TableServiceResource along with the instance operations that can be performed on it in the StorageAccount. |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| RegenerateKey(StorageAccountRegenerateKeyContent, CancellationToken) |
Regenerates one of the access keys or Kerberos keys for the specified storage account.
|
| RegenerateKeyAsync(StorageAccountRegenerateKeyContent, CancellationToken) |
Regenerates one of the access keys or Kerberos keys for the specified storage account.
|
| RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
| RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
| RestoreBlobRanges(WaitUntil, BlobRestoreContent, CancellationToken) |
Restore blobs in the specified blob ranges
|
| RestoreBlobRangesAsync(WaitUntil, BlobRestoreContent, CancellationToken) |
Restore blobs in the specified blob ranges
|
| RevokeUserDelegationKeys(CancellationToken) |
Revoke user delegation keys.
|
| RevokeUserDelegationKeysAsync(CancellationToken) |
Revoke user delegation keys.
|
| SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
| SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(StorageAccountPatch, CancellationToken) |
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.
|
| UpdateAsync(StorageAccountPatch, CancellationToken) |
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.
|
Explicit Interface Implementations
| IJsonModel<StorageAccountData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<StorageAccountData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<StorageAccountData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<StorageAccountData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<StorageAccountData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Extension Methods
| GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
| GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
| GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
| GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
| GetRoleAssignment(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
| GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
| GetRoleAssignments(ArmResource) |
Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
| GetRoleAssignmentSchedule(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
| GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
| GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
| GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
| GetRoleAssignmentScheduleInstances(ArmResource) |
Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
| GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
| GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
| GetRoleAssignmentScheduleRequests(ArmResource) |
Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
| GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
| GetRoleEligibilitySchedule(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
| GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
| GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
| GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
| GetRoleEligibilityScheduleInstances(ArmResource) |
Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
| GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
| GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
| GetRoleEligibilityScheduleRequests(ArmResource) |
Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
| GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
| GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
| GetRoleManagementPolicy(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
| GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
| GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
| GetRoleManagementPolicyAssignments(ArmResource) |
Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
| GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
| GetSystemAssignedIdentity(ArmResource) |
Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
| GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
| GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |
Applies to
Azure SDK for .NET