File Shares - Get

リファレンス

Service:: Storage Resource Provider

API Version:: 2023-01-01

指定した共有のプロパティを取得します。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	指定したリソースグループ内のストレージアカウントの名前。ストレージアカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 Regex pattern: `^[a-z0-9]+$`
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソースグループの名前。名前の大文字と小文字は区別されます。 Regex pattern: `^[-\w\._]+$`
shareName	path	True	string	指定したストレージアカウント内のファイル共有の名前。ファイル共有名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。
$expand	query		string	省略可能。共有のプロパティ内のプロパティを展開するために使用されます。有効な値は、stats です。区切り記号 ',' を含む文字列として渡す必要があります。

要求ヘッダー

名前	必須	型	説明
x-ms-snapshot		string	省略可能。スナップショットのプロパティを取得するために使用されます。

応答

名前	型	説明
200 OK	FileShare	OK -- 共有の取得操作が正常に完了しました。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

GetShares

GetShareStats

GetShares

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2023-01-01


/** Samples for FileShares Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesGet.json
     */
    /**
     * Sample code: GetShares.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getShares(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileShares().getWithResponse("res9871", "sto6217",
            "share1634", null, 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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python file_shares_get.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.file_shares.get(
        resource_group_name="res9871",
        account_name="sto6217",
        share_name="share1634",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesGet.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

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/FileSharesGet.json
func ExampleFileSharesClient_Get_getShares() {
	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.NewFileSharesClient().Get(ctx, "res9871", "sto6217", "share1634", &armstorage.FileSharesClientGetOptions{Expand: nil,
		XMSSnapshot: 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.FileShare = armstorage.FileShare{
	// 	Name: to.Ptr("share1634"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/shares"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634"),
	// 	Etag: to.Ptr("\"0x8D592D74CC20EBA\""),
	// 	FileShareProperties: &armstorage.FileShareProperties{
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-05-26T05:06:14.000Z"); return t}()),
	// 		ShareQuota: to.Ptr[int32](1024),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets properties of a specified share.
 *
 * @summary Gets properties of a specified share.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesGet.json
 */
async function getShares() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9871";
  const accountName = "sto6217";
  const shareName = "share1634";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileShares.get(resourceGroupName, accountName, shareName);
  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/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "properties": {
    "lastModifiedTime": "2019-05-26T05:06:14Z",
    "shareQuota": 1024
  }
}

GetShareStats

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2023-01-01&$expand=stats


/** Samples for FileShares Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesGet_Stats.json
     */
    /**
     * Sample code: GetShareStats.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getShareStats(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileShares().getWithResponse("res9871", "sto6217",
            "share1634", "stats", 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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python file_shares_get_stats.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.file_shares.get(
        resource_group_name="res9871",
        account_name="sto6217",
        share_name="share1634",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesGet_Stats.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

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/FileSharesGet_Stats.json
func ExampleFileSharesClient_Get_getShareStats() {
	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.NewFileSharesClient().Get(ctx, "res9871", "sto6217", "share1634", &armstorage.FileSharesClientGetOptions{Expand: to.Ptr("stats"),
		XMSSnapshot: 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.FileShare = armstorage.FileShare{
	// 	Name: to.Ptr("share1634"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/shares"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634"),
	// 	Etag: to.Ptr("\"0x8D592D74CC20EBA\""),
	// 	FileShareProperties: &armstorage.FileShareProperties{
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-05-26T05:06:14.000Z"); return t}()),
	// 		ShareQuota: to.Ptr[int32](1024),
	// 		ShareUsageBytes: to.Ptr[int64](652945),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets properties of a specified share.
 *
 * @summary Gets properties of a specified share.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileSharesGet_Stats.json
 */
async function getShareStats() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9871";
  const accountName = "sto6217";
  const shareName = "share1634";
  const expand = "stats";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileShares.get(resourceGroupName, accountName, shareName, 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/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "properties": {
    "lastModifiedTime": "2019-05-26T05:06:14Z",
    "shareQuota": 1024,
    "shareUsageBytes": 652945
  }
}

定義

名前	説明
AccessPolicy
CloudError	ストレージサービスからのエラー応答。
CloudErrorBody	ストレージサービスからのエラー応答。
EnabledProtocols	ファイル共有に使用される認証プロトコル。共有の作成時にのみ指定できます。
FileShare	ID、リソース名、リソースの種類、Etag など、ファイル共有のプロパティ。
LeaseDuration	共有のリース期間が無制限か固定期間かを指定します。これは、共有がリースされている場合に限られます。
LeaseState	共有のリース状態。
LeaseStatus	共有のリース状態。
RootSquashType	プロパティは NFS 共有専用です。既定値は NoRootSquash です。
ShareAccessTier	特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定値)、ホット、クールのどちらかを選択できます。 FileStorage アカウントでは、Premium を選択できます。
SignedIdentifier

AccessPolicy

名前	型	説明
expiryTime	string	アクセスポリシーの有効期限
permission	string	省略されたアクセス許可の一覧。
startTime	string	アクセスポリシーの開始時刻

CloudError

ストレージサービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	ストレージサービスからのエラー応答。

CloudErrorBody

ストレージサービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。たとえば、エラーが発生したプロパティの名前です。

EnabledProtocols

ファイル共有に使用される認証プロトコル。共有の作成時にのみ指定できます。

名前	型	説明
NFS	string
SMB	string

FileShare

ID、リソース名、リソースの種類、Etag など、ファイル共有のプロパティ。

名前	型	説明
etag	string	リソース Etag。
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.accessTier	ShareAccessTier	特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定値)、ホット、クールのどちらかを選択できます。 FileStorage アカウントでは、Premium を選択できます。
properties.accessTierChangeTime	string	共有アクセス層の最終変更時刻を示します。
properties.accessTierStatus	string	アクセス層の移行が保留中かどうかを示します。
properties.deleted	boolean	共有が削除されたかどうかを示します。
properties.deletedTime	string	共有が削除された場合の削除時刻。
properties.enabledProtocols	EnabledProtocols	ファイル共有に使用される認証プロトコル。共有の作成時にのみ指定できます。
properties.lastModifiedTime	string	共有が最後に更新された日時を返します。
properties.leaseDuration	LeaseDuration	共有のリース期間が無制限か固定期間かを指定します。これは、共有がリースされている場合に限られます。
properties.leaseState	LeaseState	共有のリース状態。
properties.leaseStatus	LeaseStatus	共有のリース状態。
properties.metadata	object	共有にメタデータとして関連付ける名前と値のペアを指定します。
properties.remainingRetentionDays	integer	論理的に削除された共有の残りの保持日数。
properties.rootSquash	RootSquashType	プロパティは NFS 共有専用です。既定値は NoRootSquash です。
properties.shareQuota	integer	共有の最大サイズ (ギガバイト単位)。 0 より大きく 5 TB (5120) 以下である必要があります。大きなファイル共有の場合、最大サイズは 102400 です。
properties.shareUsageBytes	integer	共有に格納されているデータのおおよそのサイズ。この値には、最近作成または最近サイズ変更されたすべてのファイルが含まれていない場合があることに注意してください。
properties.signedIdentifiers	SignedIdentifier[]	共有で指定された格納されているアクセスポリシーの一覧。
properties.snapshotTime	string	共有の作成時間スナップショット展開パラメーター "snapshots" を使用してリスト共有の応答で返されます。
properties.version	string	共有のバージョン。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

LeaseDuration

共有のリース期間が無制限か固定期間かを指定します。これは、共有がリースされている場合に限られます。

名前	型	説明
Fixed	string
Infinite	string

LeaseState

共有のリース状態。

名前	型	説明
Available	string
Breaking	string
Broken	string
Expired	string
Leased	string

LeaseStatus

共有のリース状態。

名前	型	説明
Locked	string
Unlocked	string

RootSquashType

プロパティは NFS 共有専用です。既定値は NoRootSquash です。

名前	型	説明
AllSquash	string
NoRootSquash	string
RootSquash	string

ShareAccessTier

特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定値)、ホット、クールのどちらかを選択できます。 FileStorage アカウントでは、Premium を選択できます。

名前	型	説明
Cool	string
Hot	string
Premium	string
TransactionOptimized	string

SignedIdentifier

名前	型	説明
accessPolicy	AccessPolicy	アクセスポリシー
id	string	格納されているアクセスポリシーの一意識別子。

File Shares - Get

URI パラメーター

要求ヘッダー

応答

セキュリティ

azure_auth

Scopes

例

GetShares

Sample Request

Sample Response

GetShareStats

Sample Request

Sample Response

定義

AccessPolicy

CloudError

CloudErrorBody

EnabledProtocols

FileShare

LeaseDuration

LeaseState

LeaseStatus

RootSquashType

ShareAccessTier

SignedIdentifier

その他のリソース