File Services - Get Service Properties

Service:

Storage Resource Provider

API Version:

2023-01-01

Obtient les propriétés des services de fichiers dans les comptes de stockage, y compris les règles CORS (Cross-Origin Resource Sharing).

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres. Regex pattern: ^[a-z0-9]+$
FileServicesName	path	True	FileServicesName	Nom du service de fichiers dans le compte de stockage spécifié. Nom du service de fichiers doit être « par défaut »
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	FileServiceProperties	OK : a retourné les propriétés du service De fichiers d’un compte de stockage.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
AllowedMethods	Obligatoire si l'élément CorsRule est présent. Liste des méthodes HTTP autorisées à être exécutées par l’origine.
CloudError	Réponse d’erreur du service Stockage.
CloudErrorBody	Réponse d’erreur du service Stockage.
CorsRule	Spécifie une règle CORS pour le service BLOB.
CorsRules	Définit les règles CORS. Incluez jusqu'à cinq éléments CorsRule dans la requête.
DeleteRetentionPolicy	Propriétés de service pour la suppression réversible.
FileServiceProperties	Propriétés des services de fichiers dans le compte de stockage.
FileServicesName	Nom du service de fichiers dans le compte de stockage spécifié. Nom du service de fichiers doit être « par défaut »
Multichannel	Paramètre multicanal. S’applique uniquement à Premium FileStorage.
ProtocolSettings	Paramètres de protocole pour le service de fichiers
Sku	Référence SKU du compte de stockage.
SkuName	Le nom du SKU. Obligatoire pour la création de compte ; facultatif pour la mise à jour. Notez que dans les versions antérieures, le nom de la référence SKU était appelé accountType.
SkuTier	Niveau de référence SKU. Cela est basé sur le nom de la référence SKU.
SmbSetting	Paramètre pour le protocole SMB

AllowedMethods

Obligatoire si l'élément CorsRule est présent. Liste des méthodes HTTP autorisées à être exécutées par l’origine.

Nom	Type	Description
CONNECT	string
DELETE	string
GET	string
HEAD	string
MERGE	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

CloudError

Réponse d’erreur du service Stockage.

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur du service Stockage.

CloudErrorBody

Réponse d’erreur du service Stockage.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
details	CloudErrorBody[]	Liste de détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

CorsRule

Spécifie une règle CORS pour le service BLOB.

Nom	Type	Description
allowedHeaders	string[]	Obligatoire si l'élément CorsRule est présent. Liste d’en-têtes autorisés à faire partie de la demande d’origine croisée.
allowedMethods	AllowedMethods[]	Obligatoire si l'élément CorsRule est présent. Liste des méthodes HTTP autorisées à être exécutées par l’origine.
allowedOrigins	string[]	Obligatoire si l'élément CorsRule est présent. Liste des domaines d’origine qui seront autorisés via CORS, ou « * » pour autoriser tous les domaines
exposedHeaders	string[]	Obligatoire si l'élément CorsRule est présent. Liste d’en-têtes de réponse à exposer aux clients CORS.
maxAgeInSeconds	integer	Obligatoire si l'élément CorsRule est présent. Nombre de secondes pendant lesquelles le client/navigateur doit mettre en cache une réponse préliminaire.

CorsRules

Définit les règles CORS. Incluez jusqu'à cinq éléments CorsRule dans la requête.

Nom	Type	Description
corsRules	CorsRule[]	Liste des règles CORS. Incluez jusqu'à cinq éléments CorsRule dans la requête.

DeleteRetentionPolicy

Propriétés de service pour la suppression réversible.

Nom	Type	Description
allowPermanentDelete	boolean	Cette propriété, lorsqu’elle est définie sur true, permet la suppression des versions et des instantanés d’objets blob supprimés de manière réversible. Cette propriété ne peut pas être utilisée stratégie de restauration d’objets blob. Cette propriété s’applique uniquement au service blob et ne s’applique pas aux conteneurs ou aux partages de fichiers.
days	integer	Indique le nombre de jours pendant lesquels l’élément supprimé doit être conservé. La valeur minimale spécifiée peut être 1 et la valeur maximale peut être 365.
enabled	boolean	Indique si DeleteRetentionPolicy est activé.

FileServiceProperties

Propriétés des services de fichiers dans le compte de stockage.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.cors	CorsRules	Spécifie les règles CORS pour le service De fichiers. Incluez jusqu'à cinq éléments CorsRule dans la requête. Si aucun élément CorsRule n’est inclus dans le corps de la requête, toutes les règles CORS sont supprimées et CORS sont désactivées pour le service De fichiers.
properties.protocolSettings	ProtocolSettings	Paramètres de protocole pour le service de fichiers
properties.shareDeleteRetentionPolicy	DeleteRetentionPolicy	Propriétés du service de fichiers pour la suppression réversible de partage.
sku	Sku	Nom et niveau de la référence SKU.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

FileServicesName

Nom du service de fichiers dans le compte de stockage spécifié. Nom du service de fichiers doit être « par défaut »

Nom	Type	Description
default	string

Multichannel

Paramètre multicanal. S’applique uniquement à Premium FileStorage.

Nom	Type	Description
enabled	boolean	Indique si le multicanal est activé

ProtocolSettings

Paramètres de protocole pour le service de fichiers

Nom	Type	Description
smb	SmbSetting	Paramètre pour le protocole SMB

Sku

Référence SKU du compte de stockage.

Nom	Type	Description
name	SkuName	Le nom du SKU. Obligatoire pour la création de compte ; facultatif pour la mise à jour. Notez que dans les versions antérieures, le nom de la référence SKU était appelé accountType.
tier	SkuTier	Niveau de référence SKU. Cela est basé sur le nom de la référence SKU.

SkuName

Le nom du SKU. Obligatoire pour la création de compte ; facultatif pour la mise à jour. Notez que dans les versions antérieures, le nom de la référence SKU était appelé accountType.

Nom	Type	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

Niveau de référence SKU. Cela est basé sur le nom de la référence SKU.

Nom	Type	Description
Premium	string
Standard	string

SmbSetting

Paramètre pour le protocole SMB

Nom	Type	Description
authenticationMethods	string	Méthodes d’authentification SMB prises en charge par le serveur. Les valeurs valides sont NTLMv2, Kerberos. Doit être passé sous forme de chaîne avec le délimiteur ' ;'.
channelEncryption	string	Chiffrement de canal SMB pris en charge par le serveur. Les valeurs valides sont AES-128-CCM, AES-128-GCM, AES-256-GCM. Doit être passé sous forme de chaîne avec le délimiteur ' ;'.
kerberosTicketEncryption	string	Chiffrement de ticket Kerberos pris en charge par le serveur. Les valeurs valides sont RC4-HMAC, AES-256. Doit être passé sous forme de chaîne avec le délimiteur « ; »
multichannel	Multichannel	Paramètre multicanal. S’applique uniquement à Premium FileStorage.
versions	string	Versions du protocole SMB prises en charge par le serveur. Les valeurs valides sont SMB2.1, SMB3.0, SMB3.1.1. Doit être passé sous forme de chaîne avec le délimiteur ' ;'.