File Services - Get Service Properties

Service:

Storage Resource Provider

API Version:

2023-01-01

Získá vlastnosti souborových služeb v účtech úložiště, včetně pravidel CORS (Sdílení prostředků mezi zdroji).

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string	Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena. Regex pattern: ^[a-z0-9]+$
FileServicesName	path	True	FileServicesName	Název souborové služby v rámci zadaného účtu úložiště. Název souborové služby musí být výchozí.
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	FileServiceProperties	OK – vrátil vlastnosti souborové služby účtu úložiště.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
AllowedMethods	Vyžaduje se, pokud existuje element CorsRule. Seznam metod HTTP, které mohou být spouštěné původem.
CloudError	Chybová odpověď ze služby Storage.
CloudErrorBody	Chybová odpověď ze služby Storage.
CorsRule	Určuje pravidlo CORS pro službu Blob Service.
CorsRules	Nastaví pravidla CORS. Do požadavku můžete zahrnout až pět prvků CorsRule.
DeleteRetentionPolicy	Vlastnosti služby pro obnovitelné odstranění
FileServiceProperties	Vlastnosti Souborové služby v účtu úložiště.
FileServicesName	Název souborové služby v rámci zadaného účtu úložiště. Název souborové služby musí být výchozí.
Multichannel	Nastavení vícekanálového nastavení. Platí pouze pro soubory úrovně PremiumÚložiště.
ProtocolSettings	Nastavení protokolu pro souborovou službu
Sku	Skladová položka účtu úložiště.
SkuName	Název skladové položky. Požadováno pro vytvoření účtu; volitelné pro aktualizaci. Všimněte si, že ve starších verzích se název skladové položky jmenoval accountType.
SkuTier	Úroveň skladové položky. Vychází z názvu skladové položky.
SmbSetting	Nastavení pro protokol SMB

AllowedMethods

Vyžaduje se, pokud existuje element CorsRule. Seznam metod HTTP, které mohou být spouštěné původem.

Name	Typ	Description
CONNECT	string
DELETE	string
GET	string
HEAD	string
MERGE	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

CloudError

Chybová odpověď ze služby Storage.

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď ze služby Storage.

CloudErrorBody

Chybová odpověď ze služby Storage.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
details	CloudErrorBody[]	Seznam dalších podrobností o chybě
message	string	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
target	string	Cíl konkrétní chyby. Například název vlastnosti v chybě.

CorsRule

Určuje pravidlo CORS pro službu Blob Service.

Name	Typ	Description
allowedHeaders	string[]	Vyžaduje se, pokud existuje element CorsRule. Seznam hlaviček, které mohou být součástí požadavku mezi zdroji.
allowedMethods	AllowedMethods[]	Vyžaduje se, pokud existuje element CorsRule. Seznam metod HTTP, které mohou být spouštěné původem.
allowedOrigins	string[]	Vyžaduje se, pokud existuje element CorsRule. Seznam počátečních domén, které budou povoleny prostřednictvím CORS, nebo *, aby byly povoleny všechny domény
exposedHeaders	string[]	Vyžaduje se, pokud existuje element CorsRule. Seznam hlaviček odpovědi, které se mají zpřístupnit klientům CORS.
maxAgeInSeconds	integer	Vyžaduje se, pokud existuje element CorsRule. Počet sekund, po který má klient nebo prohlížeč ukládat předběžnou odpověď do mezipaměti.

CorsRules

Nastaví pravidla CORS. Do požadavku můžete zahrnout až pět prvků CorsRule.

Name	Typ	Description
corsRules	CorsRule[]	Seznam pravidel CORS Do požadavku můžete zahrnout až pět prvků CorsRule.

DeleteRetentionPolicy

Vlastnosti služby pro obnovitelné odstranění

Name	Typ	Description
allowPermanentDelete	boolean	Tato vlastnost, pokud je nastavená na hodnotu true, umožňuje odstranění verzí a snímků obnovitelně odstraněných objektů blob. Tuto vlastnost nejde použít zásady obnovení objektů blob. Tato vlastnost se vztahuje pouze na službu Blob Service a nevztahuje se na kontejnery nebo sdílenou složku.
days	integer	Určuje počet dnů, po které by se odstraněná položka měla zachovat. Minimální zadaná hodnota může být 1 a maximální hodnota může být 365.
enabled	boolean	Určuje, jestli je povolená zásada DeleteRetentionPolicy.

FileServiceProperties

Vlastnosti Souborové služby v účtu úložiště.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name	string	Název prostředku
properties.cors	CorsRules	Určuje pravidla CORS pro službu File. Do požadavku můžete zahrnout až pět prvků CorsRule. Pokud text požadavku neobsahuje žádné prvky CorsRule, odstraní se všechna pravidla CORS a cors pro službu File se zakáže.
properties.protocolSettings	ProtocolSettings	Nastavení protokolu pro souborovou službu
properties.shareDeleteRetentionPolicy	DeleteRetentionPolicy	Vlastnosti souborové služby pro obnovitelné odstranění sdílené složky.
sku	Sku	Název a úroveň skladové položky.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

FileServicesName

Název souborové služby v rámci zadaného účtu úložiště. Název souborové služby musí být výchozí.

Name	Typ	Description
default	string

Multichannel

Nastavení vícekanálového nastavení. Platí pouze pro soubory úrovně PremiumÚložiště.

Name	Typ	Description
enabled	boolean	Označuje, jestli je povolený vícekanálový kanál.

ProtocolSettings

Nastavení protokolu pro souborovou službu

Name	Typ	Description
smb	SmbSetting	Nastavení pro protokol SMB

Sku

Skladová položka účtu úložiště.

Name	Typ	Description
name	SkuName	Název skladové položky. Požadováno pro vytvoření účtu; volitelné pro aktualizaci. Všimněte si, že ve starších verzích se název skladové položky jmenoval accountType.
tier	SkuTier	Úroveň skladové položky. Vychází z názvu skladové položky.

SkuName

Název skladové položky. Požadováno pro vytvoření účtu; volitelné pro aktualizaci. Všimněte si, že ve starších verzích se název skladové položky jmenoval accountType.

Name	Typ	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

Úroveň skladové položky. Vychází z názvu skladové položky.

Name	Typ	Description
Premium	string
Standard	string

SmbSetting

Nastavení pro protokol SMB

Name	Typ	Description
authenticationMethods	string	Metody ověřování SMB podporované serverem Platné hodnoty jsou NTLMv2, Kerberos. Měl by být předán jako řetězec s oddělovačem ';'.
channelEncryption	string	Šifrování kanálu SMB podporované serverem. Platné hodnoty jsou AES-128-CCM, AES-128-GCM, AES-256-GCM. Měl by být předán jako řetězec s oddělovačem ';'.
kerberosTicketEncryption	string	Šifrování lístku Kerberos podporované serverem Platné hodnoty jsou RC4-HMAC, AES-256. Měl by být předán jako řetězec s oddělovačem ;.
multichannel	Multichannel	Nastavení vícekanálového nastavení. Platí pouze pro soubory úrovně PremiumÚložiště.
versions	string	Verze protokolu SMB podporované serverem. Platné hodnoty jsou SMB2.1, SMB3.0, SMB3.1.1. Měl by být předán jako řetězec s oddělovačem ';'.