StorageAccounts interface
代表 StorageAccounts 的介面。
方法
方法詳細資料
beginAbortHierarchicalNamespaceMigration(string, string, StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams)
中止儲存體帳戶的即時移轉以啟用 Hns
function beginAbortHierarchicalNamespaceMigration(resourceGroupName: string, accountName: string, options?: StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginAbortHierarchicalNamespaceMigrationAndWait(string, string, StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams)
中止儲存體帳戶的即時移轉以啟用 Hns
function beginAbortHierarchicalNamespaceMigrationAndWait(resourceGroupName: string, accountName: string, options?: StorageAccountsAbortHierarchicalNamespaceMigrationOptionalParams): Promise<void>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
傳回
Promise<void>
beginCreate(string, string, StorageAccountCreateParameters, StorageAccountsCreateOptionalParams)
以非同步方式建立具有指定參數的新儲存體帳戶。 如果帳戶已建立，且後續的建立要求會以不同的屬性發出，則會更新帳戶屬性。 如果帳戶已建立，且後續的建立或更新要求會發出完全相同的屬性集，要求將會成功。
function beginCreate(resourceGroupName: string, accountName: string, parameters: StorageAccountCreateParameters, options?: StorageAccountsCreateOptionalParams): Promise<SimplePollerLike<OperationState<StorageAccount>, StorageAccount>>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- StorageAccountCreateParameters
要提供給所建立帳戶的參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<StorageAccount>, StorageAccount>>
beginCreateAndWait(string, string, StorageAccountCreateParameters, StorageAccountsCreateOptionalParams)
以非同步方式建立具有指定參數的新儲存體帳戶。 如果帳戶已建立，且後續的建立要求會以不同的屬性發出，則會更新帳戶屬性。 如果帳戶已建立，且後續的建立或更新要求會發出完全相同的屬性集，要求將會成功。
function beginCreateAndWait(resourceGroupName: string, accountName: string, parameters: StorageAccountCreateParameters, options?: StorageAccountsCreateOptionalParams): Promise<StorageAccount>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- StorageAccountCreateParameters
要提供給所建立帳戶的參數。
選項參數。
傳回
Promise<StorageAccount>
beginCustomerInitiatedMigration(string, string, StorageAccountMigration, StorageAccountsCustomerInitiatedMigrationOptionalParams)
您可以觸發帳戶移轉要求，讓儲存體帳戶變更其備援層級。 移轉會將非區域備援儲存體帳戶更新為區域性備援帳戶，反之亦然，以取得更好的可靠性和可用性。 區域備援儲存體 (ZRS) 會在主要區域中將儲存體帳戶同步複寫至三個 Azure 可用區域。
function beginCustomerInitiatedMigration(resourceGroupName: string, accountName: string, parameters: StorageAccountMigration, options?: StorageAccountsCustomerInitiatedMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- StorageAccountMigration
執行儲存體帳戶移轉所需的要求參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginCustomerInitiatedMigrationAndWait(string, string, StorageAccountMigration, StorageAccountsCustomerInitiatedMigrationOptionalParams)
您可以觸發帳戶移轉要求，讓儲存體帳戶變更其備援層級。 移轉會將非區域備援儲存體帳戶更新為區域性備援帳戶，反之亦然，以取得更好的可靠性和可用性。 區域備援儲存體 (ZRS) 會在主要區域中將儲存體帳戶同步複寫至三個 Azure 可用區域。
function beginCustomerInitiatedMigrationAndWait(resourceGroupName: string, accountName: string, parameters: StorageAccountMigration, options?: StorageAccountsCustomerInitiatedMigrationOptionalParams): Promise<void>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- StorageAccountMigration
執行儲存體帳戶移轉所需的要求參數。
選項參數。
傳回
Promise<void>
beginFailover(string, string, StorageAccountsFailoverOptionalParams)
當主要端點因任何原因而無法使用時，可以觸發儲存體帳戶的容錯移轉要求。 容錯移轉會從儲存體帳戶的主要叢集發生到 RA-GRS 帳戶的次要叢集。 次要叢集會在容錯移轉之後變成主要叢集，而且帳戶會轉換成 LRS。 在計劃性容錯移轉的情況下，主要和次要叢集會在容錯移轉後交換，而且帳戶仍會異地複寫。 容錯移轉應該會在可用性問題發生時繼續使用，因為只有在主要和次要端點可用時，才能使用計劃性容錯移轉。 計劃性容錯移轉的主要使用案例是災害復原測試演練。 將 FailoverType 參數設定為 'Planned'，以叫用這種類型的容錯移轉。 在這裡深入瞭解容錯移轉選項- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance
function beginFailover(resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFailoverAndWait(string, string, StorageAccountsFailoverOptionalParams)
當主要端點因任何原因而無法使用時，可以觸發儲存體帳戶的容錯移轉要求。 容錯移轉會從儲存體帳戶的主要叢集發生到 RA-GRS 帳戶的次要叢集。 次要叢集會在容錯移轉之後變成主要叢集，而且帳戶會轉換成 LRS。 在計劃性容錯移轉的情況下，主要和次要叢集會在容錯移轉後交換，而且帳戶仍會異地複寫。 容錯移轉應該會在可用性問題發生時繼續使用，因為只有在主要和次要端點可用時，才能使用計劃性容錯移轉。 計劃性容錯移轉的主要使用案例是災害復原測試演練。 將 FailoverType 參數設定為 'Planned'，以叫用這種類型的容錯移轉。 在這裡深入瞭解容錯移轉選項- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance
function beginFailoverAndWait(resourceGroupName: string, accountName: string, options?: StorageAccountsFailoverOptionalParams): Promise<void>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
選項參數。
傳回
Promise<void>
beginHierarchicalNamespaceMigration(string, string, string, StorageAccountsHierarchicalNamespaceMigrationOptionalParams)
即時移轉儲存體帳戶以啟用 Hns
function beginHierarchicalNamespaceMigration(resourceGroupName: string, accountName: string, requestType: string, options?: StorageAccountsHierarchicalNamespaceMigrationOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- requestType
-
string
必要。 階層命名空間移轉類型可以是階層命名空間驗證要求 'HnsOnValidationRequest' 或凍結要求 'HnsOnHydrationRequest'。 驗證要求會驗證移轉，而凍結要求則會移轉帳戶。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginHierarchicalNamespaceMigrationAndWait(string, string, string, StorageAccountsHierarchicalNamespaceMigrationOptionalParams)
即時移轉儲存體帳戶以啟用 Hns
function beginHierarchicalNamespaceMigrationAndWait(resourceGroupName: string, accountName: string, requestType: string, options?: StorageAccountsHierarchicalNamespaceMigrationOptionalParams): Promise<void>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- requestType
-
string
必要。 階層命名空間移轉類型可以是階層命名空間驗證要求 'HnsOnValidationRequest' 或凍結要求 'HnsOnHydrationRequest'。 驗證要求會驗證移轉，而凍結要求則會移轉帳戶。
傳回
Promise<void>
beginRestoreBlobRanges(string, string, BlobRestoreParameters, StorageAccountsRestoreBlobRangesOptionalParams)
還原指定 Blob 範圍中的 Blob
function beginRestoreBlobRanges(resourceGroupName: string, accountName: string, parameters: BlobRestoreParameters, options?: StorageAccountsRestoreBlobRangesOptionalParams): Promise<SimplePollerLike<OperationState<BlobRestoreStatus>, BlobRestoreStatus>>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- BlobRestoreParameters
要提供還原 Blob 範圍的參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<BlobRestoreStatus>, BlobRestoreStatus>>
beginRestoreBlobRangesAndWait(string, string, BlobRestoreParameters, StorageAccountsRestoreBlobRangesOptionalParams)
還原指定 Blob 範圍中的 Blob
function beginRestoreBlobRangesAndWait(resourceGroupName: string, accountName: string, parameters: BlobRestoreParameters, options?: StorageAccountsRestoreBlobRangesOptionalParams): Promise<BlobRestoreStatus>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- BlobRestoreParameters
要提供還原 Blob 範圍的參數。
選項參數。
傳回
Promise<BlobRestoreStatus>
checkNameAvailability(StorageAccountCheckNameAvailabilityParameters, StorageAccountsCheckNameAvailabilityOptionalParams)
檢查儲存體帳戶名稱是否有效，且尚未使用中。
function checkNameAvailability(accountName: StorageAccountCheckNameAvailabilityParameters, options?: StorageAccountsCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResult>參數
- accountName
- StorageAccountCheckNameAvailabilityParameters
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
選項參數。
傳回
Promise<CheckNameAvailabilityResult>
delete(string, string, StorageAccountsDeleteOptionalParams)
刪除 Microsoft Azure 中的儲存體帳戶。
function delete(resourceGroupName: string, accountName: string, options?: StorageAccountsDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
選項參數。
傳回
Promise<void>
getCustomerInitiatedMigration(string, string, string, StorageAccountsGetCustomerInitiatedMigrationOptionalParams)
取得指定儲存體帳戶進行中移轉的狀態。
function getCustomerInitiatedMigration(resourceGroupName: string, accountName: string, migrationName: string, options?: StorageAccountsGetCustomerInitiatedMigrationOptionalParams): Promise<StorageAccountMigration>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- migrationName
-
string
儲存體帳戶移轉的名稱。 它應該一律為 'default'
傳回
Promise<StorageAccountMigration>
getProperties(string, string, StorageAccountsGetPropertiesOptionalParams)
傳回指定儲存體帳戶的屬性，包括但不限於名稱、SKU 名稱、位置和帳戶狀態。 ListKeys 作業應該用來擷取儲存體金鑰。
function getProperties(resourceGroupName: string, accountName: string, options?: StorageAccountsGetPropertiesOptionalParams): Promise<StorageAccount>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
選項參數。
傳回
Promise<StorageAccount>
list(StorageAccountsListOptionalParams)
列出訂用帳戶下可用的所有儲存體帳戶。 請注意，不會傳回儲存體金鑰;請使用 ListKeys 作業來進行此作業。
function list(options?: StorageAccountsListOptionalParams): PagedAsyncIterableIterator<StorageAccount, StorageAccount[], PageSettings>參數
選項參數。
傳回
listAccountSAS(string, string, AccountSasParameters, StorageAccountsListAccountSASOptionalParams)
列出儲存體帳戶的 SAS 認證。
function listAccountSAS(resourceGroupName: string, accountName: string, parameters: AccountSasParameters, options?: StorageAccountsListAccountSASOptionalParams): Promise<ListAccountSasResponse>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- AccountSasParameters
要提供以列出儲存體帳戶 SAS 認證的參數。
選項參數。
傳回
Promise<ListAccountSasResponse>
listByResourceGroup(string, StorageAccountsListByResourceGroupOptionalParams)
列出指定資源群組下可用的所有儲存體帳戶。 請注意，不會傳回儲存體金鑰;請使用 ListKeys 作業來進行此作業。
function listByResourceGroup(resourceGroupName: string, options?: StorageAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<StorageAccount, StorageAccount[], PageSettings>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
選項參數。
傳回
listKeys(string, string, StorageAccountsListKeysOptionalParams)
如果指定的儲存體帳戶啟用 active directory) ，則會列出存取金鑰或 Kerberos 金鑰 (。
function listKeys(resourceGroupName: string, accountName: string, options?: StorageAccountsListKeysOptionalParams): Promise<StorageAccountListKeysResult>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
選項參數。
傳回
Promise<StorageAccountListKeysResult>
listServiceSAS(string, string, ServiceSasParameters, StorageAccountsListServiceSASOptionalParams)
列出特定資源的服務 SAS 認證。
function listServiceSAS(resourceGroupName: string, accountName: string, parameters: ServiceSasParameters, options?: StorageAccountsListServiceSASOptionalParams): Promise<ListServiceSasResponse>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- ServiceSasParameters
要提供以列出服務 SAS 認證的參數。
選項參數。
傳回
Promise<ListServiceSasResponse>
regenerateKey(string, string, StorageAccountRegenerateKeyParameters, StorageAccountsRegenerateKeyOptionalParams)
針對指定的儲存體帳戶重新產生其中一個存取金鑰或 Kerberos 金鑰。
function regenerateKey(resourceGroupName: string, accountName: string, regenerateKey: StorageAccountRegenerateKeyParameters, options?: StorageAccountsRegenerateKeyOptionalParams): Promise<StorageAccountListKeysResult>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- regenerateKey
- StorageAccountRegenerateKeyParameters
指定應該重新產生之金鑰的名稱 -- key1、key2、kerb1、kerb2。
選項參數。
傳回
Promise<StorageAccountListKeysResult>
revokeUserDelegationKeys(string, string, StorageAccountsRevokeUserDelegationKeysOptionalParams)
撤銷使用者委派金鑰。
function revokeUserDelegationKeys(resourceGroupName: string, accountName: string, options?: StorageAccountsRevokeUserDelegationKeysOptionalParams): Promise<void>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
選項參數。
傳回
Promise<void>
update(string, string, StorageAccountUpdateParameters, StorageAccountsUpdateOptionalParams)
更新作業可用來更新儲存體帳戶的 SKU、加密、存取層或標記。 它也可以用來將帳戶對應至自訂網域。 每個儲存體帳戶只支援一個自訂網域;不支援取代/變更自訂網域。 若要取代舊的自訂定義域，必須先清除/取消註冊舊的值，才能設定新的值。 支援更新多個屬性。 此呼叫不會變更帳戶的儲存體金鑰。 如果您想要變更儲存體帳戶金鑰，請使用重新產生金鑰作業。 建立之後，無法變更儲存體帳戶的位置和名稱。
function update(resourceGroupName: string, accountName: string, parameters: StorageAccountUpdateParameters, options?: StorageAccountsUpdateOptionalParams): Promise<StorageAccount>參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。
- parameters
- StorageAccountUpdateParameters
要為更新帳戶提供的參數。
選項參數。
傳回
Promise<StorageAccount>