Storage Accounts - Get Properties

Service:

Storage Resource Provider

API Version:

2023-01-01

傳回指定記憶體帳戶的屬性，包括但不限於名稱、SKU 名稱、位置和帳戶狀態。 ListKeys 作業應該用來擷取記憶體密鑰。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2023-01-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2023-01-01&$expand={$expand}

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	指定資源群組內的記憶體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度，而且只能使用數字和小寫字母。 Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。 名稱不區分大小寫。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。
$expand	query		StorageAccountExpand	可用來展開帳戶屬性內的屬性。 根據預設，擷取屬性時不會包含數據。 目前我們只支援 geoReplicationStats 和 blobRestoreStatus。

回應

名稱	類型	Description
200 OK	StorageAccount	確定 -- 已成功擷取記憶體帳戶的屬性。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

StorageAccountGetAsyncSkuConversionStatus

StorageAccountGetProperties

StorageAccountGetPropertiesCMKEnabled

StorageAccountGetPropertiesCMKVersionExpirationTime

StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse

StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue

StorageAccountGetAsyncSkuConversionStatus

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2023-01-01

Java

/** Samples for StorageAccounts GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/
     * StorageAccountGetAsyncSkuConversionStatus.json
     */
    /**
     * Sample code: StorageAccountGetAsyncSkuConversionStatus.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountGetAsyncSkuConversionStatus(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().getByResourceGroupWithResponse("res9407",
            "sto8596", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_get_async_sku_conversion_status.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.get_properties(
        resource_group_name="res9407",
        account_name="sto8596",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetAsyncSkuConversionStatus.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetAsyncSkuConversionStatus.json
func ExampleAccountsClient_GetProperties_storageAccountGetAsyncSkuConversionStatus() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().GetProperties(ctx, "res9407", "sto8596", &armstorage.AccountsClientGetPropertiesOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armstorage.Account{
	// 	Name: to.Ptr("sto8596"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596"),
	// 	Location: to.Ptr("eastus"),
	// 	Kind: to.Ptr(armstorage.KindStorageV2),
	// 	Properties: &armstorage.AccountProperties{
	// 		AllowBlobPublicAccess: to.Ptr(false),
	// 		MinimumTLSVersion: to.Ptr(armstorage.MinimumTLSVersionTLS12),
	// 		StorageAccountSKUConversionStatus: &armstorage.AccountSKUConversionStatus{
	// 			EndTime: to.Ptr("2021-09-02T02:53:39.0932539Z"),
	// 			SKUConversionStatus: to.Ptr(armstorage.SKUConversionStatusInProgress),
	// 			StartTime: to.Ptr("2022-09-01T02:53:39.0932539Z"),
	// 			TargetSKUName: to.Ptr(armstorage.SKUNameStandardGRS),
	// 		},
	// 	},
	// 	SKU: &armstorage.SKU{
	// 		Name: to.Ptr(armstorage.SKUNameStandardGRS),
	// 		Tier: to.Ptr(armstorage.SKUTierStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetAsyncSkuConversionStatus.json
 */
async function storageAccountGetAsyncSkuConversionStatus() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9407";
  const accountName = "sto8596";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.getProperties(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "kind": "StorageV2",
  "location": "eastus",
  "name": "sto8596",
  "properties": {
    "allowBlobPublicAccess": false,
    "minimumTlsVersion": "TLS1_2",
    "storageAccountSkuConversionStatus": {
      "skuConversionStatus": "InProgress",
      "targetSkuName": "Standard_GRS",
      "startTime": "2022-09-01T02:53:39.0932539Z",
      "endTime": "2021-09-02T02:53:39.0932539Z"
    }
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

StorageAccountGetProperties

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2023-01-01

Java

/** Samples for StorageAccounts GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetProperties.
     * json
     */
    /**
     * Sample code: StorageAccountGetProperties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountGetProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().getByResourceGroupWithResponse("res9407",
            "sto8596", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_get_properties.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.get_properties(
        resource_group_name="res9407",
        account_name="sto8596",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetProperties.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetProperties.json
func ExampleAccountsClient_GetProperties_storageAccountGetProperties() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().GetProperties(ctx, "res9407", "sto8596", &armstorage.AccountsClientGetPropertiesOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armstorage.Account{
	// 	Name: to.Ptr("sto8596"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596"),
	// 	Location: to.Ptr("eastus2(stage)"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Kind: to.Ptr(armstorage.KindStorage),
	// 	Properties: &armstorage.AccountProperties{
	// 		AccountMigrationInProgress: to.Ptr(false),
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T02:42:41.763Z"); return t}()),
	// 		Encryption: &armstorage.Encryption{
	// 			KeySource: to.Ptr(armstorage.KeySourceMicrosoftStorage),
	// 			Services: &armstorage.EncryptionServices{
	// 				Blob: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 				File: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 			},
	// 		},
	// 		GeoReplicationStats: &armstorage.GeoReplicationStats{
	// 			CanFailover: to.Ptr(true),
	// 			LastSyncTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-30T00:25:34.000Z"); return t}()),
	// 			Status: to.Ptr(armstorage.GeoReplicationStatusLive),
	// 		},
	// 		IsHnsEnabled: to.Ptr(true),
	// 		IsSKUConversionBlocked: to.Ptr(false),
	// 		KeyCreationTime: &armstorage.KeyCreationTime{
	// 			Key1: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-18T04:42:22.432Z"); return t}()),
	// 			Key2: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-18T04:42:22.432Z"); return t}()),
	// 		},
	// 		NetworkRuleSet: &armstorage.NetworkRuleSet{
	// 			Bypass: to.Ptr(armstorage.BypassAzureServices),
	// 			DefaultAction: to.Ptr(armstorage.DefaultActionAllow),
	// 			IPRules: []*armstorage.IPRule{
	// 			},
	// 			ResourceAccessRules: []*armstorage.ResourceAccessRule{
	// 				{
	// 					ResourceID: to.Ptr("/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"),
	// 					TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 			}},
	// 			VirtualNetworkRules: []*armstorage.VirtualNetworkRule{
	// 			},
	// 		},
	// 		PrimaryEndpoints: &armstorage.Endpoints{
	// 			Blob: to.Ptr("https://sto8596.blob.core.windows.net/"),
	// 			Dfs: to.Ptr("https://sto8596.dfs.core.windows.net/"),
	// 			File: to.Ptr("https://sto8596.file.core.windows.net/"),
	// 			InternetEndpoints: &armstorage.AccountInternetEndpoints{
	// 				Blob: to.Ptr("https://sto8596-internetrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-internetrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-internetrouting.file.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-internetrouting.web.core.windows.net/"),
	// 			},
	// 			MicrosoftEndpoints: &armstorage.AccountMicrosoftEndpoints{
	// 				Blob: to.Ptr("https://sto8596-microsoftrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-microsoftrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-microsoftrouting.file.core.windows.net/"),
	// 				Queue: to.Ptr("https://sto8596-microsoftrouting.queue.core.windows.net/"),
	// 				Table: to.Ptr("https://sto8596-microsoftrouting.table.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-microsoftrouting.web.core.windows.net/"),
	// 			},
	// 			Queue: to.Ptr("https://sto8596.queue.core.windows.net/"),
	// 			Table: to.Ptr("https://sto8596.table.core.windows.net/"),
	// 			Web: to.Ptr("https://sto8596.web.core.windows.net/"),
	// 		},
	// 		PrimaryLocation: to.Ptr("eastus2(stage)"),
	// 		ProvisioningState: to.Ptr(armstorage.ProvisioningStateSucceeded),
	// 		RoutingPreference: &armstorage.RoutingPreference{
	// 			PublishInternetEndpoints: to.Ptr(true),
	// 			PublishMicrosoftEndpoints: to.Ptr(true),
	// 			RoutingChoice: to.Ptr(armstorage.RoutingChoiceMicrosoftRouting),
	// 		},
	// 		SecondaryLocation: to.Ptr("northcentralus(stage)"),
	// 		StatusOfPrimary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		StatusOfSecondary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		EnableHTTPSTrafficOnly: to.Ptr(false),
	// 	},
	// 	SKU: &armstorage.SKU{
	// 		Name: to.Ptr(armstorage.SKUNameStandardGRS),
	// 		Tier: to.Ptr(armstorage.SKUTierStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetProperties.json
 */
async function storageAccountGetProperties() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9407";
  const accountName = "sto8596";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.getProperties(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "kind": "Storage",
  "location": "eastus2(stage)",
  "name": "sto8596",
  "properties": {
    "keyCreationTime": {
      "key1": "2021-03-18T04:42:22.4322836Z",
      "key2": "2021-03-18T04:42:22.4322836Z"
    },
    "geoReplicationStats": {
      "status": "Live",
      "lastSyncTime": "2018-10-30T00:25:34Z",
      "canFailover": true
    },
    "isHnsEnabled": true,
    "creationTime": "2017-06-01T02:42:41.7633306Z",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Allow",
      "ipRules": [],
      "virtualNetworkRules": [],
      "resourceAccessRules": [
        {
          "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
          "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"
        }
      ]
    },
    "primaryEndpoints": {
      "web": "https://sto8596.web.core.windows.net/",
      "dfs": "https://sto8596.dfs.core.windows.net/",
      "blob": "https://sto8596.blob.core.windows.net/",
      "file": "https://sto8596.file.core.windows.net/",
      "queue": "https://sto8596.queue.core.windows.net/",
      "table": "https://sto8596.table.core.windows.net/",
      "microsoftEndpoints": {
        "web": "https://sto8596-microsoftrouting.web.core.windows.net/",
        "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/",
        "file": "https://sto8596-microsoftrouting.file.core.windows.net/",
        "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/",
        "table": "https://sto8596-microsoftrouting.table.core.windows.net/"
      },
      "internetEndpoints": {
        "web": "https://sto8596-internetrouting.web.core.windows.net/",
        "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-internetrouting.blob.core.windows.net/",
        "file": "https://sto8596-internetrouting.file.core.windows.net/"
      }
    },
    "primaryLocation": "eastus2(stage)",
    "provisioningState": "Succeeded",
    "routingPreference": {
      "routingChoice": "MicrosoftRouting",
      "publishMicrosoftEndpoints": true,
      "publishInternetEndpoints": true
    },
    "encryption": {
      "services": {
        "file": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        },
        "blob": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        }
      },
      "keySource": "Microsoft.Storage"
    },
    "secondaryLocation": "northcentralus(stage)",
    "statusOfPrimary": "available",
    "statusOfSecondary": "available",
    "supportsHttpsTrafficOnly": false,
    "isSkuConversionBlocked": false,
    "accountMigrationInProgress": false
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

StorageAccountGetPropertiesCMKEnabled

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2023-01-01

Java

/** Samples for StorageAccounts GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/
     * StorageAccountGetPropertiesCMKEnabled.json
     */
    /**
     * Sample code: StorageAccountGetPropertiesCMKEnabled.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountGetPropertiesCMKEnabled(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().getByResourceGroupWithResponse("res9407",
            "sto8596", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_get_properties_cmk_enabled.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.get_properties(
        resource_group_name="res9407",
        account_name="sto8596",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesCMKEnabled.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesCMKEnabled.json
func ExampleAccountsClient_GetProperties_storageAccountGetPropertiesCmkEnabled() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().GetProperties(ctx, "res9407", "sto8596", &armstorage.AccountsClientGetPropertiesOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armstorage.Account{
	// 	Name: to.Ptr("sto8596"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596"),
	// 	Location: to.Ptr("eastus2(stage)"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Identity: &armstorage.Identity{
	// 		Type: to.Ptr(armstorage.IdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("911871cc-ffd1-4fc4-ac11-7a316433ea66"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Kind: to.Ptr(armstorage.KindStorage),
	// 	Properties: &armstorage.AccountProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T02:42:41.763Z"); return t}()),
	// 		Encryption: &armstorage.Encryption{
	// 			KeySource: to.Ptr(armstorage.KeySourceMicrosoftKeyvault),
	// 			KeyVaultProperties: &armstorage.KeyVaultProperties{
	// 				CurrentVersionedKeyIdentifier: to.Ptr("https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad"),
	// 				KeyName: to.Ptr("wrappingKey"),
	// 				KeyVaultURI: to.Ptr("https://myvault8569.vault.azure.net"),
	// 				KeyVersion: to.Ptr(""),
	// 				LastKeyRotationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-13T20:36:23.702Z"); return t}()),
	// 			},
	// 			Services: &armstorage.EncryptionServices{
	// 				Blob: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 				File: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 			},
	// 		},
	// 		GeoReplicationStats: &armstorage.GeoReplicationStats{
	// 			CanFailover: to.Ptr(true),
	// 			LastSyncTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-30T00:25:34.000Z"); return t}()),
	// 			Status: to.Ptr(armstorage.GeoReplicationStatusLive),
	// 		},
	// 		IsHnsEnabled: to.Ptr(true),
	// 		NetworkRuleSet: &armstorage.NetworkRuleSet{
	// 			Bypass: to.Ptr(armstorage.BypassAzureServices),
	// 			DefaultAction: to.Ptr(armstorage.DefaultActionAllow),
	// 			IPRules: []*armstorage.IPRule{
	// 			},
	// 			ResourceAccessRules: []*armstorage.ResourceAccessRule{
	// 			},
	// 			VirtualNetworkRules: []*armstorage.VirtualNetworkRule{
	// 			},
	// 		},
	// 		PrimaryEndpoints: &armstorage.Endpoints{
	// 			Blob: to.Ptr("https://sto8596.blob.core.windows.net/"),
	// 			Dfs: to.Ptr("https://sto8596.dfs.core.windows.net/"),
	// 			File: to.Ptr("https://sto8596.file.core.windows.net/"),
	// 			InternetEndpoints: &armstorage.AccountInternetEndpoints{
	// 				Blob: to.Ptr("https://sto8596-internetrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-internetrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-internetrouting.file.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-internetrouting.web.core.windows.net/"),
	// 			},
	// 			MicrosoftEndpoints: &armstorage.AccountMicrosoftEndpoints{
	// 				Blob: to.Ptr("https://sto8596-microsoftrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-microsoftrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-microsoftrouting.file.core.windows.net/"),
	// 				Queue: to.Ptr("https://sto8596-microsoftrouting.queue.core.windows.net/"),
	// 				Table: to.Ptr("https://sto8596-microsoftrouting.table.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-microsoftrouting.web.core.windows.net/"),
	// 			},
	// 			Queue: to.Ptr("https://sto8596.queue.core.windows.net/"),
	// 			Table: to.Ptr("https://sto8596.table.core.windows.net/"),
	// 			Web: to.Ptr("https://sto8596.web.core.windows.net/"),
	// 		},
	// 		PrimaryLocation: to.Ptr("eastus2(stage)"),
	// 		ProvisioningState: to.Ptr(armstorage.ProvisioningStateSucceeded),
	// 		RoutingPreference: &armstorage.RoutingPreference{
	// 			PublishInternetEndpoints: to.Ptr(true),
	// 			PublishMicrosoftEndpoints: to.Ptr(true),
	// 			RoutingChoice: to.Ptr(armstorage.RoutingChoiceMicrosoftRouting),
	// 		},
	// 		SecondaryLocation: to.Ptr("northcentralus(stage)"),
	// 		StatusOfPrimary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		StatusOfSecondary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		EnableHTTPSTrafficOnly: to.Ptr(false),
	// 	},
	// 	SKU: &armstorage.SKU{
	// 		Name: to.Ptr(armstorage.SKUNameStandardGRS),
	// 		Tier: to.Ptr(armstorage.SKUTierStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesCMKEnabled.json
 */
async function storageAccountGetPropertiesCmkEnabled() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9407";
  const accountName = "sto8596";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.getProperties(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "identity": {
    "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  },
  "kind": "Storage",
  "location": "eastus2(stage)",
  "name": "sto8596",
  "properties": {
    "geoReplicationStats": {
      "status": "Live",
      "lastSyncTime": "2018-10-30T00:25:34Z",
      "canFailover": true
    },
    "isHnsEnabled": true,
    "creationTime": "2017-06-01T02:42:41.7633306Z",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Allow",
      "ipRules": [],
      "virtualNetworkRules": [],
      "resourceAccessRules": []
    },
    "primaryEndpoints": {
      "web": "https://sto8596.web.core.windows.net/",
      "dfs": "https://sto8596.dfs.core.windows.net/",
      "blob": "https://sto8596.blob.core.windows.net/",
      "file": "https://sto8596.file.core.windows.net/",
      "queue": "https://sto8596.queue.core.windows.net/",
      "table": "https://sto8596.table.core.windows.net/",
      "microsoftEndpoints": {
        "web": "https://sto8596-microsoftrouting.web.core.windows.net/",
        "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/",
        "file": "https://sto8596-microsoftrouting.file.core.windows.net/",
        "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/",
        "table": "https://sto8596-microsoftrouting.table.core.windows.net/"
      },
      "internetEndpoints": {
        "web": "https://sto8596-internetrouting.web.core.windows.net/",
        "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-internetrouting.blob.core.windows.net/",
        "file": "https://sto8596-internetrouting.file.core.windows.net/"
      }
    },
    "primaryLocation": "eastus2(stage)",
    "provisioningState": "Succeeded",
    "routingPreference": {
      "routingChoice": "MicrosoftRouting",
      "publishMicrosoftEndpoints": true,
      "publishInternetEndpoints": true
    },
    "encryption": {
      "services": {
        "file": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        },
        "blob": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        }
      },
      "keySource": "Microsoft.Keyvault",
      "keyvaultproperties": {
        "keyvaulturi": "https://myvault8569.vault.azure.net",
        "keyname": "wrappingKey",
        "keyversion": "",
        "currentVersionedKeyIdentifier": "https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad",
        "lastKeyRotationTimestamp": "2019-12-13T20:36:23.7023290Z"
      }
    },
    "secondaryLocation": "northcentralus(stage)",
    "statusOfPrimary": "available",
    "statusOfSecondary": "available",
    "supportsHttpsTrafficOnly": false
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

StorageAccountGetPropertiesCMKVersionExpirationTime

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2023-01-01

Java

/** Samples for StorageAccounts GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/
     * StorageAccountGetPropertiesCMKVersionExpirationTime.json
     */
    /**
     * Sample code: StorageAccountGetPropertiesCMKVersionExpirationTime.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        storageAccountGetPropertiesCMKVersionExpirationTime(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().getByResourceGroupWithResponse("res9407",
            "sto8596", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_get_properties_cmk_version_expiration_time.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.get_properties(
        resource_group_name="res9407",
        account_name="sto8596",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesCMKVersionExpirationTime.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesCMKVersionExpirationTime.json
func ExampleAccountsClient_GetProperties_storageAccountGetPropertiesCmkVersionExpirationTime() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().GetProperties(ctx, "res9407", "sto8596", &armstorage.AccountsClientGetPropertiesOptions{Expand: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armstorage.Account{
	// 	Name: to.Ptr("sto8596"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596"),
	// 	Location: to.Ptr("eastus2(stage)"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Identity: &armstorage.Identity{
	// 		Type: to.Ptr(armstorage.IdentityTypeSystemAssigned),
	// 		PrincipalID: to.Ptr("911871cc-ffd1-4fc4-ac11-7a316433ea66"),
	// 		TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 	},
	// 	Kind: to.Ptr(armstorage.KindStorage),
	// 	Properties: &armstorage.AccountProperties{
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T02:42:41.763Z"); return t}()),
	// 		Encryption: &armstorage.Encryption{
	// 			KeySource: to.Ptr(armstorage.KeySourceMicrosoftKeyvault),
	// 			KeyVaultProperties: &armstorage.KeyVaultProperties{
	// 				CurrentVersionedKeyExpirationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-13T20:36:23.702Z"); return t}()),
	// 				CurrentVersionedKeyIdentifier: to.Ptr("https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad"),
	// 				KeyName: to.Ptr("wrappingKey"),
	// 				KeyVaultURI: to.Ptr("https://myvault8569.vault.azure.net"),
	// 				KeyVersion: to.Ptr(""),
	// 				LastKeyRotationTimestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-13T20:36:23.702Z"); return t}()),
	// 			},
	// 			Services: &armstorage.EncryptionServices{
	// 				Blob: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 				File: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 			},
	// 		},
	// 		GeoReplicationStats: &armstorage.GeoReplicationStats{
	// 			CanFailover: to.Ptr(true),
	// 			LastSyncTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-30T00:25:34.000Z"); return t}()),
	// 			Status: to.Ptr(armstorage.GeoReplicationStatusLive),
	// 		},
	// 		IsHnsEnabled: to.Ptr(true),
	// 		NetworkRuleSet: &armstorage.NetworkRuleSet{
	// 			Bypass: to.Ptr(armstorage.BypassAzureServices),
	// 			DefaultAction: to.Ptr(armstorage.DefaultActionAllow),
	// 			IPRules: []*armstorage.IPRule{
	// 			},
	// 			ResourceAccessRules: []*armstorage.ResourceAccessRule{
	// 			},
	// 			VirtualNetworkRules: []*armstorage.VirtualNetworkRule{
	// 			},
	// 		},
	// 		PrimaryEndpoints: &armstorage.Endpoints{
	// 			Blob: to.Ptr("https://sto8596.blob.core.windows.net/"),
	// 			Dfs: to.Ptr("https://sto8596.dfs.core.windows.net/"),
	// 			File: to.Ptr("https://sto8596.file.core.windows.net/"),
	// 			InternetEndpoints: &armstorage.AccountInternetEndpoints{
	// 				Blob: to.Ptr("https://sto8596-internetrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-internetrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-internetrouting.file.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-internetrouting.web.core.windows.net/"),
	// 			},
	// 			MicrosoftEndpoints: &armstorage.AccountMicrosoftEndpoints{
	// 				Blob: to.Ptr("https://sto8596-microsoftrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-microsoftrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-microsoftrouting.file.core.windows.net/"),
	// 				Queue: to.Ptr("https://sto8596-microsoftrouting.queue.core.windows.net/"),
	// 				Table: to.Ptr("https://sto8596-microsoftrouting.table.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-microsoftrouting.web.core.windows.net/"),
	// 			},
	// 			Queue: to.Ptr("https://sto8596.queue.core.windows.net/"),
	// 			Table: to.Ptr("https://sto8596.table.core.windows.net/"),
	// 			Web: to.Ptr("https://sto8596.web.core.windows.net/"),
	// 		},
	// 		PrimaryLocation: to.Ptr("eastus2(stage)"),
	// 		ProvisioningState: to.Ptr(armstorage.ProvisioningStateSucceeded),
	// 		RoutingPreference: &armstorage.RoutingPreference{
	// 			PublishInternetEndpoints: to.Ptr(true),
	// 			PublishMicrosoftEndpoints: to.Ptr(true),
	// 			RoutingChoice: to.Ptr(armstorage.RoutingChoiceMicrosoftRouting),
	// 		},
	// 		SecondaryLocation: to.Ptr("northcentralus(stage)"),
	// 		StatusOfPrimary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		StatusOfSecondary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		EnableHTTPSTrafficOnly: to.Ptr(false),
	// 	},
	// 	SKU: &armstorage.SKU{
	// 		Name: to.Ptr(armstorage.SKUNameStandardGRS),
	// 		Tier: to.Ptr(armstorage.SKUTierStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesCMKVersionExpirationTime.json
 */
async function storageAccountGetPropertiesCmkVersionExpirationTime() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9407";
  const accountName = "sto8596";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.getProperties(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "identity": {
    "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  },
  "kind": "Storage",
  "location": "eastus2(stage)",
  "name": "sto8596",
  "properties": {
    "geoReplicationStats": {
      "status": "Live",
      "lastSyncTime": "2018-10-30T00:25:34Z",
      "canFailover": true
    },
    "isHnsEnabled": true,
    "creationTime": "2017-06-01T02:42:41.7633306Z",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Allow",
      "ipRules": [],
      "virtualNetworkRules": [],
      "resourceAccessRules": []
    },
    "primaryEndpoints": {
      "web": "https://sto8596.web.core.windows.net/",
      "dfs": "https://sto8596.dfs.core.windows.net/",
      "blob": "https://sto8596.blob.core.windows.net/",
      "file": "https://sto8596.file.core.windows.net/",
      "queue": "https://sto8596.queue.core.windows.net/",
      "table": "https://sto8596.table.core.windows.net/",
      "microsoftEndpoints": {
        "web": "https://sto8596-microsoftrouting.web.core.windows.net/",
        "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/",
        "file": "https://sto8596-microsoftrouting.file.core.windows.net/",
        "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/",
        "table": "https://sto8596-microsoftrouting.table.core.windows.net/"
      },
      "internetEndpoints": {
        "web": "https://sto8596-internetrouting.web.core.windows.net/",
        "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-internetrouting.blob.core.windows.net/",
        "file": "https://sto8596-internetrouting.file.core.windows.net/"
      }
    },
    "primaryLocation": "eastus2(stage)",
    "provisioningState": "Succeeded",
    "routingPreference": {
      "routingChoice": "MicrosoftRouting",
      "publishMicrosoftEndpoints": true,
      "publishInternetEndpoints": true
    },
    "encryption": {
      "services": {
        "file": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        },
        "blob": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        }
      },
      "keySource": "Microsoft.Keyvault",
      "keyvaultproperties": {
        "keyvaulturi": "https://myvault8569.vault.azure.net",
        "keyname": "wrappingKey",
        "keyversion": "",
        "currentVersionedKeyIdentifier": "https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad",
        "lastKeyRotationTimestamp": "2019-12-13T20:36:23.7023290Z",
        "currentVersionedKeyExpirationTimestamp": "2019-12-13T20:36:23.7023290Z"
      }
    },
    "secondaryLocation": "northcentralus(stage)",
    "statusOfPrimary": "available",
    "statusOfSecondary": "available",
    "supportsHttpsTrafficOnly": false
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2023-01-01&$expand=geoReplicationStats

Java

import com.azure.resourcemanager.storage.models.StorageAccountExpand;

/** Samples for StorageAccounts GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/
     * StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse.json
     */
    /**
     * Sample code: StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountGetPropertiesGeoReplicationStatscanFailoverFalse(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().getByResourceGroupWithResponse("res9407",
            "sto8596", StorageAccountExpand.GEO_REPLICATION_STATS, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_get_properties_geo_replication_statscan_failover_false.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.get_properties(
        resource_group_name="res9407",
        account_name="sto8596",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse.json
func ExampleAccountsClient_GetProperties_storageAccountGetPropertiesGeoReplicationStatscanFailoverFalse() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().GetProperties(ctx, "res9407", "sto8596", &armstorage.AccountsClientGetPropertiesOptions{Expand: to.Ptr(armstorage.StorageAccountExpandGeoReplicationStats)})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armstorage.Account{
	// 	Name: to.Ptr("sto8596"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596"),
	// 	Location: to.Ptr("eastus2(stage)"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Kind: to.Ptr(armstorage.KindStorage),
	// 	Properties: &armstorage.AccountProperties{
	// 		AccountMigrationInProgress: to.Ptr(false),
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T02:42:41.763Z"); return t}()),
	// 		Encryption: &armstorage.Encryption{
	// 			KeySource: to.Ptr(armstorage.KeySourceMicrosoftStorage),
	// 			Services: &armstorage.EncryptionServices{
	// 				Blob: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 				File: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 			},
	// 		},
	// 		GeoReplicationStats: &armstorage.GeoReplicationStats{
	// 			CanFailover: to.Ptr(false),
	// 			CanPlannedFailover: to.Ptr(false),
	// 			LastSyncTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-30T00:25:34.000Z"); return t}()),
	// 			PostFailoverRedundancy: to.Ptr(armstorage.PostFailoverRedundancyStandardLRS),
	// 			PostPlannedFailoverRedundancy: to.Ptr(armstorage.PostPlannedFailoverRedundancyStandardGRS),
	// 			Status: to.Ptr(armstorage.GeoReplicationStatusLive),
	// 		},
	// 		IsHnsEnabled: to.Ptr(true),
	// 		IsSKUConversionBlocked: to.Ptr(false),
	// 		KeyCreationTime: &armstorage.KeyCreationTime{
	// 			Key1: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-18T04:42:22.432Z"); return t}()),
	// 			Key2: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-18T04:42:22.432Z"); return t}()),
	// 		},
	// 		NetworkRuleSet: &armstorage.NetworkRuleSet{
	// 			Bypass: to.Ptr(armstorage.BypassAzureServices),
	// 			DefaultAction: to.Ptr(armstorage.DefaultActionAllow),
	// 			IPRules: []*armstorage.IPRule{
	// 			},
	// 			ResourceAccessRules: []*armstorage.ResourceAccessRule{
	// 				{
	// 					ResourceID: to.Ptr("/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"),
	// 					TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 			}},
	// 			VirtualNetworkRules: []*armstorage.VirtualNetworkRule{
	// 			},
	// 		},
	// 		PrimaryEndpoints: &armstorage.Endpoints{
	// 			Blob: to.Ptr("https://sto8596.blob.core.windows.net/"),
	// 			Dfs: to.Ptr("https://sto8596.dfs.core.windows.net/"),
	// 			File: to.Ptr("https://sto8596.file.core.windows.net/"),
	// 			InternetEndpoints: &armstorage.AccountInternetEndpoints{
	// 				Blob: to.Ptr("https://sto8596-internetrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-internetrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-internetrouting.file.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-internetrouting.web.core.windows.net/"),
	// 			},
	// 			MicrosoftEndpoints: &armstorage.AccountMicrosoftEndpoints{
	// 				Blob: to.Ptr("https://sto8596-microsoftrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-microsoftrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-microsoftrouting.file.core.windows.net/"),
	// 				Queue: to.Ptr("https://sto8596-microsoftrouting.queue.core.windows.net/"),
	// 				Table: to.Ptr("https://sto8596-microsoftrouting.table.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-microsoftrouting.web.core.windows.net/"),
	// 			},
	// 			Queue: to.Ptr("https://sto8596.queue.core.windows.net/"),
	// 			Table: to.Ptr("https://sto8596.table.core.windows.net/"),
	// 			Web: to.Ptr("https://sto8596.web.core.windows.net/"),
	// 		},
	// 		PrimaryLocation: to.Ptr("eastus2(stage)"),
	// 		ProvisioningState: to.Ptr(armstorage.ProvisioningStateSucceeded),
	// 		RoutingPreference: &armstorage.RoutingPreference{
	// 			PublishInternetEndpoints: to.Ptr(true),
	// 			PublishMicrosoftEndpoints: to.Ptr(true),
	// 			RoutingChoice: to.Ptr(armstorage.RoutingChoiceMicrosoftRouting),
	// 		},
	// 		SecondaryLocation: to.Ptr("northcentralus(stage)"),
	// 		StatusOfPrimary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		StatusOfSecondary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		EnableHTTPSTrafficOnly: to.Ptr(false),
	// 	},
	// 	SKU: &armstorage.SKU{
	// 		Name: to.Ptr(armstorage.SKUNameStandardGRS),
	// 		Tier: to.Ptr(armstorage.SKUTierStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesGeoReplicationStatscanFailoverFalse.json
 */
async function storageAccountGetPropertiesGeoReplicationStatscanFailoverFalse() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9407";
  const accountName = "sto8596";
  const expand = "geoReplicationStats";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.getProperties(
    resourceGroupName,
    accountName,
    options
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "kind": "Storage",
  "location": "eastus2(stage)",
  "name": "sto8596",
  "properties": {
    "keyCreationTime": {
      "key1": "2021-03-18T04:42:22.4322836Z",
      "key2": "2021-03-18T04:42:22.4322836Z"
    },
    "geoReplicationStats": {
      "status": "Live",
      "lastSyncTime": "2018-10-30T00:25:34Z",
      "canFailover": false,
      "canPlannedFailover": false,
      "postFailoverRedundancy": "Standard_LRS",
      "postPlannedFailoverRedundancy": "Standard_GRS"
    },
    "isHnsEnabled": true,
    "creationTime": "2017-06-01T02:42:41.7633306Z",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Allow",
      "ipRules": [],
      "virtualNetworkRules": [],
      "resourceAccessRules": [
        {
          "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
          "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"
        }
      ]
    },
    "primaryEndpoints": {
      "web": "https://sto8596.web.core.windows.net/",
      "dfs": "https://sto8596.dfs.core.windows.net/",
      "blob": "https://sto8596.blob.core.windows.net/",
      "file": "https://sto8596.file.core.windows.net/",
      "queue": "https://sto8596.queue.core.windows.net/",
      "table": "https://sto8596.table.core.windows.net/",
      "microsoftEndpoints": {
        "web": "https://sto8596-microsoftrouting.web.core.windows.net/",
        "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/",
        "file": "https://sto8596-microsoftrouting.file.core.windows.net/",
        "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/",
        "table": "https://sto8596-microsoftrouting.table.core.windows.net/"
      },
      "internetEndpoints": {
        "web": "https://sto8596-internetrouting.web.core.windows.net/",
        "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-internetrouting.blob.core.windows.net/",
        "file": "https://sto8596-internetrouting.file.core.windows.net/"
      }
    },
    "primaryLocation": "eastus2(stage)",
    "provisioningState": "Succeeded",
    "routingPreference": {
      "routingChoice": "MicrosoftRouting",
      "publishMicrosoftEndpoints": true,
      "publishInternetEndpoints": true
    },
    "encryption": {
      "services": {
        "file": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        },
        "blob": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        }
      },
      "keySource": "Microsoft.Storage"
    },
    "secondaryLocation": "northcentralus(stage)",
    "statusOfPrimary": "available",
    "statusOfSecondary": "available",
    "supportsHttpsTrafficOnly": false,
    "isSkuConversionBlocked": false,
    "accountMigrationInProgress": false
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue

Sample Request

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2023-01-01&$expand=geoReplicationStats

Java

import com.azure.resourcemanager.storage.models.StorageAccountExpand;

/** Samples for StorageAccounts GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/
     * StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue.json
     */
    /**
     * Sample code: StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountGetPropertiesGeoReplicationStatscanFailoverTrue(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().getByResourceGroupWithResponse("res9407",
            "sto8596", StorageAccountExpand.GEO_REPLICATION_STATS, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python storage_account_get_properties_geo_replication_statscan_failover_true.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.get_properties(
        resource_group_name="res9407",
        account_name="sto8596",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue.json
func ExampleAccountsClient_GetProperties_storageAccountGetPropertiesGeoReplicationStatscanFailoverTrue() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAccountsClient().GetProperties(ctx, "res9407", "sto8596", &armstorage.AccountsClientGetPropertiesOptions{Expand: to.Ptr(armstorage.StorageAccountExpandGeoReplicationStats)})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armstorage.Account{
	// 	Name: to.Ptr("sto8596"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596"),
	// 	Location: to.Ptr("eastus2(stage)"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key2": to.Ptr("value2"),
	// 	},
	// 	Kind: to.Ptr(armstorage.KindStorage),
	// 	Properties: &armstorage.AccountProperties{
	// 		AccountMigrationInProgress: to.Ptr(false),
	// 		CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-01T02:42:41.763Z"); return t}()),
	// 		Encryption: &armstorage.Encryption{
	// 			KeySource: to.Ptr(armstorage.KeySourceMicrosoftStorage),
	// 			Services: &armstorage.EncryptionServices{
	// 				Blob: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 				File: &armstorage.EncryptionService{
	// 					Enabled: to.Ptr(true),
	// 					KeyType: to.Ptr(armstorage.KeyTypeAccount),
	// 					LastEnabledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-12-11T20:49:31.703Z"); return t}()),
	// 				},
	// 			},
	// 		},
	// 		GeoReplicationStats: &armstorage.GeoReplicationStats{
	// 			CanFailover: to.Ptr(true),
	// 			CanPlannedFailover: to.Ptr(true),
	// 			LastSyncTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-30T00:25:34.000Z"); return t}()),
	// 			PostFailoverRedundancy: to.Ptr(armstorage.PostFailoverRedundancyStandardLRS),
	// 			PostPlannedFailoverRedundancy: to.Ptr(armstorage.PostPlannedFailoverRedundancyStandardGRS),
	// 			Status: to.Ptr(armstorage.GeoReplicationStatusLive),
	// 		},
	// 		IsHnsEnabled: to.Ptr(true),
	// 		IsSKUConversionBlocked: to.Ptr(false),
	// 		KeyCreationTime: &armstorage.KeyCreationTime{
	// 			Key1: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-18T04:42:22.432Z"); return t}()),
	// 			Key2: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-03-18T04:42:22.432Z"); return t}()),
	// 		},
	// 		NetworkRuleSet: &armstorage.NetworkRuleSet{
	// 			Bypass: to.Ptr(armstorage.BypassAzureServices),
	// 			DefaultAction: to.Ptr(armstorage.DefaultActionAllow),
	// 			IPRules: []*armstorage.IPRule{
	// 			},
	// 			ResourceAccessRules: []*armstorage.ResourceAccessRule{
	// 				{
	// 					ResourceID: to.Ptr("/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"),
	// 					TenantID: to.Ptr("72f988bf-86f1-41af-91ab-2d7cd011db47"),
	// 			}},
	// 			VirtualNetworkRules: []*armstorage.VirtualNetworkRule{
	// 			},
	// 		},
	// 		PrimaryEndpoints: &armstorage.Endpoints{
	// 			Blob: to.Ptr("https://sto8596.blob.core.windows.net/"),
	// 			Dfs: to.Ptr("https://sto8596.dfs.core.windows.net/"),
	// 			File: to.Ptr("https://sto8596.file.core.windows.net/"),
	// 			InternetEndpoints: &armstorage.AccountInternetEndpoints{
	// 				Blob: to.Ptr("https://sto8596-internetrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-internetrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-internetrouting.file.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-internetrouting.web.core.windows.net/"),
	// 			},
	// 			MicrosoftEndpoints: &armstorage.AccountMicrosoftEndpoints{
	// 				Blob: to.Ptr("https://sto8596-microsoftrouting.blob.core.windows.net/"),
	// 				Dfs: to.Ptr("https://sto8596-microsoftrouting.dfs.core.windows.net/"),
	// 				File: to.Ptr("https://sto8596-microsoftrouting.file.core.windows.net/"),
	// 				Queue: to.Ptr("https://sto8596-microsoftrouting.queue.core.windows.net/"),
	// 				Table: to.Ptr("https://sto8596-microsoftrouting.table.core.windows.net/"),
	// 				Web: to.Ptr("https://sto8596-microsoftrouting.web.core.windows.net/"),
	// 			},
	// 			Queue: to.Ptr("https://sto8596.queue.core.windows.net/"),
	// 			Table: to.Ptr("https://sto8596.table.core.windows.net/"),
	// 			Web: to.Ptr("https://sto8596.web.core.windows.net/"),
	// 		},
	// 		PrimaryLocation: to.Ptr("eastus2(stage)"),
	// 		ProvisioningState: to.Ptr(armstorage.ProvisioningStateSucceeded),
	// 		RoutingPreference: &armstorage.RoutingPreference{
	// 			PublishInternetEndpoints: to.Ptr(true),
	// 			PublishMicrosoftEndpoints: to.Ptr(true),
	// 			RoutingChoice: to.Ptr(armstorage.RoutingChoiceMicrosoftRouting),
	// 		},
	// 		SecondaryLocation: to.Ptr("northcentralus(stage)"),
	// 		StatusOfPrimary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		StatusOfSecondary: to.Ptr(armstorage.AccountStatusAvailable),
	// 		EnableHTTPSTrafficOnly: to.Ptr(false),
	// 	},
	// 	SKU: &armstorage.SKU{
	// 		Name: to.Ptr(armstorage.SKUNameStandardGRS),
	// 		Tier: to.Ptr(armstorage.SKUTierStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountGetPropertiesGeoReplicationStatscanFailoverTrue.json
 */
async function storageAccountGetPropertiesGeoReplicationStatscanFailoverTrue() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9407";
  const accountName = "sto8596";
  const expand = "geoReplicationStats";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.getProperties(
    resourceGroupName,
    accountName,
    options
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "kind": "Storage",
  "location": "eastus2(stage)",
  "name": "sto8596",
  "properties": {
    "keyCreationTime": {
      "key1": "2021-03-18T04:42:22.4322836Z",
      "key2": "2021-03-18T04:42:22.4322836Z"
    },
    "geoReplicationStats": {
      "status": "Live",
      "lastSyncTime": "2018-10-30T00:25:34Z",
      "canFailover": true,
      "canPlannedFailover": true,
      "postFailoverRedundancy": "Standard_LRS",
      "postPlannedFailoverRedundancy": "Standard_GRS"
    },
    "isHnsEnabled": true,
    "creationTime": "2017-06-01T02:42:41.7633306Z",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Allow",
      "ipRules": [],
      "virtualNetworkRules": [],
      "resourceAccessRules": [
        {
          "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
          "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"
        }
      ]
    },
    "primaryEndpoints": {
      "web": "https://sto8596.web.core.windows.net/",
      "dfs": "https://sto8596.dfs.core.windows.net/",
      "blob": "https://sto8596.blob.core.windows.net/",
      "file": "https://sto8596.file.core.windows.net/",
      "queue": "https://sto8596.queue.core.windows.net/",
      "table": "https://sto8596.table.core.windows.net/",
      "microsoftEndpoints": {
        "web": "https://sto8596-microsoftrouting.web.core.windows.net/",
        "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/",
        "file": "https://sto8596-microsoftrouting.file.core.windows.net/",
        "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/",
        "table": "https://sto8596-microsoftrouting.table.core.windows.net/"
      },
      "internetEndpoints": {
        "web": "https://sto8596-internetrouting.web.core.windows.net/",
        "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-internetrouting.blob.core.windows.net/",
        "file": "https://sto8596-internetrouting.file.core.windows.net/"
      }
    },
    "primaryLocation": "eastus2(stage)",
    "provisioningState": "Succeeded",
    "routingPreference": {
      "routingChoice": "MicrosoftRouting",
      "publishMicrosoftEndpoints": true,
      "publishInternetEndpoints": true
    },
    "encryption": {
      "services": {
        "file": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        },
        "blob": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        }
      },
      "keySource": "Microsoft.Storage"
    },
    "secondaryLocation": "northcentralus(stage)",
    "statusOfPrimary": "available",
    "statusOfSecondary": "available",
    "supportsHttpsTrafficOnly": false,
    "isSkuConversionBlocked": false,
    "accountMigrationInProgress": false
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

定義

名稱	Description
AccessTier	類型 = BlobStorage 的記憶體帳戶需要 。 存取層用於計費。 「進階」存取層是進階區塊 Blob 記憶體帳戶類型的預設值，無法變更進階區塊 Blob 記憶體帳戶類型。
AccountImmutabilityPolicyProperties	這會定義帳戶層級不變性原則屬性。
AccountImmutabilityPolicyState	ImmutabilityPolicy 狀態會定義原則的模式。 停用狀態會停用原則、解除鎖定狀態允許增加和減少不變性保留時間，也允許切換allowProtectedAppendWrites屬性、鎖定狀態只允許增加不變性保留時間。 原則只能以 [已停用] 或 [已解除鎖定] 狀態建立，而且可以在兩種狀態之間切換。 只有處於未鎖定狀態的原則可以轉換為無法還原的鎖定狀態。
AccountStatus	取得狀態，指出記憶體帳戶的主要位置是否可用或無法使用。
AccountType	指定 Azure 記憶體的 Active Directory 帳戶類型。
Action	虛擬網路規則的動作。
ActiveDirectoryProperties	Active Directory (AD) 的設定屬性。
AllowedCopyScope	限制在 AAD 租使用者內的記憶體帳戶或具有相同 VNet 的私人連結來回復制。
AzureFilesIdentityBasedAuthentication	Azure 檔案儲存體 身分識別型驗證的設定。
BlobRestoreParameters	Blob 還原參數
BlobRestoreProgressStatus	Blob 還原進度的狀態。 可能的值為：- InProgress：指出 Blob 還原正在進行中。 - 完成：表示 Blob 還原已順利完成。 - 失敗：表示 Blob 還原失敗。
BlobRestoreRange	Blob 範圍
BlobRestoreStatus	Blob 還原狀態。
Bypass	指定是否略過記錄/計量/AzureServices 的流量。 可能的值為記錄的任何組合|計量|AzureServices (例如，「記錄、計量」) 或 None，以略過這些流量。
CustomDomain	指派給此記憶體帳戶的自定義網域。 這可以透過Update來設定。
DefaultAction	指定當沒有其他規則相符時，允許或拒絕的默認動作。
DefaultSharePermission	如果未指派 RBAC 角色，則為使用 Kerberos 驗證的用戶預設共享許可權。
DirectoryServiceOptions	表示所使用的目錄服務。 請注意，未來可能會擴充此列舉。
DnsEndpointType	可讓您指定端點的類型。 將此設定為 AzureDNSZone，以在單一訂用帳戶中建立大量帳戶，以在 Azure DNS 區域中建立帳戶，而端點 URL 將具有英數位元 DNS 區域標識符。
Encryption	記憶體帳戶上的加密設定。
EncryptionIdentity	記憶體帳戶的加密身分識別。
EncryptionService	允許使用伺服器端加密的服務。
EncryptionServices	支援加密的服務清單。
Endpoints	用來擷取公用 Blob、佇列、數據表、Web 或 dfs 物件的 URI。
ExpirationAction	SAS 到期動作。 只能是記錄檔。
ExtendedLocation	擴充位置的複雜類型。
ExtendedLocationTypes	擴充位置的類型。
GeoReplicationStats	與記憶體帳戶 Blob、數據表、佇列和檔案服務複寫相關的統計數據。 只有在啟用記憶體帳戶的異地備援複寫時，才能使用。
GeoReplicationStatus	次要位置的狀態。 可能的值為：- Live：表示次要位置為作用中且可運作。 - 啟動程式：指出從主要位置到次要位置的初始同步處理正在進行中。這通常發生在第一次啟用複寫時。 - 無法使用：表示次要位置暫時無法使用。
Identity	資源的身分識別。
IdentityType	識別類型。
ImmutableStorageAccount	這個屬性會啟用和定義帳戶層級不變性。 啟用此功能會自動啟用 Blob 版本控制。
IPRule	具有 CIDR 格式之特定 IP 或 IP 範圍的 IP 規則。
KeyCreationTime	儲存體帳戶金鑰建立時間。
KeyPolicy	指派給記憶體帳戶的 KeyPolicy。
KeySource	加密金鑰Source (提供者) 。 可能的值 (不區分大小寫) ：Microsoft.Storage、Microsoft.Keyvault
KeyType	要用於加密服務的加密金鑰類型。 「帳戶」金鑰類型表示將使用帳戶範圍的加密金鑰。 'Service' 金鑰類型表示使用預設服務金鑰。
KeyVaultProperties	金鑰保存庫的屬性。
Kind	指出記憶體帳戶的類型。
LargeFileSharesState	如果設定為 Enabled，則允許大型檔案共用。 一旦啟用，就無法停用它。
MinimumTlsVersion	將要求上允許的最低 TLS 版本設定為記憶體。 此屬性的預設解譯為 TLS 1.0。
NetworkRuleSet	網路規則集
postFailoverRedundancy	執行帳戶故障轉移之後，帳戶的備援類型。
postPlannedFailoverRedundancy	執行計劃性帳戶故障轉移之後，帳戶的備援類型。
PrivateEndpoint	私人端點資源。
PrivateEndpointConnection	私人端點聯機資源。
PrivateEndpointConnectionProvisioningState	目前的布建狀態。
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。
PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
ProvisioningState	取得呼叫作業時記憶體帳戶的狀態。
PublicNetworkAccess	允許或不允許對記憶體帳戶的公用網路存取。 值是選擇性的，但如果傳入，則必須是 『Enabled』 或 'Disabled'。
ResourceAccessRule	資源存取規則。
RoutingChoice	路由選擇會定義使用者選擇的網路路由類型。
RoutingPreference	路由喜好設定會定義用來傳遞用戶數據的 microsoft 或因特網路由的網路類型，默認選項是 microsoft 路由
SasPolicy	指派給記憶體帳戶的 SasPolicy。
Sku	記憶體帳戶的 SKU。
SkuConversionStatus	此屬性表示目前的 SKU 轉換狀態。
SkuName	SKU 名稱。 建立帳戶時需要;選擇性更新。 請注意，在舊版中，SKU 名稱稱為 accountType。
SkuTier	SKU 層。 這是以 SKU 名稱為基礎。
State	取得虛擬網路規則的狀態。
StorageAccount	儲存體帳戶。
StorageAccountExpand	可用來展開帳戶屬性內的屬性。 根據預設，擷取屬性時不會包含數據。 目前我們只支援 geoReplicationStats 和 blobRestoreStatus。
StorageAccountInternetEndpoints	用來透過因特網路由端點擷取公用 Blob、檔案、Web 或 dfs 物件的 URI。
StorageAccountMicrosoftEndpoints	用來透過 Microsoft 路由端點擷取公用 Blob、佇列、數據表、Web 或 dfs 物件的 URI。
StorageAccountSkuConversionStatus	這會定義異步 SKU 轉換的 SKU 轉換狀態物件。
UserAssignedIdentity	資源的 UserAssignedIdentity。
VirtualNetworkRule	虛擬網路 規則。

AccessTier

類型 = BlobStorage 的記憶體帳戶需要 。 存取層用於計費。 「進階」存取層是進階區塊 Blob 記憶體帳戶類型的預設值，無法變更進階區塊 Blob 記憶體帳戶類型。

名稱	類型	Description
Cool	string
Hot	string
Premium	string

AccountImmutabilityPolicyProperties

這會定義帳戶層級不變性原則屬性。

名稱	類型	Description
allowProtectedAppendWrites	boolean	此屬性只能針對停用和解除鎖定的時間型保留原則進行變更。 啟用時，新的區塊可以寫入附加 Blob，同時維持不變性保護和合規性。 只能新增新的區塊，而且無法修改或刪除任何現有的區塊。
immutabilityPeriodSinceCreationInDays	integer	自原則建立后，容器中 Blob 的不變性期間，以天為單位。
state	AccountImmutabilityPolicyState	ImmutabilityPolicy 狀態會定義原則的模式。 停用狀態會停用原則、解除鎖定狀態允許增加和減少不變性保留時間，也允許切換allowProtectedAppendWrites屬性、鎖定狀態只允許增加不變性保留時間。 原則只能以 [已停用] 或 [已解除鎖定] 狀態建立，而且可以在兩種狀態之間切換。 只有處於未鎖定狀態的原則可以轉換為無法還原的鎖定狀態。

AccountImmutabilityPolicyState

ImmutabilityPolicy 狀態會定義原則的模式。 停用狀態會停用原則、解除鎖定狀態允許增加和減少不變性保留時間，也允許切換allowProtectedAppendWrites屬性、鎖定狀態只允許增加不變性保留時間。 原則只能以 [已停用] 或 [已解除鎖定] 狀態建立，而且可以在兩種狀態之間切換。 只有處於未鎖定狀態的原則可以轉換為無法還原的鎖定狀態。

名稱	類型	Description
Disabled	string
Locked	string
Unlocked	string

AccountStatus

取得狀態，指出記憶體帳戶的主要位置是否可用或無法使用。

名稱	類型	Description
available	string
unavailable	string

AccountType

指定 Azure 記憶體的 Active Directory 帳戶類型。

名稱	類型	Description
Computer	string
User	string

Action

虛擬網路規則的動作。

名稱	類型	Description
Allow	string

ActiveDirectoryProperties

Active Directory (AD) 的設定屬性。

名稱	類型	Description
accountType	AccountType	指定 Azure 記憶體的 Active Directory 帳戶類型。
azureStorageSid	string	指定 Azure 記憶體的安全性識別碼 (SID) 。
domainGuid	string	指定網域 GUID。
domainName	string	指定AD DNS 伺服器授權的主要網域。
domainSid	string	指定 SID) (安全性識別碼。
forestName	string	指定要取得的 Active Directory 樹系。
netBiosDomainName	string	指定 NetBIOS 功能變數名稱。
samAccountName	string	指定 Azure 記憶體的 Active Directory SAMAccountName。

AllowedCopyScope

限制在 AAD 租使用者內的記憶體帳戶或具有相同 VNet 的私人連結來回復制。

名稱	類型	Description
AAD	string
PrivateLink	string

AzureFilesIdentityBasedAuthentication

Azure 檔案儲存體 身分識別型驗證的設定。

名稱	類型	Description
activeDirectoryProperties	ActiveDirectoryProperties	如果 directoryServiceOptions 是 AD，則為必要專案，如果是 AADKERB，則為選擇性。
defaultSharePermission	DefaultSharePermission	如果未指派 RBAC 角色，則為使用 Kerberos 驗證的用戶預設共享許可權。
directoryServiceOptions	DirectoryServiceOptions	指出使用的目錄服務。 請注意，未來可能會擴充此列舉。

BlobRestoreParameters

Blob 還原參數

名稱	類型	Description
blobRanges	BlobRestoreRange[]	要還原的 Blob 範圍。
timeToRestore	string	將 Blob 還原至指定的時間。

BlobRestoreProgressStatus

Blob 還原進度的狀態。 可能的值為：- InProgress：指出 Blob 還原正在進行中。 - 完成：表示 Blob 還原已順利完成。 - 失敗：表示 Blob 還原失敗。

名稱	類型	Description
Complete	string
Failed	string
InProgress	string

BlobRestoreRange

Blob 範圍

名稱	類型	Description
endRange	string	Blob 結束範圍。 這是獨佔的。 空白表示帳戶結束。
startRange	string	Blob 開始範圍。 這是包容性的。 空白表示帳戶啟動。

BlobRestoreStatus

Blob 還原狀態。

名稱	類型	Description
failureReason	string	Blob 還原失敗時的失敗原因。
parameters	BlobRestoreParameters	Blob 還原要求參數。
restoreId	string	追蹤 Blob 還原要求的標識碼。
status	BlobRestoreProgressStatus	Blob 還原進度的狀態。 可能的值為： - InProgress：指出 Blob 還原正在進行中。 - 完成：指出 Blob 還原已順利完成。 - 失敗：指出 Blob 還原失敗。

Bypass

指定是否略過記錄/計量/AzureServices 的流量。 可能的值為記錄的任何組合|計量|AzureServices (例如，「記錄、計量」) 或 None，以略過這些流量。

名稱	類型	Description
AzureServices	string
Logging	string
Metrics	string
None	string

CustomDomain

指派給此記憶體帳戶的自定義網域。 這可以透過Update來設定。

名稱	類型	Description
name	string	取得或設定指派給記憶體帳戶的自定義功能變數名稱。 名稱是 CNAME 來源。
useSubDomainName	boolean	指出是否啟用 CName 驗證。 預設值為 False。 這應該只在更新時設定。

DefaultAction

指定當沒有其他規則相符時，允許或拒絕的默認動作。

名稱	類型	Description
Allow	string
Deny	string

DefaultSharePermission

如果未指派 RBAC 角色，則為使用 Kerberos 驗證的用戶預設共享許可權。

名稱	類型	Description
None	string
StorageFileDataSmbShareContributor	string
StorageFileDataSmbShareElevatedContributor	string
StorageFileDataSmbShareReader	string

DirectoryServiceOptions

表示所使用的目錄服務。 請注意，未來可能會擴充此列舉。

名稱	類型	Description
AADDS	string
AADKERB	string
AD	string
None	string

DnsEndpointType

可讓您指定端點的類型。 將此設定為 AzureDNSZone，以在單一訂用帳戶中建立大量帳戶，以在 Azure DNS 區域中建立帳戶，而端點 URL 將具有英數位元 DNS 區域標識符。

名稱	類型	Description
AzureDnsZone	string
Standard	string

Encryption

記憶體帳戶上的加密設定。

名稱	類型	預設值	Description
identity	EncryptionIdentity		要與待用服務端加密搭配使用的身分識別。
keySource	KeySource	Microsoft.Storage	加密金鑰Source (提供者) 。 可能的值 (不區分大小寫) ：Microsoft.Storage、Microsoft.Keyvault
keyvaultproperties	KeyVaultProperties		金鑰保存庫提供的屬性。
requireInfrastructureEncryption	boolean		布爾值，指出服務是否使用平臺管理密鑰來套用次要層加密，以供待用數據使用。
services	EncryptionServices		支援加密的服務清單。

EncryptionIdentity

記憶體帳戶的加密身分識別。

名稱	類型	Description
federatedIdentityClientId	string	要與記憶體帳戶上跨租用戶客戶管理密鑰伺服器端加密的使用者指派身分識別搭配使用之多租使用者應用程式的 ClientId。
userAssignedIdentity	string	要與記憶體帳戶上的伺服器端加密相關聯的 UserAssigned 身分識別資源識別碼。

EncryptionService

允許使用伺服器端加密的服務。

名稱	類型	Description
enabled	boolean	布爾值，指出服務是否在儲存數據時加密數據。 目前預設會啟用待用加密，因此無法停用。
keyType	KeyType	要用於加密服務的加密金鑰類型。 「帳戶」金鑰類型表示將使用帳戶範圍的加密金鑰。 'Service' 金鑰類型表示使用預設服務金鑰。
lastEnabledTime	string	取得使用者上次啟用加密時的日期/時間粗略估計。 目前預設會加密待用數據，因此無法停用。

EncryptionServices

支援加密的服務清單。

名稱	類型	Description
blob	EncryptionService	Blob 記憶體服務的加密功能。
file	EncryptionService	檔案記憶體服務的加密功能。
queue	EncryptionService	佇列記憶體服務的加密功能。
table	EncryptionService	數據表記憶體服務的加密功能。

Endpoints

用來擷取公用 Blob、佇列、數據表、Web 或 dfs 物件的 URI。

名稱	類型	Description
blob	string	取得 Blob 端點。
dfs	string	取得 dfs 端點。
file	string	取得檔案端點。
internetEndpoints	StorageAccountInternetEndpoints	取得因特網路由記憶體端點
microsoftEndpoints	StorageAccountMicrosoftEndpoints	取得 Microsoft 路由記憶體端點。
queue	string	取得佇列端點。
table	string	取得數據表端點。
web	string	取得 Web 端點。

ExpirationAction

SAS 到期動作。 只能是記錄檔。

名稱	類型	Description
Log	string

ExtendedLocation

擴充位置的複雜類型。

名稱	類型	Description
name	string	擴充位置的名稱。
type	ExtendedLocationTypes	擴充位置的類型。

ExtendedLocationTypes

擴充位置的類型。

名稱	類型	Description
EdgeZone	string

GeoReplicationStats

與記憶體帳戶 Blob、數據表、佇列和檔案服務複寫相關的統計數據。 只有在啟用記憶體帳戶的異地備援複寫時，才能使用。

名稱	類型	Description
canFailover	boolean	布爾值旗標，指出帳戶是否支持帳戶故障轉移。
canPlannedFailover	boolean	布爾值旗標，指出帳戶是否支持計劃性帳戶故障轉移。
lastSyncTime	string	此 UTC 日期/時間值之前的所有主要寫入都保證可供讀取作業使用。 這個點後面的主要寫入不一定可供讀取作業使用。 如果 LastSyncTime 的值無法使用，則元素可能是預設值，如果次要複本離機，或我們正在啟動程式，就會發生這種情況。
postFailoverRedundancy	postFailoverRedundancy	執行帳戶故障轉移之後，帳戶的備援類型。
postPlannedFailoverRedundancy	postPlannedFailoverRedundancy	執行計劃性帳戶故障轉移之後，帳戶的備援類型。
status	GeoReplicationStatus	次要位置的狀態。 可能的值為： - Live：指出次要位置為作用中且可運作。 - 啟動程式：指出主要位置到次要位置的初始同步處理正在進行中。這通常發生在第一次啟用複寫時。 - 無法使用：指出次要位置暫時無法使用。

GeoReplicationStatus

次要位置的狀態。 可能的值為：- Live：表示次要位置為作用中且可運作。 - 啟動程式：指出從主要位置到次要位置的初始同步處理正在進行中。這通常發生在第一次啟用複寫時。 - 無法使用：表示次要位置暫時無法使用。

名稱	類型	Description
Bootstrap	string
Live	string
Unavailable	string

Identity

資源的身分識別。

名稱	類型	Description
principalId	string	資源識別的主要標識碼。
tenantId	string	資源的租用戶標識碼。
type	IdentityType	識別類型。
userAssignedIdentities	<string,  UserAssignedIdentity>	取得或設定索引鍵值組清單，描述將與此儲存體帳戶搭配使用的一組使用者指派身分識別。 金鑰是身分識別的 ARM 資源識別碼。 這裡只允許 1 個使用者指派的身分識別。

IdentityType

識別類型。

名稱	類型	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

ImmutableStorageAccount

這個屬性會啟用和定義帳戶層級不變性。 啟用此功能會自動啟用 Blob 版本控制。

名稱	類型	Description
enabled	boolean	布爾值旗標，可啟用帳戶層級不變性。 這類帳戶下的所有容器預設都會啟用物件層級不變性。
immutabilityPolicy	AccountImmutabilityPolicyProperties	指定繼承並套用至物件層級未擁有明確不變性原則之對象的預設帳戶層級不變性原則。 物件層級不變性原則的優先順序高於容器層級不變性原則，其優先順序高於帳戶層級不變性原則。

IPRule

具有 CIDR 格式之特定 IP 或 IP 範圍的 IP 規則。

名稱	類型	預設值	Description
action	Action	Allow	IP ACL 規則的動作。
value	string		以 CIDR 格式指定 IP 或 IP 範圍。 只允許 IPV4 位址。

KeyCreationTime

儲存體帳戶金鑰建立時間。

名稱	類型	Description
key1	string
key2	string

KeyPolicy

指派給記憶體帳戶的 KeyPolicy。

名稱	類型	Description
keyExpirationPeriodInDays	integer	金鑰到期日，以天為單位。

KeySource

加密金鑰Source (提供者) 。 可能的值 (不區分大小寫) ：Microsoft.Storage、Microsoft.Keyvault

名稱	類型	Description
Microsoft.Keyvault	string
Microsoft.Storage	string

KeyType

要用於加密服務的加密金鑰類型。 「帳戶」金鑰類型表示將使用帳戶範圍的加密金鑰。 'Service' 金鑰類型表示使用預設服務金鑰。

名稱	類型	Description
Account	string
Service	string

KeyVaultProperties

金鑰保存庫的屬性。

名稱	類型	Description
currentVersionedKeyExpirationTimestamp	string	這是唯讀屬性，代表目前用於加密之客戶管理金鑰版本的到期時間。
currentVersionedKeyIdentifier	string	使用中目前版本 金鑰保存庫 金鑰的物件識別碼。
keyname	string	KeyVault 金鑰的名稱。
keyvaulturi	string	KeyVault 的 URI。
keyversion	string	KeyVault 金鑰的版本。
lastKeyRotationTimestamp	string	金鑰保存庫 金鑰上次輪替的時間戳。

Kind

指出記憶體帳戶的類型。

名稱	類型	Description
BlobStorage	string
BlockBlobStorage	string
FileStorage	string
Storage	string
StorageV2	string

LargeFileSharesState

如果設定為 Enabled，則允許大型檔案共用。 一旦啟用，就無法停用它。

名稱	類型	Description
Disabled	string
Enabled	string

MinimumTlsVersion

將要求上允許的最低 TLS 版本設定為記憶體。 此屬性的預設解譯為 TLS 1.0。

名稱	類型	Description
TLS1_0	string
TLS1_1	string
TLS1_2	string

NetworkRuleSet

網路規則集

名稱	類型	預設值	Description
bypass	Bypass	AzureServices	指定是否略過記錄/計量/AzureServices 的流量。 可能的值為記錄的任何組合|計量|AzureServices (例如，「記錄、計量」) 或 None，以略過這些流量。
defaultAction	DefaultAction	Allow	指定沒有其他規則相符時，允許或拒絕的默認動作。
ipRules	IPRule[]		設定IP ACL規則
resourceAccessRules	ResourceAccessRule[]		設定資源存取規則
virtualNetworkRules	VirtualNetworkRule[]		設定虛擬網路規則

postFailoverRedundancy

執行帳戶故障轉移之後，帳戶的備援類型。

名稱	類型	Description
Standard_LRS	string
Standard_ZRS	string

postPlannedFailoverRedundancy

執行計劃性帳戶故障轉移之後，帳戶的備援類型。

名稱	類型	Description
Standard_GRS	string
Standard_GZRS	string
Standard_RAGRS	string
Standard_RAGZRS	string

PrivateEndpoint

私人端點資源。

名稱	類型	Description
id	string	私人端點的ARM標識碼

PrivateEndpointConnection

私人端點聯機資源。

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.privateEndpoint	PrivateEndpoint	私人端點的資源。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	私人端點聯機資源的布建狀態。
type	string	資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

目前的布建狀態。

名稱	類型	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

名稱	類型	Description
Approved	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

服務取用者與提供者之間連線狀態的相關信息集合。

名稱	類型	Description
actionRequired	string	訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。
description	string	連接核准/拒絕的原因。
status	PrivateEndpointServiceConnectionStatus	指出服務擁有者是否已核准/拒絕/移除連線。

ProvisioningState

取得呼叫作業時記憶體帳戶的狀態。

名稱	類型	Description
Creating	string
ResolvingDNS	string
Succeeded	string

PublicNetworkAccess

允許或不允許對記憶體帳戶的公用網路存取。 值是選擇性的，但如果傳入，則必須是 『Enabled』 或 'Disabled'。

名稱	類型	Description
Disabled	string
Enabled	string

ResourceAccessRule

資源存取規則。

名稱	類型	Description
resourceId	string	資源標識碼
tenantId	string	租用戶識別碼

RoutingChoice

路由選擇會定義使用者選擇的網路路由類型。

名稱	類型	Description
InternetRouting	string
MicrosoftRouting	string

RoutingPreference

路由喜好設定會定義用來傳遞用戶數據的 microsoft 或因特網路由的網路類型，默認選項是 microsoft 路由

名稱	類型	Description
publishInternetEndpoints	boolean	布爾值旗標，指出是否要發佈因特網路由記憶體端點
publishMicrosoftEndpoints	boolean	布爾值旗標，指出是否要發佈 Microsoft 路由記憶體端點
routingChoice	RoutingChoice	路由選擇會定義使用者選擇的網路路由類型。

SasPolicy

指派給記憶體帳戶的 SasPolicy。

名稱	類型	預設值	Description
expirationAction	ExpirationAction	Log	SAS 到期動作。 只能是記錄檔。
sasExpirationPeriod	string		SAS 到期期間 DD.HH：MM：SS。

Sku

記憶體帳戶的 SKU。

名稱	類型	Description
name	SkuName	SKU 名稱。 建立帳戶時需要;選擇性更新。 請注意，在舊版中，SKU 名稱稱為 accountType。
tier	SkuTier	SKU 層。 這是以 SKU 名稱為基礎。

SkuConversionStatus

此屬性表示目前的 SKU 轉換狀態。

名稱	類型	Description
Failed	string
InProgress	string
Succeeded	string

SkuName

SKU 名稱。 建立帳戶時需要;選擇性更新。 請注意，在舊版中，SKU 名稱稱為 accountType。

名稱	類型	Description
Premium_LRS	string
Premium_ZRS	string
Standard_GRS	string
Standard_GZRS	string
Standard_LRS	string
Standard_RAGRS	string
Standard_RAGZRS	string
Standard_ZRS	string

SkuTier

SKU 層。 這是以 SKU 名稱為基礎。

名稱	類型	Description
Premium	string
Standard	string

State

取得虛擬網路規則的狀態。

名稱	類型	Description
Deprovisioning	string
Failed	string
NetworkSourceDeleted	string
Provisioning	string
Succeeded	string

StorageAccount

儲存體帳戶。

名稱	類型	Description
extendedLocation	ExtendedLocation	資源的 extendedLocation。
id	string	資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	資源的身分識別。
kind	Kind	取得 Kind。
location	string	資源所在的地理位置
name	string	資源的名稱
properties.accessTier	AccessTier	類型 = BlobStorage 的記憶體帳戶需要 。 存取層用於計費。 「進階」存取層是進階區塊 Blob 記憶體帳戶類型的預設值，無法變更進階區塊 Blob 記憶體帳戶類型。
properties.accountMigrationInProgress	boolean	如果客戶起始的帳戶移轉正在進行中，此值會是 true，否則此值會是 Null。
properties.allowBlobPublicAccess	boolean	允許或不允許公用存取記憶體帳戶中的所有 Blob 或容器。 此屬性的默認解譯為 false。
properties.allowCrossTenantReplication	boolean	允許或不允許跨 AAD 租使用者物件複寫。 只有在物件複製策略將涉及不同 AAD 租使用者中的記憶體帳戶時，才將此屬性設定為 true。 默認解譯是 false，新帳戶預設會遵循最佳安全性做法。
properties.allowSharedKeyAccess	boolean	指出記憶體帳戶是否允許透過共用密鑰向帳戶存取金鑰授權要求。 如果為 false，則所有要求，包括共用存取簽章，都必須獲得 Azure Active Directory (Azure AD) 的授權。 默認值為 null，相當於 true。
properties.allowedCopyScope	AllowedCopyScope	限制從 AAD 租使用者內的記憶體帳戶，或使用相同 VNet 的私人連結來回復制。
properties.azureFilesIdentityBasedAuthentication	AzureFilesIdentityBasedAuthentication	提供 Azure 檔案儲存體的身分識別型驗證設定。
properties.blobRestoreStatus	BlobRestoreStatus	Blob 還原狀態
properties.creationTime	string	取得以UTC為單位的記憶體帳戶建立日期和時間。
properties.customDomain	CustomDomain	取得使用者指派給此記憶體帳戶的自定義網域。
properties.defaultToOAuthAuthentication	boolean	布爾值旗標，指出預設驗證是否為 OAuth。 此屬性的默認解譯為 false。
properties.dnsEndpointType	DnsEndpointType	可讓您指定端點的類型。 將此設定為 AzureDNSZone 以在單一訂用帳戶中建立大量帳戶，這會在 Azure DNS 區域中建立帳戶，而端點 URL 將會有英數位元 DNS 區域標識符。
properties.encryption	Encryption	要用於記憶體帳戶伺服器端加密的加密設定。
properties.failoverInProgress	boolean	如果故障轉移正在進行中，此值會是 true，否則會是 Null。
properties.geoReplicationStats	GeoReplicationStats	異地復寫統計數據
properties.immutableStorageWithVersioning	ImmutableStorageAccount	屬性是不可變的，而且只能在帳戶建立期間設定為 true。 設定為 true 時，預設會啟用帳戶中所有容器的物件層級不變性。
properties.isHnsEnabled	boolean	如果 設定為 true，則啟用 Account HierarchicalNamespace。
properties.isLocalUserEnabled	boolean	如果設定為 true，則啟用本機使用者功能
properties.isNfsV3Enabled	boolean	如果設定為 true，則啟用 NFS 3.0 通訊協議支援。
properties.isSftpEnabled	boolean	如果設定為 true，則啟用安全檔案傳輸通訊協定
properties.isSkuConversionBlocked	boolean	當進行中的移轉時，此屬性會設定為 true 或 false。 預設值是空值。
properties.keyCreationTime	KeyCreationTime	儲存體帳戶金鑰建立時間。
properties.keyPolicy	KeyPolicy	指派給記憶體帳戶的 KeyPolicy。
properties.largeFileSharesState	LargeFileSharesState	如果設定為 [已啟用]，則允許大型檔案共用。 一旦啟用，就無法停用。
properties.lastGeoFailoverTime	string	取得故障轉移至次要位置之最近實例的時間戳。 只會保留最新的時間戳。 如果從未有故障轉移實例，則不會傳回這個專案。 只有在 accountType 是Standard_GRS或Standard_RAGRS時才可使用。
properties.minimumTlsVersion	MinimumTlsVersion	將要求上允許的最低 TLS 版本設定為記憶體。 此屬性的預設解譯為 TLS 1.0。
properties.networkAcls	NetworkRuleSet	網路規則集
properties.primaryEndpoints	Endpoints	取得用來執行擷取公用 Blob、佇列或數據表物件的 URL。 請注意，Standard_ZRS和Premium_LRS帳戶只會傳回 Blob 端點。
properties.primaryLocation	string	取得記憶體帳戶的主要數據中心位置。
properties.privateEndpointConnections	PrivateEndpointConnection[]	與指定記憶體帳戶相關聯的私人端點連線清單
properties.provisioningState	ProvisioningState	取得呼叫作業時記憶體帳戶的狀態。
properties.publicNetworkAccess	PublicNetworkAccess	允許或禁止公用網路存取記憶體帳戶。 值是選擇性的，但如果傳入，則必須是 『Enabled』 或 'Disabled'。
properties.routingPreference	RoutingPreference	維護使用者選擇進行數據傳輸的網路路由選擇相關信息
properties.sasPolicy	SasPolicy	指派給記憶體帳戶的 SasPolicy。
properties.secondaryEndpoints	Endpoints	取得用來從記憶體帳戶次要位置擷取公用 Blob、佇列或數據表物件的 URL。 只有在 SKU 名稱是Standard_RAGRS時才可使用。
properties.secondaryLocation	string	取得記憶體帳戶的異地復寫次要複寫位置。 只有在 accountType 是Standard_GRS或Standard_RAGRS時才可使用。
properties.statusOfPrimary	AccountStatus	取得狀態，指出記憶體帳戶的主要位置是否可用或無法使用。
properties.statusOfSecondary	AccountStatus	取得狀態，指出記憶體帳戶的次要位置是否可用或無法使用。 只有在 SKU 名稱是Standard_GRS或Standard_RAGRS時才可使用。
properties.storageAccountSkuConversionStatus	StorageAccountSkuConversionStatus	此屬性為 readOnly，而且會在異步記憶體帳戶 SKU 轉換作業期間由伺服器設定。
properties.supportsHttpsTrafficOnly	boolean	如果 設定為 true，則只允許對記憶體服務的 https 流量。
sku	Sku	取得 SKU。
tags	object	資源標籤。
type	string	資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

StorageAccountExpand

可用來展開帳戶屬性內的屬性。 根據預設，擷取屬性時不會包含數據。 目前我們只支援 geoReplicationStats 和 blobRestoreStatus。

名稱	類型	Description
blobRestoreStatus	string
geoReplicationStats	string

StorageAccountInternetEndpoints

用來透過因特網路由端點擷取公用 Blob、檔案、Web 或 dfs 物件的 URI。

名稱	類型	Description
blob	string	取得 Blob 端點。
dfs	string	取得 dfs 端點。
file	string	取得檔案端點。
web	string	取得 Web 端點。

StorageAccountMicrosoftEndpoints

用來透過 Microsoft 路由端點擷取公用 Blob、佇列、數據表、Web 或 dfs 物件的 URI。

名稱	類型	Description
blob	string	取得 Blob 端點。
dfs	string	取得 dfs 端點。
file	string	取得檔案端點。
queue	string	取得佇列端點。
table	string	取得數據表端點。
web	string	取得 Web 端點。

StorageAccountSkuConversionStatus

這會定義異步 SKU 轉換的 SKU 轉換狀態物件。

名稱	類型	Description
endTime	string	此屬性代表 SKU 轉換結束時間。
skuConversionStatus	SkuConversionStatus	這個屬性表示目前的 SKU 轉換狀態。
startTime	string	這個屬性代表 SKU 轉換開始時間。
targetSkuName	SkuName	這個屬性代表帳戶 SKU 以異步方式轉換的目標 SKU 名稱。

UserAssignedIdentity

資源的 UserAssignedIdentity。

名稱	類型	Description
clientId	string	身分識別的用戶端識別碼。
principalId	string	身分識別的主體標識碼。

VirtualNetworkRule

虛擬網路 規則。

名稱	類型	預設值	Description
action	Action	Allow	虛擬網路規則的動作。
id	string		子網的資源標識符，例如：/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}。
state	State		取得虛擬網路規則的狀態。