File Services - Get Service Properties

Service:

Storage Resource Provider

API Version:

2023-01-01

Pobiera właściwości usług plików na kontach magazynu, w tym reguły CORS (współużytkowanie zasobów między źródłami).

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string	Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery. Regex pattern: ^[a-z0-9]+$
FileServicesName	path	True	FileServicesName	Nazwa usługi plików w ramach określonego konta magazynu. Nazwa usługi plików musi być "domyślna"
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	FileServiceProperties	OK — zwrócił właściwości usługi plików konta magazynu.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
AllowedMethods	Wymagane, jeśli element CorsRule jest obecny. Lista metod HTTP, które mogą być wykonywane przez źródło.
CloudError	Odpowiedź na błąd z usługi Storage.
CloudErrorBody	Odpowiedź na błąd z usługi Storage.
CorsRule	Określa regułę CORS dla usługi Blob Service.
CorsRules	Ustawia reguły CORS. W żądaniu można uwzględnić maksymalnie pięć elementów CorsRule.
DeleteRetentionPolicy	Właściwości usługi usuwania nietrwałego.
FileServiceProperties	Właściwości usług plików na koncie magazynu.
FileServicesName	Nazwa usługi plików w ramach określonego konta magazynu. Nazwa usługi plików musi być "domyślna"
Multichannel	Ustawienie wielokanałowe. Dotyczy tylko usługi FileStorage w warstwie Premium.
ProtocolSettings	Ustawienia protokołu dla usługi plików
Sku	Jednostka SKU konta magazynu.
SkuName	Nazwa jednostki SKU. Wymagane do utworzenia konta; opcjonalnie do aktualizacji. Pamiętaj, że w starszych wersjach nazwa jednostki SKU nosiła nazwę accountType.
SkuTier	Warstwa jednostki SKU. Jest to oparte na nazwie jednostki SKU.
SmbSetting	Ustawienie protokołu SMB

AllowedMethods

Wymagane, jeśli element CorsRule jest obecny. Lista metod HTTP, które mogą być wykonywane przez źródło.

Nazwa	Typ	Opis
CONNECT	string
DELETE	string
GET	string
HEAD	string
MERGE	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

CloudError

Odpowiedź na błąd z usługi Storage.

Nazwa	Typ	Opis
error	CloudErrorBody	Odpowiedź na błąd z usługi Storage.

CloudErrorBody

Odpowiedź na błąd z usługi Storage.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
details	CloudErrorBody[]	Lista dodatkowych szczegółów dotyczących błędu.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
target	string	Element docelowy określonego błędu. Na przykład nazwa właściwości w błędzie.

CorsRule

Określa regułę CORS dla usługi Blob Service.

Nazwa	Typ	Opis
allowedHeaders	string[]	Wymagane, jeśli element CorsRule jest obecny. Lista nagłówków, które mogą być częścią żądania między źródłami.
allowedMethods	AllowedMethods[]	Wymagane, jeśli element CorsRule jest obecny. Lista metod HTTP, które mogą być wykonywane przez źródło.
allowedOrigins	string[]	Wymagane, jeśli element CorsRule jest obecny. Lista domen pochodzenia, które będą dozwolone za pośrednictwem mechanizmu CORS lub "*", aby zezwolić na wszystkie domeny
exposedHeaders	string[]	Wymagane, jeśli element CorsRule jest obecny. Lista nagłówków odpowiedzi, które mają być widoczne dla klientów MECHANIZMU CORS.
maxAgeInSeconds	integer	Wymagane, jeśli element CorsRule jest obecny. Liczba sekund buforowania odpowiedzi wstępnej przez klienta/przeglądarkę.

CorsRules

Ustawia reguły CORS. W żądaniu można uwzględnić maksymalnie pięć elementów CorsRule.

Nazwa	Typ	Opis
corsRules	CorsRule[]	Lista reguł CORS. W żądaniu można uwzględnić maksymalnie pięć elementów CorsRule.

DeleteRetentionPolicy

Właściwości usługi usuwania nietrwałego.

Nazwa	Typ	Opis
allowPermanentDelete	boolean	Ta właściwość po ustawieniu wartości true umożliwia usunięcie nietrwale usuniętych wersji obiektów blob i migawek. Tej właściwości nie można używać zasad przywracania obiektów blob. Ta właściwość dotyczy tylko usługi blob i nie dotyczy kontenerów ani udziału plików.
days	integer	Wskazuje liczbę dni przechowywania usuniętego elementu. Minimalna określona wartość może wynosić 1, a maksymalna wartość to 365.
enabled	boolean	Wskazuje, czy opcja DeleteRetentionPolicy jest włączona.

FileServiceProperties

Właściwości usług plików na koncie magazynu.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.cors	CorsRules	Określa reguły CORS dla usługi plików. W żądaniu można uwzględnić maksymalnie pięć elementów CorsRule. Jeśli żadne elementy corsRule nie zostaną uwzględnione w treści żądania, wszystkie reguły CORS zostaną usunięte, a mechanizm CORS zostanie wyłączony dla usługi plików.
properties.protocolSettings	ProtocolSettings	Ustawienia protokołu dla usługi plików
properties.shareDeleteRetentionPolicy	DeleteRetentionPolicy	Właściwości usługi plików do usuwania nietrwałego udziału.
sku	Sku	Nazwa i warstwa jednostki SKU.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

FileServicesName

Nazwa usługi plików w ramach określonego konta magazynu. Nazwa usługi plików musi być "domyślna"

Nazwa	Typ	Opis
default	string

Multichannel

Ustawienie wielokanałowe. Dotyczy tylko usługi FileStorage w warstwie Premium.

Nazwa	Typ	Opis
enabled	boolean	Wskazuje, czy włączono obsługę wielu kanałów

ProtocolSettings

Ustawienia protokołu dla usługi plików

Nazwa	Typ	Opis
smb	SmbSetting	Ustawienie protokołu SMB

Sku

Jednostka SKU konta magazynu.

Nazwa	Typ	Opis
name	SkuName	Nazwa jednostki SKU. Wymagane do utworzenia konta; opcjonalnie do aktualizacji. Pamiętaj, że w starszych wersjach nazwa jednostki SKU nosiła nazwę accountType.
tier	SkuTier	Warstwa jednostki SKU. Jest to oparte na nazwie jednostki SKU.

SkuName

Nazwa jednostki SKU. Wymagane do utworzenia konta; opcjonalnie do aktualizacji. Pamiętaj, że w starszych wersjach nazwa jednostki SKU nosiła nazwę accountType.

Nazwa	Typ	Opis
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

Warstwa jednostki SKU. Jest to oparte na nazwie jednostki SKU.

Nazwa	Typ	Opis
Premium	string
Standard	string

SmbSetting

Ustawienie protokołu SMB

Nazwa	Typ	Opis
authenticationMethods	string	Metody uwierzytelniania SMB obsługiwane przez serwer. Prawidłowe wartości to NTLMv2, Kerberos. Należy przekazać jako ciąg z ogranicznikiem ";".
channelEncryption	string	Szyfrowanie kanału SMB obsługiwane przez serwer. Prawidłowe wartości to AES-128-CCM, AES-128-GCM, AES-256-GCM. Należy przekazać jako ciąg z ogranicznikiem ";".
kerberosTicketEncryption	string	Szyfrowanie biletu Protokołu Kerberos obsługiwane przez serwer. Prawidłowe wartości to RC4-HMAC, AES-256. Należy przekazać jako ciąg z ogranicznikiem ";"
multichannel	Multichannel	Ustawienie wielokanałowe. Dotyczy tylko usługi FileStorage w warstwie Premium.
versions	string	Wersje protokołu SMB obsługiwane przez serwer. Prawidłowe wartości to SMB2.1, SMB3.0, SMB3.1.1. Należy przekazać jako ciąg z ogranicznikiem ";".