File Services - Get Service Properties

参考

服务:: Storage Resource Provider

API 版本:: 2024-01-01

获取存储帐户中文件服务的属性，包括 CORS（跨域资源共享）规则。

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	指定资源组中的存储帐户的名称。存储帐户名称长度必须介于 3 到 24 个字符之间，并且仅使用数字和小写字母。
FileServicesName	path	True	FileServicesName	指定存储帐户中的文件服务的名称。文件服务名称必须是“default”
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	用户订阅中的资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	FileServiceProperties	确定 - 返回存储帐户的文件服务的属性。
Other Status Codes	CloudError	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

GetFileServices

示例请求

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


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

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/2024-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

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/97ee23a6db6078abcbec7b75bf9af8c503e9bb8b/specification/storage/resource-manager/Microsoft.Storage/stable/2024-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

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

/**
 * 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/2024-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

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/2024-01-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"
  }
}

定义

名称	说明
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 方法的列表。

值	说明
CONNECT
DELETE
GET
HEAD
MERGE
OPTIONS
PATCH
POST
PUT
TRACE

CloudError

Object

存储服务的错误响应。

名称	类型	说明
error	CloudErrorBody	存储服务的错误响应。

CloudErrorBody

Object

存储服务的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

CorsRule

Object

指定 Blob 服务的 CORS 规则。

名称	类型	说明
allowedHeaders	string[]	如果存在 CorsRule 元素，则为必需。允许作为跨域请求的一部分的标头列表。
allowedMethods	AllowedMethods[]	如果存在 CorsRule 元素，则为必需。源允许执行的 HTTP 方法的列表。
allowedOrigins	string[]	如果存在 CorsRule 元素，则为必需。将允许通过 CORS 或“*”允许所有域的源域列表
exposedHeaders	string[]	如果存在 CorsRule 元素，则为必需。要向 CORS 客户端公开的响应标头列表。
maxAgeInSeconds	integer	如果存在 CorsRule 元素，则为必需。客户端/浏览器应缓存预检响应的秒数。

CorsRules

Object

设置 CORS 规则。请求中最多可以包含五个 CorsRule 元素。

名称	类型	说明
corsRules	CorsRule[]	CORS 规则列表。请求中最多可以包含五个 CorsRule 元素。

DeleteRetentionPolicy

Object

软删除的服务属性。

名称	类型	说明
allowPermanentDelete	boolean	如果设置为 true，则此属性允许删除软删除的 Blob 版本和快照。此属性不能使用 Blob 还原策略。此属性仅适用于 Blob 服务，不适用于容器或文件共享。
days	integer minimum: 1 maximum: 365	指示应保留已删除项的天数。最小指定值可以是 1，最大值可以为 365。
enabled	boolean	指示是否启用 DeleteRetentionPolicy。

FileServiceProperties

Object

存储帐户中文件服务的属性。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /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”

值	说明
default

Multichannel

Object

多通道设置。仅适用于高级 FileStorage。

名称	类型	说明
enabled	boolean	指示是否启用多通道

ProtocolSettings

Object

文件服务的协议设置

名称	类型	说明
smb	SmbSetting	SMB 协议的设置

Sku

Object

存储帐户的 SKU。

名称	类型	说明
name	SkuName	SKU 名称。创建帐户时需要;可选，用于更新。请注意，在旧版本中，SKU 名称称为 accountType。
tier	SkuTier	SKU 层。这基于 SKU 名称。

SkuName

枚举

SKU 名称。创建帐户时需要;可选，用于更新。请注意，在旧版本中，SKU 名称称为 accountType。

值	说明
PremiumV2_LRS
PremiumV2_ZRS
Premium_LRS
Premium_ZRS
StandardV2_GRS
StandardV2_GZRS
StandardV2_LRS
StandardV2_ZRS
Standard_GRS
Standard_GZRS
Standard_LRS
Standard_RAGRS
Standard_RAGZRS
Standard_ZRS

SkuTier

枚举

SKU 层。这基于 SKU 名称。

值	说明
Premium
Standard

SmbSetting

Object

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	多通道设置。仅适用于高级 FileStorage。
versions	string	服务器支持的 SMB 协议版本。有效值为 SMB2.1、SMB3.0、SMB3.1.1。应作为带分隔符“;”的字符串传递。