File Services - Get Service Properties

Service:

Storage Resource Provider

API Version:

2023-01-01

CORS (クロスオリジン リソース共有) ルールを含む、ストレージ アカウント内のファイル サービスのプロパティを取得します。

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 Regex pattern: ^[a-z0-9]+$
FileServicesName	path	True	FileServicesName	指定したストレージ アカウント内のファイル Service の名前。 ファイル サービス名は "default" である必要があります
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	FileServiceProperties	OK -- ストレージ アカウントの File サービスのプロパティを返しました。
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	ユーザー アカウントの借用

例

GetFileServices

Sample Request

HTTP

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

Java

/** Samples for FileServices GetServiceProperties. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileServicesGet.json
     */
    /**
     * Sample code: GetFileServices.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getFileServices(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileServices().getServicePropertiesWithResponse("res4410",
            "sto8607", 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 file_services_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_services.get_service_properties(
        resource_group_name="res4410",
        account_name="sto8607",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileServicesGet.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/FileServicesGet.json
func ExampleFileServicesClient_GetServiceProperties() {
	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.NewFileServicesClient().GetServiceProperties(ctx, "res4410", "sto8607", 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.FileServiceProperties = armstorage.FileServiceProperties{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default"),
	// 	FileServiceProperties: &armstorage.FileServicePropertiesProperties{
	// 		Cors: &armstorage.CorsRules{
	// 			CorsRules: []*armstorage.CorsRule{
	// 				{
	// 					AllowedHeaders: []*string{
	// 						to.Ptr("x-ms-meta-abc"),
	// 						to.Ptr("x-ms-meta-data*"),
	// 						to.Ptr("x-ms-meta-target*")},
	// 						AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemHEAD),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemPOST),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemOPTIONS),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemMERGE),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemPUT)},
	// 							AllowedOrigins: []*string{
	// 								to.Ptr("http://www.contoso.com"),
	// 								to.Ptr("http://www.fabrikam.com")},
	// 								ExposedHeaders: []*string{
	// 									to.Ptr("x-ms-meta-*")},
	// 									MaxAgeInSeconds: to.Ptr[int32](100),
	// 								},
	// 								{
	// 									AllowedHeaders: []*string{
	// 										to.Ptr("*")},
	// 										AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
	// 											to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET)},
	// 											AllowedOrigins: []*string{
	// 												to.Ptr("*")},
	// 												ExposedHeaders: []*string{
	// 													to.Ptr("*")},
	// 													MaxAgeInSeconds: to.Ptr[int32](2),
	// 												},
	// 												{
	// 													AllowedHeaders: []*string{
	// 														to.Ptr("x-ms-meta-12345675754564*")},
	// 														AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
	// 															to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET),
	// 															to.Ptr(armstorage.CorsRuleAllowedMethodsItemPUT)},
	// 															AllowedOrigins: []*string{
	// 																to.Ptr("http://www.abc23.com"),
	// 																to.Ptr("https://www.fabrikam.com/*")},
	// 																ExposedHeaders: []*string{
	// 																	to.Ptr("x-ms-meta-abc"),
	// 																	to.Ptr("x-ms-meta-data*"),
	// 																	to.Ptr("x-ms-meta-target*")},
	// 																	MaxAgeInSeconds: to.Ptr[int32](2000),
	// 															}},
	// 														},
	// 													},
	// 													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 Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
 *
 * @summary Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/FileServicesGet.json
 */
async function getFileServices() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res4410";
  const accountName = "sto8607";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileServices.getServiceProperties(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/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default",
  "name": "default",
  "type": "Microsoft.Storage/storageAccounts/fileServices",
  "properties": {
    "cors": {
      "corsRules": [
        {
          "allowedOrigins": [
            "http://www.contoso.com",
            "http://www.fabrikam.com"
          ],
          "allowedMethods": [
            "GET",
            "HEAD",
            "POST",
            "OPTIONS",
            "MERGE",
            "PUT"
          ],
          "maxAgeInSeconds": 100,
          "exposedHeaders": [
            "x-ms-meta-*"
          ],
          "allowedHeaders": [
            "x-ms-meta-abc",
            "x-ms-meta-data*",
            "x-ms-meta-target*"
          ]
        },
        {
          "allowedOrigins": [
            "*"
          ],
          "allowedMethods": [
            "GET"
          ],
          "maxAgeInSeconds": 2,
          "exposedHeaders": [
            "*"
          ],
          "allowedHeaders": [
            "*"
          ]
        },
        {
          "allowedOrigins": [
            "http://www.abc23.com",
            "https://www.fabrikam.com/*"
          ],
          "allowedMethods": [
            "GET",
            "PUT"
          ],
          "maxAgeInSeconds": 2000,
          "exposedHeaders": [
            "x-ms-meta-abc",
            "x-ms-meta-data*",
            "x-ms-meta-target*"
          ],
          "allowedHeaders": [
            "x-ms-meta-12345675754564*"
          ]
        }
      ]
    }
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  }
}

定義

名前	説明
AllowedMethods	CorsRule 要素が存在する場合は必須です。 配信元によって実行できる HTTP メソッドの一覧。
CloudError	ストレージ サービスからのエラー応答。
CloudErrorBody	ストレージ サービスからのエラー応答。
CorsRule	BLOB サービスの CORS ルールを指定します。
CorsRules	CORS ルールを設定します。 要求には、最大 5 つの CorsRule 要素を含めることができます。
DeleteRetentionPolicy	論理的な削除のサービス プロパティ。
FileServiceProperties	ストレージ アカウント内のファイル サービスのプロパティ。
FileServicesName	指定したストレージ アカウント内のファイル Service の名前。 ファイル サービス名は "default" である必要があります
Multichannel	マルチチャネル設定。 Premium FileStorage にのみ適用されます。
ProtocolSettings	ファイル サービスのプロトコル設定
Sku	ストレージ アカウントの SKU。
SkuName	SKU 名。 アカウントの作成に必要です。更新の場合は省略可能です。 以前のバージョンでは、SKU 名は accountType と呼ばれることに注意してください。
SkuTier	SKU レベル。 これは SKU 名に基づいています。
SmbSetting	SMB プロトコルの設定

AllowedMethods

CorsRule 要素が存在する場合は必須です。 配信元によって実行できる HTTP メソッドの一覧。

名前	型	説明
CONNECT	string
DELETE	string
GET	string
HEAD	string
MERGE	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

CloudError

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

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

CloudErrorBody

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

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

CorsRule

BLOB サービスの CORS ルールを指定します。

名前	型	説明
allowedHeaders	string[]	CorsRule 要素が存在する場合は必須です。 クロスオリジン要求の一部として許可されるヘッダーの一覧。
allowedMethods	AllowedMethods[]	CorsRule 要素が存在する場合は必須です。 配信元によって実行できる HTTP メソッドの一覧。
allowedOrigins	string[]	CorsRule 要素が存在する場合は必須です。 CORS 経由で許可される配信元ドメインの一覧、またはすべてのドメインを許可する "*"
exposedHeaders	string[]	CorsRule 要素が存在する場合は必須です。 CORS クライアントに公開する応答ヘッダーの一覧。
maxAgeInSeconds	integer	CorsRule 要素が存在する場合は必須です。 クライアント/ブラウザーがプレフライト応答をキャッシュする秒数。

CorsRules

CORS ルールを設定します。 要求には、最大 5 つの CorsRule 要素を含めることができます。

名前	型	説明
corsRules	CorsRule[]	CORS 規則の一覧。 要求には、最大 5 つの CorsRule 要素を含めることができます。

DeleteRetentionPolicy

論理的な削除のサービス プロパティ。

名前	型	説明
allowPermanentDelete	boolean	このプロパティを true に設定すると、論理的に削除された BLOB のバージョンとスナップショットを削除できます。 このプロパティは、BLOB 復元ポリシーを使用できません。 このプロパティは BLOB サービスにのみ適用され、コンテナーやファイル共有には適用されません。
days	integer	削除されたアイテムを保持する日数を示します。 指定できる最小値は 1、最大値は 365 です。
enabled	boolean	DeleteRetentionPolicy が有効かどうかを示します。

FileServiceProperties

ストレージ アカウント内のファイル サービスのプロパティ。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.cors	CorsRules	ファイル サービスの CORS 規則を指定します。 要求には、最大 5 つの CorsRule 要素を含めることができます。 要求本文に CorsRule 要素が含まれていない場合、すべての CORS ルールが削除され、ファイル サービスに対して CORS が無効になります。
properties.protocolSettings	ProtocolSettings	ファイル サービスのプロトコル設定
properties.shareDeleteRetentionPolicy	DeleteRetentionPolicy	共有の論理的な削除のファイル サービス プロパティ。
sku	Sku	SKU の名前とレベル。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

FileServicesName

指定したストレージ アカウント内のファイル Service の名前。 ファイル サービス名は "default" である必要があります

名前	型	説明
default	string

Multichannel

マルチチャネル設定。 Premium FileStorage にのみ適用されます。

名前	型	説明
enabled	boolean	マルチチャネルが有効かどうかを示します

ProtocolSettings

ファイル サービスのプロトコル設定

名前	型	説明
smb	SmbSetting	SMB プロトコルの設定

Sku

ストレージ アカウントの SKU。

名前	型	説明
name	SkuName	SKU 名。 アカウントの作成に必要です。更新の場合は省略可能です。 以前のバージョンでは、SKU 名は accountType と呼ばれることに注意してください。
tier	SkuTier	SKU レベル。 これは SKU 名に基づいています。

SkuName

SKU 名。 アカウントの作成に必要です。更新の場合は省略可能です。 以前のバージョンでは、SKU 名は accountType と呼ばれることに注意してください。

名前	型	説明
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 名に基づいています。

名前	型	説明
Premium	string
Standard	string

SmbSetting

SMB プロトコルの設定

名前	型	説明
authenticationMethods	string	サーバーでサポートされている SMB 認証方法。 有効な値は NTLMv2、Kerberos です。 区切り記号 ';' を含む文字列として渡す必要があります。
channelEncryption	string	サーバーでサポートされている SMB チャネル暗号化。 有効な値は、AES-128-CCM、AES-128-GCM、AES-256-GCM です。 区切り記号 ';' を含む文字列として渡す必要があります。
kerberosTicketEncryption	string	サーバーでサポートされている Kerberos チケット暗号化。 有効な値は RC4-HMAC、AES-256 です。 区切り記号 ';' を含む文字列として渡す必要があります
multichannel	Multichannel	マルチチャネル設定。 Premium FileStorage にのみ適用されます。
versions	string	サーバーでサポートされている SMB プロトコルのバージョン。 有効な値は SMB2.1、SMB3.0、SMB3.1.1 です。 区切り記号 ';' を含む文字列として渡す必要があります。