File Services - Get Service Properties

Service:

Storage Resource Provider

API Version:

2023-01-01

Ruft die Eigenschaften von Dateidiensten in Speicherkonten ab, einschließlich CORS-Regeln (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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Speicherkontos innerhalb der angegebenen Ressourcengruppe. Speicherkontonamen müssen zwischen 3 und 24 Zeichen lang sein und dürfen nur Zahlen und Kleinbuchstaben enthalten. Regex pattern: ^[a-z0-9]+$
FileServicesName	path	True	FileServicesName	Der Name des Dateidiensts innerhalb des angegebenen Speicherkontos. Der Dateidienstname muss "standard" sein.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe im Abonnement des Benutzers. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	FileServiceProperties	OK: Die Eigenschaften des Dateidiensts eines Speicherkontos wurden zurückgegeben.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
AllowedMethods	Erforderlich, wenn das CorsRule-Element vorhanden ist. Eine Liste der HTTP-Methoden, die vom Ursprung ausgeführt werden dürfen.
CloudError	Eine Fehlerantwort des Speicherdiensts.
CloudErrorBody	Eine Fehlerantwort des Speicherdiensts.
CorsRule	Gibt eine CORS-Regel für den Blob-Dienst an.
CorsRules	Legt die CORS-Regeln fest. Sie können bis zu fünf CorsRule-Elemente in die Anforderung einschließen.
DeleteRetentionPolicy	Die Diensteigenschaften für vorläufiges Löschen.
FileServiceProperties	Die Eigenschaften von Dateidiensten im Speicherkonto.
FileServicesName	Der Name des Dateidiensts innerhalb des angegebenen Speicherkontos. Der Dateidienstname muss "standard" sein.
Multichannel	Multichannel-Einstellung. Gilt nur für Premium FileStorage.
ProtocolSettings	Protokolleinstellungen für den Dateidienst
Sku	Die SKU des Speicherkontos.
SkuName	Der SKU-Name. Erforderlich für die Kontoerstellung; optional für das Update. Beachten Sie, dass in älteren Versionen der SKU-Name accountType genannt wurde.
SkuTier	Die SKU-Ebene. Dies basiert auf dem SKU-Namen.
SmbSetting	Einstellung für das SMB-Protokoll

AllowedMethods

Erforderlich, wenn das CorsRule-Element vorhanden ist. Eine Liste der HTTP-Methoden, die vom Ursprung ausgeführt werden dürfen.

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

CloudError

Eine Fehlerantwort des Speicherdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort des Speicherdiensts.

CloudErrorBody

Eine Fehlerantwort des Speicherdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des bestimmten Fehlers. Beispiel: Der Name der -Eigenschaft, die einen Fehler aufweist.

CorsRule

Gibt eine CORS-Regel für den Blob-Dienst an.

Name	Typ	Beschreibung
allowedHeaders	string[]	Erforderlich, wenn das CorsRule-Element vorhanden ist. Eine Liste von Headern, die Teil der ursprungsübergreifenden Anforderung sein dürfen.
allowedMethods	AllowedMethods[]	Erforderlich, wenn das CorsRule-Element vorhanden ist. Eine Liste der HTTP-Methoden, die vom Ursprung ausgeführt werden dürfen.
allowedOrigins	string[]	Erforderlich, wenn das CorsRule-Element vorhanden ist. Eine Liste der Ursprungsdomänen, die über CORS oder "*" zugelassen werden, um alle Domänen zuzulassen.
exposedHeaders	string[]	Erforderlich, wenn das CorsRule-Element vorhanden ist. Eine Liste der Antwortheader, die CORS-Clients zur Verfügung stellen sollen.
maxAgeInSeconds	integer	Erforderlich, wenn das CorsRule-Element vorhanden ist. Gibt an, wie viele Sekunden eine Preflight-Antwort vom Client/Browser zwischengespeichert werden soll.

CorsRules

Legt die CORS-Regeln fest. Sie können bis zu fünf CorsRule-Elemente in die Anforderung einschließen.

Name	Typ	Beschreibung
corsRules	CorsRule[]	Die Liste der CORS-Regeln. Sie können bis zu fünf CorsRule-Elemente in die Anforderung einschließen.

DeleteRetentionPolicy

Die Diensteigenschaften für vorläufiges Löschen.

Name	Typ	Beschreibung
allowPermanentDelete	boolean	Diese Eigenschaft, wenn sie auf true festgelegt ist, ermöglicht das Löschen der vorläufig gelöschten Blobversionen und Momentaufnahmen. Diese Eigenschaft kann nicht für die Blobwiederherstellung verwendet werden. Diese Eigenschaft gilt nur für den Blobdienst und gilt nicht für Container oder Dateifreigaben.
days	integer	Gibt die Anzahl der Tage an, für die das gelöschte Element aufbewahrt werden soll. Der angegebene Mindestwert kann 1 und der höchstwert 365 sein.
enabled	boolean	Gibt an, ob DeleteRetentionPolicy aktiviert ist.

FileServiceProperties

Die Eigenschaften von Dateidiensten im Speicherkonto.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.cors	CorsRules	Gibt CORS-Regeln für den Dateidienst an. Sie können bis zu fünf CorsRule-Elemente in die Anforderung einschließen. Wenn keine CorsRule-Elemente im Anforderungstext enthalten sind, werden alle CORS-Regeln gelöscht, und CORS wird für den Dateidienst deaktiviert.
properties.protocolSettings	ProtocolSettings	Protokolleinstellungen für den Dateidienst
properties.shareDeleteRetentionPolicy	DeleteRetentionPolicy	Die Dateidiensteigenschaften für das vorläufige Löschen von Freigaben.
sku	Sku	SKU-Name und -Ebene.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

FileServicesName

Der Name des Dateidiensts innerhalb des angegebenen Speicherkontos. Der Dateidienstname muss "standard" sein.

Name	Typ	Beschreibung
default	string

Multichannel

Multichannel-Einstellung. Gilt nur für Premium FileStorage.

Name	Typ	Beschreibung
enabled	boolean	Gibt an, ob Multichannel aktiviert ist.

ProtocolSettings

Protokolleinstellungen für den Dateidienst

Name	Typ	Beschreibung
smb	SmbSetting	Einstellung für das SMB-Protokoll

Sku

Die SKU des Speicherkontos.

Name	Typ	Beschreibung
name	SkuName	Der SKU-Name. Erforderlich für die Kontoerstellung; optional für das Update. Beachten Sie, dass in älteren Versionen der SKU-Name accountType genannt wurde.
tier	SkuTier	Die SKU-Ebene. Dies basiert auf dem SKU-Namen.

SkuName

Der SKU-Name. Erforderlich für die Kontoerstellung; optional für das Update. Beachten Sie, dass in älteren Versionen der SKU-Name accountType genannt wurde.

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

Die SKU-Ebene. Dies basiert auf dem SKU-Namen.

Name	Typ	Beschreibung
Premium	string
Standard	string

SmbSetting

Einstellung für das SMB-Protokoll

Name	Typ	Beschreibung
authenticationMethods	string	SMB-Authentifizierungsmethoden, die vom Server unterstützt werden. Gültige Werte sind NTLMv2, Kerberos. Sollte als Zeichenfolge mit dem Trennzeichen ";" übergeben werden.
channelEncryption	string	Vom Server unterstützte SMB-Kanalverschlüsselung. Gültige Werte sind AES-128-CCM, AES-128-GCM, AES-256-GCM. Sollte als Zeichenfolge mit dem Trennzeichen ";" übergeben werden.
kerberosTicketEncryption	string	Vom Server unterstützte Kerberos-Ticketverschlüsselung. Gültige Werte sind RC4-HMAC, AES-256. Sollte als Zeichenfolge mit dem Trennzeichen ";" übergeben werden.
multichannel	Multichannel	Multichannel-Einstellung. Gilt nur für Premium FileStorage.
versions	string	Vom Server unterstützte SMB-Protokollversionen. Gültige Werte sind SMB2.1, SMB3.0, SMB3.1.1. Sollte als Zeichenfolge mit dem Trennzeichen ";" übergeben werden.