Get Storage Account Properties
Get Storage Account Properties
操作には、指定されたストレージ アカウントのシステム プロパティが返されます。
要求
Get Storage Account Properties
要求は次のように指定することがあります。 置き換える <subscription-id>
をサブスクリプション ID に、および <storage-account-name>
をストレージ アカウントの名前。
メソッド | 要求 URI |
---|---|
GET | https://management.core.windows.net/<subscription-id>/services/storageservices/<storage-account-name> |
管理サービスに対して行われる要求をセキュリティで保護する必要があります。 詳細については、次を参照してください。 サービス管理要求の認証です。
URI パラメーター
ありません。
要求ヘッダー
要求ヘッダーの説明を次の表に示します。
要求ヘッダー | 説明 |
---|---|
x-ms-version |
必須です。 この要求に使用する操作のバージョンを指定します。 このヘッダーを設定する必要があります 2009年-10-01 またはそれ以降。 バージョン ヘッダーの詳細については、次を参照してください。 サービス管理のバージョン管理です。 |
要求本文
ありません。
応答
応答には、HTTP ステータス コード、一連の応答ヘッダー、および応答本文が含まれています。
ステータス コード
操作が正常に終了では、ステータス コード 200 (OK) を返します。 状態コードについては、次を参照してください。 サービス管理のステータス コードとエラー コードです。
応答ヘッダー
この操作の応答には、次のヘッダーが含まれています。 追加の標準 HTTP ヘッダーが応答に含まれていることもあります。 すべての標準ヘッダーに準拠している、 http/1.1 プロトコル仕様です。
応答ヘッダー | 説明 |
---|---|
x-ms-request-id |
管理サービスに対して行われた要求を一意に識別する値。 |
応答本文
応答本文の形式は次のとおりです。
<?xml version="1.0" encoding="utf-8"?> <StorageService xmlns="https://schemas.microsoft.com/windowsazure"> <Url>storage-account-request-uri</Url> <ServiceName>storage-account-name</ServiceName> <StorageServiceProperties> <Description>description</Description> <AffinityGroup>affinity-group</AffinityGroup> <Location>location</Location> <Label>base64-encoded-label</Label> <Status>status</Status> <Endpoints> <Endpoint>storage-service-blob-endpoint</Endpoint> <Endpoint>storage-service-queue-endpoint</Endpoint> <Endpoint>storage-service-table-endpoint</Endpoint> <Endpoint>storage-service-file-endpoint</Endpoint> </Endpoints> <GeoReplicationEnabled>geo-replication-indicator</GeoReplicationEnabled> <GeoPrimaryRegion>primary-region</GeoPrimaryRegion> <StatusOfPrimary>primary-status</StatusOfPrimary> <LastGeoFailoverTime>DateTime</LastGeoFailoverTime> <GeoSecondaryRegion>secondary-region</GeoSecondaryRegion> <StatusOfSecondary>secondary-status</StatusOfSecondary> <CreationTime>time-of-creation</CreationTime> <CustomDomains> <CustomDomain> <Name>name-of-custom-domain</Name> </CustomDomain> </CustomDomains> <SecondaryReadEnabled>secondary-read-indicator</SecondaryReadEnabled> <SecondaryEndpoints> <Endpoint>storage-secondary-service-blob-endpoint</Endpoint> <Endpoint>storage-secondary-service-queue-endpoint</Endpoint> <Endpoint>storage-secondary-service-table-endpoint</Endpoint> </SecondaryEndpoints> <AccountType>type-of-storage-account</AccountType> </StorageServiceProperties> <ExtendedProperties> <ExtendedProperty> <Name>property-name</Name> <Value>property-value</Value> </ExtendedProperty> </ExtendedProperties> <Capabilities> <Capability>storage-account-capability</Capability> </Capabilities> </StorageService>
応答本文の要素は次のとおりです。
要素名 | 説明 |
---|---|
Url | ストレージ アカウントの URI を指定します。 |
ServiceName | ストレージ アカウントの名前を指定します。 この名前は DNS プレフィックス名で、ストレージ アカウント内の BLOB、キュー、テーブルへのアクセスに使用されます。 たとえば、次のサービス名は MyStorageAccount 呼び出すことによって blob コンテナーにアクセスすることができます http://MyStorageAccount.blob.core.windows.net/mycontainer/。 |
StorageServiceProperties | ストレージ アカウントのプロパティを指定します。 |
ExtendedProperties | ストレージ アカウントに追加された拡張プロパティの名前と値を指定します。 |
Capability | ストレージ アカウントで仮想マシンに関連する操作を実行できるかどうかを示します。 実行できる場合、この要素は PersistentVMRole を含む文字列を返します。 それ以外の場合は、応答本文にこの要素は含まれません。Capability 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
StorageServiceProperties
ストレージ アカウントのプロパティを指定します。
要素名 | 説明 |
---|---|
説明 | 省略可能です。 ストレージ アカウントの説明。 説明の最大長は 1,024 文字です。Description 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
AffinityGroup | 必要な場合 Location が指定されていません。 このサブスクリプションに関連付けられている既存のアフィニティ グループの名前。 この名前は GUID でありによって返される応答本文の名前の要素を取得できる、 アフィニティ グループを一覧表示 操作します。AffinityGroup 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
場所 | 必要な場合 AffinityGroup が指定されていません。 ストレージ アカウントを作成する場所。Location 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
Label (英語の可能性あり) | 必須です。 Base 64 エンコード形式のホステッド サービスの名前。 名前の最大長は 100 文字です。 名前は、ストレージ アカウントを追跡する場合に、アカウントを識別するために使用できます。Label 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
Status | ストレージ アカウントのステータス。 次の値をとります。 - Creating - Created - Deleting - Deleted - Changing - ResolvingDns Status 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
エンドポイント | BLOB、テーブル、キュー、ファイルのエンドポイント。 注 1:ファイルのエンドポイントはプレビュー モードであり、プレビューが有効なサブスクリプションに対してのみ返されます。 2 を注意してください。アカウントの種類が Standard_ZRS の場合は、BLOB エンドポイントのみが返されます。 また、ZRS がサポートするのはブロック BLOB のみで、ページ BLOB はサポートしないため、IaaS VM とは互換性がありません。 注 3:アカウントの種類が Premium_LRS の場合は、BLOB エンドポイントのみが返されます。 |
GeoReplicationEnabled | サービスが壊滅的に失われた場合に回復できるように、ストレージ アカウント内のデータを複数の地理的な場所にレプリケートするかどうかを示します。 値が true 地理的レプリケーションが有効になっている場合 false です。GeoReplicationEnabled 要素は、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上し、は、バージョン 2014年-06-01 AccountType 要素によって置き換えられた以降。 |
GeoPrimaryRegion | 現時点でストレージ アカウントが存在する地理的なプライマリ地域を示します。GeoPrimaryRegion 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
StatusOfPrimary | ストレージのプライマリ地域を利用できるかどうかを示します。 次の値をとります。 - Available - Unavailable StatusOfPrimary 要素ではバージョン 2013年-11-01 を使用して利用可能なまたはそれ以上のみです。 |
LastGeoFailoverTime | セカンダリ地域へのフェールオーバーの最新のインスタンスを示すタイムスタンプ。 複数のフェールオーバーが存在する場合、最新のフェールオーバーの日時だけが保持されます。 タイムスタンプは、[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitMinute]:[2DigitSecond]:[7DigitsOfPrecision]Z の形式で返されます。 例: < LastGeoFailoverTime > 2010年-01-2010-01-18t13:15:30.0000000z </LastGeoFailoverTime > フェールオーバーのインスタンスが存在しない場合、LastGeoFailoverTime は返されません。 LastGeoFailoverTime 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
GeoSecondaryRegion | ストレージ アカウントをレプリケートする地理的地域を示します。 このアカウントでジオレプリケーションが無効になっている場合、GeoSecondaryRegion 要素は返されません。 GeoSecondaryRegion 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
StatusOfSecondary | ストレージのセカンダリ地域を利用できるかどうかを示します。 次の値をとります。 - Available - Unavailable StatusOfSecondary 要素ではバージョン 2013年-11-01 を使用して利用可能なまたはそれ以上のみです。 |
CreationTime | ストレージ アカウントが作成された時刻を指定します。 |
CustomDomains | ストレージ アカウントに関連付けられたカスタム ドメインを指定します。CustomDomains 要素ではバージョン 2013年-06-01 を使用して利用可能なまたはそれ以上のみです。 |
SecondaryReadEnabled | ストレージ アカウントでセカンダリ読み取りが有効になっていることを示します。 次の値をとります。 - true - false SecondaryReadEnabled 要素はバージョン 2013年-11-01 を使用して利用可能な以降だけとは、バージョン 2014年-06-01 AccountType 要素によって置き換えられた以降。 |
SecondaryEndpoints | ストレージ アカウントのセカンダリ エンドポイントを指定します。SecondaryEndpoints 要素ではバージョン 2013年-11-01 を使用して利用可能なまたはそれ以上のみです。 |
AccountType | アカウントが、ローカル冗長ストレージ、地理冗長ストレージ、ゾーン冗長ストレージ、読み取りアクセス地理冗長ストレージのいずれをサポートするかを指定します。 次の値をとります。 - Standard_LRS - Standard_ZRS - Standard_GRS - Standard_RAGRS - Premium_LRS AccountType 要素ではバージョン 2014年-06-01 を使用して利用可能なまたはそれ以上のみと SecondaryReadEnabled および GeoReplicationEnabled 要素に置き換えられます。Premium_LRS 要素ではバージョン 2014年-10-01 を使用して利用可能なまたはそれ以上のみです。 |
エンドポイント
ストレージ アカウントのエンドポイントを指定します。
要素名 | 説明 |
---|---|
エンドポイント | 次の形式で blob サービス エンドポイントが含まれています。 https:// <storage-service-name>.blob.core.windows.net Endpoint 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 HTTP のエンドポイントは、バージョン 2014-04-01 またはそれ以前のバージョンで返されます。 |
エンドポイント | 次の形式でキュー サービスのエンドポイントが含まれています。 https:// <storage-service-name>.queue.core.windows.net Endpoint 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 HTTP のエンドポイントは、バージョン 2014-04-01 またはそれ以前のバージョンで返されます。 |
エンドポイント | 次の形式でテーブル サービスのエンドポイントが含まれています。 https://<storage-service-name>.table.core.windows.net Endpoint 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 HTTP のエンドポイントは、バージョン 2014-04-01 またはそれ以前のバージョンで返されます。 |
エンドポイント | 次の形式でファイル サービスのエンドポイントが含まれています。 https://<storage-service-name>.file.core.windows.net Endpoint 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 HTTP のエンドポイントは、バージョン 2014-04-01 またはそれ以前のバージョンで返されます。 |
CustomDomains
ストレージ アカウントに関連付けられたカスタム ドメインを指定します。
要素名 | 説明 |
---|---|
CustomDomain | ストレージ アカウントに関連付けられたカスタム ドメインに関する情報を指定します。 |
名前 | カスタム ドメインの名前を指定します。 |
SecondaryEndpoints
ストレージ アカウントのセカンダリ エンドポイントを指定します。
要素名 | 説明 |
---|---|
エンドポイント | 次の形式で blob セカンダリ サービス エンドポイントが含まれています。 https://<storage-secondary-service-name>.blob.core.windows.net HTTP のエンドポイントは、バージョン 2014-04-01 またはそれ以前のバージョンで返されます。 |
エンドポイント | 次の形式でキュー サービスのエンドポイントが含まれています。 https://<storage-secondary-service-name>.queue.core.windows.net HTTP のエンドポイントは、バージョン 2014-04-01 またはそれ以前のバージョンで返されます。 |
エンドポイント | 次の形式でテーブル サービスのエンドポイントが含まれています。 https://<storage-secondary-service-name>.table.core.windows.net HTTP のエンドポイントは、バージョン 2014-04-01 またはそれ以前のバージョンで返されます。 |
ExtendedProperties
ストレージ アカウントに追加された拡張プロパティの名前と値を指定します。
要素名 | 説明 |
---|---|
名前 | 省略可能です。 ストレージ アカウントの拡張プロパティの名前を表します。 各拡張プロパティには、定義済みの名前と値の両方が必要です。 拡張プロパティの名前と値のペアは最大 50 組使用できます。 Name 要素の最大長は 64 文字です。Name では英数字とアンダースコアのみが有効であり、名前の先頭にはアルファベットを使用する必要があります。 他の文字を使用しようとした場合、Name の先頭がアルファベット以外の文字の場合、または同じストレージ アカウントが所有する別の拡張プロパティの名前と同一の名前を入力した場合は、ステータス コード 400 (Bad Request) のエラーが発生します。 Name 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
値 | 省略可能です。 ストレージ アカウントの拡張プロパティの値を表します。 各拡張プロパティには、定義済みの名前と値の両方が必要です。 拡張プロパティの名前と値のペアは最大 50 組使用できます。各拡張プロパティ値の最大長は 255 文字です。Value 要素で、バージョン 2012年-03-01 を使用して利用可能なまたはそれ以上のみです。 |
解説
ジオレプリケーションは、ストレージ アカウントの作成または更新時に有効にすることができます。
場合、 x-ms-version
が 2012年-03-01 またはそれ以上、非推奨のいずれかでアフィニティ グループが作成されたと Anywhere US
, 、Anywhere Europe
, 、Anywhere Asia
、地域、 Location
要素はこのアフィニティ グループを割り当てる場所を返します。
使用例
次のサンプル プログラムでは、サブスクリプション ID、関連付けられている管理証明書のサムプリント、操作バージョン文字列、およびストレージ アカウント名を取得し、返されたストレージ アカウントのプロパティをコンソールに出力します。 初期化、 msVersion
, 、subscriptionId
, 、thumbprint
と serviceName
例のコードを実行する独自の値を持つ変数です。
using System; using System.Collections.Generic; using System.Net; using System.Security.Cryptography.X509Certificates; using System.Xml; using System.Xml.Linq; class Program { static void Main(string[] args) { string msVersion = "2011-12-01"; string subscriptionId = "subscription-id-guid"; string thumbprint = "certificate-thumbprint"; string serviceName = "myexamplestorage1"; try { // Obtain the certificate with the specified thumbprint X509Certificate2 certificate = GetCertificate(thumbprint); GetStorageAccountPropertiesExample( subscriptionId, certificate, msVersion, serviceName); } catch (Exception ex) { Console.WriteLine("Exception caught in Main:"); Console.WriteLine(ex.Message); } } public static X509Certificate2 GetCertificate(string thumbprint) { List<StoreLocation> locations = new List<StoreLocation> { StoreLocation.CurrentUser, StoreLocation.LocalMachine }; foreach (var location in locations) { X509Store store = new X509Store("My", location); try { store.Open(OpenFlags.ReadOnly | OpenFlags.OpenExistingOnly); X509Certificate2Collection certificates = store.Certificates.Find( X509FindType.FindByThumbprint, thumbprint, false); if (certificates.Count == 1) { return certificates[0]; } } finally { store.Close(); } } throw new ArgumentException(string.Format( "A certificate with thumbprint '{0}' could not be located.", thumbprint)); } public static void GetStorageAccountPropertiesExample( string subscriptionId, X509Certificate2 certificate, string version, string serviceName) { string uriFormat = "https://management.core.windows.net/{0}/services/storageservices/{1}"; Uri uri = new Uri(String.Format(uriFormat, subscriptionId, serviceName)); HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(uri); request.Method = "GET"; request.Headers.Add("x-ms-version", version); request.ClientCertificates.Add(certificate); request.ContentType = "application/xml"; XDocument responseBody = null; HttpStatusCode statusCode; HttpWebResponse response; try { response = (HttpWebResponse)request.GetResponse(); } catch (WebException ex) { // GetResponse throws a WebException for 400 and 500 status codes response = (HttpWebResponse)ex.Response; } statusCode = response.StatusCode; if (response.ContentLength > 0) { using (XmlReader reader = XmlReader.Create(response.GetResponseStream())) { responseBody = XDocument.Load(reader); } } response.Close(); if (statusCode.Equals(HttpStatusCode.OK)) { XNamespace wa = "https://schemas.microsoft.com/windowsazure"; XElement storageService = responseBody.Element(wa + "StorageService"); Console.WriteLine( "Storage Account Properties for {0}:{1}{2}", serviceName, Environment.NewLine, storageService.ToString(SaveOptions.OmitDuplicateNamespaces)); } else { Console.WriteLine("Call to GetStorageAccountProperties returned an error:"); Console.WriteLine("Status Code: {0} ({1}):{2}{3}", (int)statusCode, statusCode, Environment.NewLine, responseBody.ToString(SaveOptions.OmitDuplicateNamespaces)); } return; } }