File Services - Get Service Properties

服務:

Storage Resource Provider

API 版本:

2023-05-01

取得記憶體帳戶中檔案服務的屬性，包括 CORS（跨原始來源資源分享）規則。

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

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	指定資源群組內的記憶體帳戶名稱。 儲存體帳戶名稱長度必須介於 3 到 24 個字元之間，且只能使用數位和小寫字母。 Regex 模式: ^[a-z0-9]+$
FileServicesName	path	True	FileServicesName	指定記憶體帳戶內服務檔案的名稱。 檔名必須是 “default”
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。 名稱不區分大小寫。 Regex 模式: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	FileServiceProperties	確定 -- 傳回記憶體帳戶檔案服務的屬性。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

GetFileServices

範例要求

HTTP

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

Java

/**
 * Samples for FileServices GetServiceProperties.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-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-05-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/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-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-05-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileServicesGet.json
// this example is just showing the usage of "FileServices_GetServiceProperties" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FileServiceResource created on azure
// for more information of creating FileServiceResource, please refer to the document of FileServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res4410";
string accountName = "sto8607";
ResourceIdentifier fileServiceResourceId = FileServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
FileServiceResource fileService = client.GetFileServiceResource(fileServiceResourceId);

// invoke the operation
FileServiceResource result = await fileService.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
FileServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

範例回覆

狀態碼:

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"
  }
}

定義

名稱	Description
AllowedMethods	如果 CorsRule 元素存在，則為必要專案。 來源允許執行的 HTTP 方法清單。
CloudError	記憶體服務的錯誤回應。
CloudErrorBody	記憶體服務的錯誤回應。
CorsRule	指定 Blob 服務的 CORS 規則。
CorsRules	設定 CORS 規則。 您可以在要求中包含最多五個 CorsRule 元素。
DeleteRetentionPolicy	虛刪除的服務屬性。
FileServiceProperties	記憶體帳戶中檔案服務的屬性。
FileServicesName	指定記憶體帳戶內服務檔案的名稱。 檔名必須是 “default”
Multichannel	多重通道設定。 僅適用於進階 FileStorage。
ProtocolSettings	檔案服務的通訊協議設定
Sku	記憶體帳戶的 SKU。
SkuName	SKU 名稱。 帳戶建立的必要專案;選擇性的更新。 請注意，在舊版中，SKU 名稱稱為 accountType。
SkuTier	SKU 層。 這是以 SKU 名稱為基礎。
SmbSetting	設定SMB通訊協定

AllowedMethods

如果 CorsRule 元素存在，則為必要專案。 來源允許執行的 HTTP 方法清單。

名稱	類型	Description
CONNECT	string
DELETE	string
GET	string
HEAD	string
MERGE	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

CloudError

記憶體服務的錯誤回應。

名稱	類型	Description
error	CloudErrorBody	記憶體服務的錯誤回應。

CloudErrorBody

記憶體服務的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。 程序代碼是不變的，而且是要以程序設計方式取用。
details	CloudErrorBody[]	錯誤的其他詳細數據清單。
message	string	描述錯誤的訊息，適用於在使用者介面中顯示。
target	string	特定錯誤的目標。 例如，錯誤中的屬性名稱。

CorsRule

指定 Blob 服務的 CORS 規則。

名稱	類型	Description
allowedHeaders	string[]	如果 CorsRule 元素存在，則為必要專案。 允許成為跨原始來源要求的標頭清單。
allowedMethods	AllowedMethods[]	如果 CorsRule 元素存在，則為必要專案。 來源允許執行的 HTTP 方法清單。
allowedOrigins	string[]	如果 CorsRule 元素存在，則為必要專案。 允許透過 CORS 或 「*」 允許所有網域的原始網域清單
exposedHeaders	string[]	如果 CorsRule 元素存在，則為必要專案。 要公開給 CORS 用戶端的回應標頭清單。
maxAgeInSeconds	integer	如果 CorsRule 元素存在，則為必要專案。 用戶端/瀏覽器應該快取預檢回應的秒數。

CorsRules

設定 CORS 規則。 您可以在要求中包含最多五個 CorsRule 元素。

名稱	類型	Description
corsRules	CorsRule[]	CORS 規則的清單。 您可以在要求中包含最多五個 CorsRule 元素。

DeleteRetentionPolicy

虛刪除的服務屬性。

名稱	類型	Description
allowPermanentDelete	boolean	當設定為 true 時，此屬性允許刪除虛刪除的 Blob 版本和快照集。 這個屬性不能使用 Blob 還原原則。 此屬性僅適用於 Blob 服務，不適用於容器或檔案共用。
days	integer	指出應保留已刪除專案的天數。 指定的最小值可以是 1，最大值可以是 365。
enabled	boolean	指出是否啟用DeleteRetentionPolicy。

FileServiceProperties

記憶體帳戶中檔案服務的屬性。

名稱	類型	Description
id	string	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.cors	CorsRules	指定檔案服務的 CORS 規則。 您可以在要求中包含最多五個 CorsRule 元素。 如果要求本文中未包含 CorsRule 元素，則會刪除所有 CORS 規則，而且會停用檔案服務的 CORS。
properties.protocolSettings	ProtocolSettings	檔案服務的通訊協議設定
properties.shareDeleteRetentionPolicy	DeleteRetentionPolicy	共用虛刪除的檔案服務屬性。
sku	Sku	Sku 名稱和階層。
type	string	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

FileServicesName

指定記憶體帳戶內服務檔案的名稱。 檔名必須是 “default”

名稱	類型	Description
default	string

Multichannel

多重通道設定。 僅適用於進階 FileStorage。

名稱	類型	Description
enabled	boolean	指出是否啟用多重通道

ProtocolSettings

檔案服務的通訊協議設定

名稱	類型	Description
smb	SmbSetting	設定SMB通訊協定

Sku

記憶體帳戶的 SKU。

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

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

SmbSetting

設定SMB通訊協定

名稱	類型	Description
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	多重通道設定。 僅適用於進階 FileStorage。
versions	string	伺服器支援的SMB通訊協定版本。 有效值為SMB2.1、SMB3.0、SMB3.1.1。 應該以具有分隔符 『;』 的字串傳遞。