File Services - Get Service Properties

Service:

Storage Resource Provider

API Version:

2023-01-01

Lekéri a tárfiókokban található fájlszolgáltatások tulajdonságait, beleértve a CORS (eltérő eredetű erőforrás-megosztás) szabályokat.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string	A tárfiók neve a megadott erőforráscsoportban. A tárfiókok nevének 3–24 karakter hosszúságúnak kell lennie, és csak számokat és kisbetűket kell használnia. Regex pattern: ^[a-z0-9]+$
FileServicesName	path	True	FileServicesName	A fájlszolgáltatás neve a megadott tárfiókban. A fájlszolgáltatás nevének "alapértelmezettnek" kell lennie
resourceGroupName	path	True	string	A felhasználó előfizetésén belüli erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	FileServiceProperties	OK – visszaadta egy tárfiók Fájlszolgáltatásának tulajdonságait.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
AllowedMethods	Kötelező, ha a CorsRule elem jelen van. A forrás által végrehajtható HTTP-metódusok listája.
CloudError	Hibaválasz a Storage szolgáltatástól.
CloudErrorBody	Hibaválasz a Storage szolgáltatástól.
CorsRule	Cors-szabályt ad meg a Blob szolgáltatáshoz.
CorsRules	Beállítja a CORS-szabályokat. A kérelemben legfeljebb öt CorsRule-elem szerepelhet.
DeleteRetentionPolicy	A helyreállítható törlés szolgáltatástulajdonságai.
FileServiceProperties	A Fájlszolgáltatások tulajdonságai a tárfiókban.
FileServicesName	A fájlszolgáltatás neve a megadott tárfiókban. A fájlszolgáltatás nevének "alapértelmezettnek" kell lennie
Multichannel	Többcsatornás beállítás. Csak a Premium FileStorage szolgáltatásra vonatkozik.
ProtocolSettings	A fájlszolgáltatás protokollbeállításai
Sku	A tárfiók termékváltozata.
SkuName	A termékváltozat neve. A fiók létrehozásához szükséges; nem kötelező a frissítéshez. Vegye figyelembe, hogy a régebbi verziókban a termékváltozat neve accountType volt.
SkuTier	A termékváltozat szintje. Ez a termékváltozat neve alapján történik.
SmbSetting	SMB-protokoll beállítása

AllowedMethods

Kötelező, ha a CorsRule elem jelen van. A forrás által végrehajtható HTTP-metódusok listája.

Name	Típus	Description
CONNECT	string
DELETE	string
GET	string
HEAD	string
MERGE	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

CloudError

Hibaválasz a Storage szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Hibaválasz a Storage szolgáltatástól.

CloudErrorBody

Hibaválasz a Storage szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
details	CloudErrorBody[]	A hibával kapcsolatos további részletek listája.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.
target	string	Az adott hiba célja. Például a hibás tulajdonság neve.

CorsRule

Cors-szabályt ad meg a Blob szolgáltatáshoz.

Name	Típus	Description
allowedHeaders	string[]	Kötelező, ha a CorsRule elem jelen van. Azoknak a fejléceknek a listája, amelyeket a forrásközi kérelem tartalmazhat.
allowedMethods	AllowedMethods[]	Kötelező, ha a CorsRule elem jelen van. A forrás által végrehajtható HTTP-metódusok listája.
allowedOrigins	string[]	Kötelező, ha a CorsRule elem jelen van. Azon forrástartományok listája, amelyek a CORS-on keresztül lesznek engedélyezve, vagy "*" az összes tartomány engedélyezéséhez
exposedHeaders	string[]	Kötelező, ha a CorsRule elem jelen van. A CORS-ügyfelek számára közzéteendő válaszfejlécek listája.
maxAgeInSeconds	integer	Kötelező, ha a CorsRule elem jelen van. Azon másodpercek száma, ahányszor az ügyfélnek/böngészőnek gyorsítótáraznia kell az elővizsgálati választ.

CorsRules

Beállítja a CORS-szabályokat. A kérelemben legfeljebb öt CorsRule-elem szerepelhet.

Name	Típus	Description
corsRules	CorsRule[]	A CORS-szabályok listája. A kérelemben legfeljebb öt CorsRule-elem szerepelhet.

DeleteRetentionPolicy

A helyreállítható törlés szolgáltatástulajdonságai.

Name	Típus	Description
allowPermanentDelete	boolean	Ez a tulajdonság igaz értékre állítva lehetővé teszi a helyreállíthatóan törölt blobverziók és pillanatképek törlését. Ez a tulajdonság nem használható blob-visszaállítási szabályzatra. Ez a tulajdonság csak a blobszolgáltatásra vonatkozik, és nem vonatkozik a tárolókra vagy fájlmegosztásokra.
days	integer	Azt jelzi, hogy hány napig kell megőrizni a törölt elemet. A minimálisan megadott érték lehet 1, a maximális érték pedig 365.
enabled	boolean	Azt jelzi, hogy a DeleteRetentionPolicy engedélyezve van-e.

FileServiceProperties

A Fájlszolgáltatások tulajdonságai a tárfiókban.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.cors	CorsRules	Cors-szabályokat ad meg a Fájlszolgáltatáshoz. A kérelemben legfeljebb öt CorsRule-elem szerepelhet. Ha a kérelemtörzs nem tartalmaz CorsRule-elemeket, az összes CORS-szabály törlődik, és a CORS le lesz tiltva a fájlszolgáltatásban.
properties.protocolSettings	ProtocolSettings	A fájlszolgáltatás protokollbeállításai
properties.shareDeleteRetentionPolicy	DeleteRetentionPolicy	A fájlszolgáltatás tulajdonságai a helyreállítható törlés megosztásához.
sku	Sku	Termékváltozat neve és szintje.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

FileServicesName

A fájlszolgáltatás neve a megadott tárfiókban. A fájlszolgáltatás nevének "alapértelmezettnek" kell lennie

Name	Típus	Description
default	string

Multichannel

Többcsatornás beállítás. Csak a Premium FileStorage szolgáltatásra vonatkozik.

Name	Típus	Description
enabled	boolean	Azt jelzi, hogy engedélyezve van-e a többcsatornás

ProtocolSettings

A fájlszolgáltatás protokollbeállításai

Name	Típus	Description
smb	SmbSetting	SMB-protokoll beállítása

Sku

A tárfiók termékváltozata.

Name	Típus	Description
name	SkuName	A termékváltozat neve. A fiók létrehozásához szükséges; nem kötelező a frissítéshez. Vegye figyelembe, hogy a régebbi verziókban a termékváltozat neve accountType volt.
tier	SkuTier	A termékváltozat szintje. Ez a termékváltozat neve alapján történik.

SkuName

A termékváltozat neve. A fiók létrehozásához szükséges; nem kötelező a frissítéshez. Vegye figyelembe, hogy a régebbi verziókban a termékváltozat neve accountType volt.

Name	Típus	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

A termékváltozat szintje. Ez a termékváltozat neve alapján történik.

Name	Típus	Description
Premium	string
Standard	string

SmbSetting

SMB-protokoll beállítása

Name	Típus	Description
authenticationMethods	string	A kiszolgáló által támogatott SMB-hitelesítési módszerek. Az érvényes értékek: NTLMv2, Kerberos. Sztringként kell átadni a(z) ";" elválasztó karakterrel.
channelEncryption	string	A kiszolgáló által támogatott SMB-csatornatitkosítás. Az érvényes értékek a következők: AES-128-CCM, AES-128-GCM, AES-256-GCM. Sztringként kell átadni a(z) ";" elválasztó karakterrel.
kerberosTicketEncryption	string	A Kiszolgáló által támogatott Kerberos-jegytitkosítás. Az érvényes értékek: RC4-HMAC, AES-256. Sztringként kell átadni a ";" elválasztójellel
multichannel	Multichannel	Többcsatornás beállítás. Csak a Premium FileStorage szolgáltatásra vonatkozik.
versions	string	A kiszolgáló által támogatott SMB protokollverziók. Az érvényes értékek: SMB2.1, SMB3.0, SMB3.1.1. Sztringként kell átadni a(z) ";" elválasztó karakterrel.