File Shares - Get

Dienst:: Storage Resource Provider

API-Version:: 2025-06-01

Ruft die Eigenschaften einer angegebenen Freigabe ab.

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

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2025-06-01&$expand={$expand}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	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.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
shareName	path	True	string minLength: 3 maxLength: 63	Der Name der Dateifreigabe innerhalb des angegebenen Speicherkontos. Dateifreigabenamen müssen zwischen 3 und 63 Zeichen lang sein und dürfen nur Zahlen, Kleinbuchstaben und Bindestriche (-) enthalten. Jedem Bindestrich (-) muss unmittelbar ein Buchstabe oder eine Zahl vorangestellt und gefolgt werden.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
$expand	query		string	Optional, wird verwendet, um die Eigenschaften in den Eigenschaften der Freigabe zu erweitern. Gültige Werte sind: stats. Sollte als Zeichenfolge mit Trennzeichen ',' übergeben werden.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-snapshot		string	Optional, wird zum Abrufen von Eigenschaften eines Snapshots verwendet.

Antworten

Name	Typ	Beschreibung
200 OK	FileShare	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

GetSharePaidBursting

GetShareProvisionedV2

GetShares

GetShareStats

GetSharePaidBursting

Beispielanforderung

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2025-06-01


/**
 * Samples for FileShares Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_PaidBursting.
     * json
     */
    /**
     * Sample code: GetSharePaidBursting.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getSharePaidBursting(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileShares().getWithResponse("res9871", "sto6217",
            "share1634", null, null, 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python file_shares_get_paid_bursting.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_shares.get(
        resource_group_name="res9871",
        account_name="sto6217",
        share_name="share1634",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_PaidBursting.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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4e9df3afd38a1cfa00a5d49419dce51bd014601f/specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_PaidBursting.json
func ExampleFileSharesClient_Get_getSharePaidBursting() {
	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.NewFileSharesClient().Get(ctx, "res9871", "sto6217", "share1634", &armstorage.FileSharesClientGetOptions{Expand: nil,
		XMSSnapshot: 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.FileShare = armstorage.FileShare{
	// 	Name: to.Ptr("share1634"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/shares"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634"),
	// 	Etag: to.Ptr("\"0x8D592D74CC20EBA\""),
	// 	FileShareProperties: &armstorage.FileShareProperties{
	// 		FileSharePaidBursting: &armstorage.FileSharePropertiesFileSharePaidBursting{
	// 			PaidBurstingEnabled: to.Ptr(true),
	// 			PaidBurstingMaxBandwidthMibps: to.Ptr[int32](10340),
	// 			PaidBurstingMaxIops: to.Ptr[int32](102400),
	// 		},
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-05-26T05:06:14.000Z"); return t}()),
	// 		ShareQuota: to.Ptr[int32](1024),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets properties of a specified share.
 *
 * @summary Gets properties of a specified share.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_PaidBursting.json
 */
async function getSharePaidBursting() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9871";
  const accountName = "sto6217";
  const shareName = "share1634";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileShares.get(resourceGroupName, accountName, shareName);
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_PaidBursting.json
// this example is just showing the usage of "FileShares_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FileServiceResource created on azure
// for more information of creating FileServiceResource, please refer to the document of FileServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res9871";
string accountName = "sto6217";
ResourceIdentifier fileServiceResourceId = FileServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
FileServiceResource fileService = client.GetFileServiceResource(fileServiceResourceId);

// get the collection of this FileShareResource
FileShareCollection collection = fileService.GetFileShares();

// invoke the operation
string shareName = "share1634";
NullableResponse<FileShareResource> response = await collection.GetIfExistsAsync(shareName);
FileShareResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FileShareData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "properties": {
    "fileSharePaidBursting": {
      "paidBurstingEnabled": true,
      "paidBurstingMaxBandwidthMibps": 10340,
      "paidBurstingMaxIops": 102400
    },
    "lastModifiedTime": "2019-05-26T05:06:14Z",
    "shareQuota": 1024
  }
}

GetShareProvisionedV2

Beispielanforderung

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2025-06-01


/**
 * Samples for FileShares Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_ProvisionedV2.
     * json
     */
    /**
     * Sample code: GetShareProvisionedV2.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getShareProvisionedV2(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileShares().getWithResponse("res9871", "sto6217",
            "share1634", null, null, 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python file_shares_get_provisioned_v2.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_shares.get(
        resource_group_name="res9871",
        account_name="sto6217",
        share_name="share1634",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_ProvisionedV2.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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4e9df3afd38a1cfa00a5d49419dce51bd014601f/specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_ProvisionedV2.json
func ExampleFileSharesClient_Get_getShareProvisionedV2() {
	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.NewFileSharesClient().Get(ctx, "res9871", "sto6217", "share1634", &armstorage.FileSharesClientGetOptions{Expand: nil,
		XMSSnapshot: 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.FileShare = armstorage.FileShare{
	// 	Name: to.Ptr("share1634"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/shares"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634"),
	// 	Etag: to.Ptr("\"0x8D592D74CC20EBA\""),
	// 	FileShareProperties: &armstorage.FileShareProperties{
	// 		IncludedBurstIops: to.Ptr[int32](15000),
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-10-25T01:50:50.000Z"); return t}()),
	// 		MaxBurstCreditsForIops: to.Ptr[int64](36000000),
	// 		NextAllowedProvisionedBandwidthDowngradeTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2024-10-25T01:48:09.000Z"); return t}()),
	// 		NextAllowedProvisionedIopsDowngradeTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2024-10-25T01:48:09.000Z"); return t}()),
	// 		NextAllowedQuotaDowngradeTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC1123, "2024-10-26T01:50:50.000Z"); return t}()),
	// 		ProvisionedBandwidthMibps: to.Ptr[int32](200),
	// 		ProvisionedIops: to.Ptr[int32](5000),
	// 		ShareQuota: to.Ptr[int32](100),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets properties of a specified share.
 *
 * @summary Gets properties of a specified share.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_ProvisionedV2.json
 */
async function getShareProvisionedV2() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9871";
  const accountName = "sto6217";
  const shareName = "share1634";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileShares.get(resourceGroupName, accountName, shareName);
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_ProvisionedV2.json
// this example is just showing the usage of "FileShares_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FileServiceResource created on azure
// for more information of creating FileServiceResource, please refer to the document of FileServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res9871";
string accountName = "sto6217";
ResourceIdentifier fileServiceResourceId = FileServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
FileServiceResource fileService = client.GetFileServiceResource(fileServiceResourceId);

// get the collection of this FileShareResource
FileShareCollection collection = fileService.GetFileShares();

// invoke the operation
string shareName = "share1634";
NullableResponse<FileShareResource> response = await collection.GetIfExistsAsync(shareName);
FileShareResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FileShareData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "properties": {
    "includedBurstIops": 15000,
    "lastModifiedTime": "2024-10-25T01:50:50.0000000Z",
    "maxBurstCreditsForIops": 36000000,
    "nextAllowedProvisionedBandwidthDowngradeTime": "Fri, 25 Oct 2024 01:48:09 GMT",
    "nextAllowedProvisionedIopsDowngradeTime": "Fri, 25 Oct 2024 01:48:09 GMT",
    "nextAllowedQuotaDowngradeTime": "Sat, 26 Oct 2024 01:50:50 GMT",
    "provisionedBandwidthMibps": 200,
    "provisionedIops": 5000,
    "shareQuota": 100
  }
}

GetShares

Beispielanforderung

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2025-06-01


/**
 * Samples for FileShares Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet.json
     */
    /**
     * Sample code: GetShares.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getShares(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileShares().getWithResponse("res9871", "sto6217",
            "share1634", null, null, 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python file_shares_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_shares.get(
        resource_group_name="res9871",
        account_name="sto6217",
        share_name="share1634",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet.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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4e9df3afd38a1cfa00a5d49419dce51bd014601f/specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet.json
func ExampleFileSharesClient_Get_getShares() {
	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.NewFileSharesClient().Get(ctx, "res9871", "sto6217", "share1634", &armstorage.FileSharesClientGetOptions{Expand: nil,
		XMSSnapshot: 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.FileShare = armstorage.FileShare{
	// 	Name: to.Ptr("share1634"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/shares"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634"),
	// 	Etag: to.Ptr("\"0x8D592D74CC20EBA\""),
	// 	FileShareProperties: &armstorage.FileShareProperties{
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-05-26T05:06:14.000Z"); return t}()),
	// 		ShareQuota: to.Ptr[int32](1024),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets properties of a specified share.
 *
 * @summary Gets properties of a specified share.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet.json
 */
async function getShares() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9871";
  const accountName = "sto6217";
  const shareName = "share1634";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileShares.get(resourceGroupName, accountName, shareName);
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet.json
// this example is just showing the usage of "FileShares_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FileServiceResource created on azure
// for more information of creating FileServiceResource, please refer to the document of FileServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res9871";
string accountName = "sto6217";
ResourceIdentifier fileServiceResourceId = FileServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
FileServiceResource fileService = client.GetFileServiceResource(fileServiceResourceId);

// get the collection of this FileShareResource
FileShareCollection collection = fileService.GetFileShares();

// invoke the operation
string shareName = "share1634";
NullableResponse<FileShareResource> response = await collection.GetIfExistsAsync(shareName);
FileShareResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FileShareData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "properties": {
    "lastModifiedTime": "2019-05-26T05:06:14Z",
    "shareQuota": 1024
  }
}

GetShareStats

Beispielanforderung

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2025-06-01&$expand=stats


/**
 * Samples for FileShares Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_Stats.json
     */
    /**
     * Sample code: GetShareStats.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getShareStats(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileShares().getWithResponse("res9871", "sto6217",
            "share1634", "stats", null, 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python file_shares_get_stats.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_shares.get(
        resource_group_name="res9871",
        account_name="sto6217",
        share_name="share1634",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_Stats.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

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4e9df3afd38a1cfa00a5d49419dce51bd014601f/specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_Stats.json
func ExampleFileSharesClient_Get_getShareStats() {
	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.NewFileSharesClient().Get(ctx, "res9871", "sto6217", "share1634", &armstorage.FileSharesClientGetOptions{Expand: to.Ptr("stats"),
		XMSSnapshot: 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.FileShare = armstorage.FileShare{
	// 	Name: to.Ptr("share1634"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices/shares"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634"),
	// 	Etag: to.Ptr("\"0x8D592D74CC20EBA\""),
	// 	FileShareProperties: &armstorage.FileShareProperties{
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-05-26T05:06:14.000Z"); return t}()),
	// 		ShareQuota: to.Ptr[int32](1024),
	// 		ShareUsageBytes: to.Ptr[int64](652945),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets properties of a specified share.
 *
 * @summary Gets properties of a specified share.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_Stats.json
 */
async function getShareStats() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9871";
  const accountName = "sto6217";
  const shareName = "share1634";
  const expand = "stats";
  const options = { expand };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileShares.get(resourceGroupName, accountName, shareName, options);
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2025-06-01/examples/FileSharesGet_Stats.json
// this example is just showing the usage of "FileShares_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FileServiceResource created on azure
// for more information of creating FileServiceResource, please refer to the document of FileServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res9871";
string accountName = "sto6217";
ResourceIdentifier fileServiceResourceId = FileServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
FileServiceResource fileService = client.GetFileServiceResource(fileServiceResourceId);

// get the collection of this FileShareResource
FileShareCollection collection = fileService.GetFileShares();

// invoke the operation
string shareName = "share1634";
string expand = "stats";
NullableResponse<FileShareResource> response = await collection.GetIfExistsAsync(shareName, expand: expand);
FileShareResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    FileShareData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "properties": {
    "lastModifiedTime": "2019-05-26T05:06:14Z",
    "shareQuota": 1024,
    "shareUsageBytes": 652945
  }
}

Definitionen

Name	Beschreibung
AccessPolicy
CloudError	Eine Fehlerantwort des Speicherdiensts.
CloudErrorBody	Eine Fehlerantwort des Speicherdiensts.
EnabledProtocols	Das Authentifizierungsprotokoll, das für die Dateifreigabe verwendet wird. Kann nur beim Erstellen einer Freigabe angegeben werden.
FileShare	Eigenschaften der Dateifreigabe, einschließlich ID, Ressourcenname, Ressourcentyp, Etag.
FileSharePropertiesFileSharePaidBursting	Eigenschaften für "Kostenpflichtige Platzierung" für Dateifreigaben.
LeaseDuration	Gibt an, ob die Lease für einen Container nur dann von unendlicher oder fester Dauer ist, wenn der Container geleast wird.
LeaseState	Leasestatus des Containers.
LeaseStatus	Der Lease-Status des Containers.
RootSquashType	Die Eigenschaft ist nur für NFS-Freigabe vorgesehen. Der Standardwert ist NoRootSquash.
ShareAccessTier	Zugriffsebene für bestimmte Freigaben. GpV2-Konto kann zwischen TransactionOptimized (Standard), Hot und Cool wählen. FileStorage-Konto kann Premium auswählen.
SignedIdentifier

AccessPolicy

Objekt

Name	Typ	Beschreibung
expiryTime	string (date-time)	Ablaufzeit der Zugriffsrichtlinie
permission	string	Liste der abgekürzten Berechtigungen.
startTime	string (date-time)	Startzeit der Zugriffsrichtlinie

CloudError

Objekt

Eine Fehlerantwort des Speicherdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort des Speicherdiensts.

CloudErrorBody

Objekt

Eine Fehlerantwort des Speicherdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

EnabledProtocols

Enumeration

Das Authentifizierungsprotokoll, das für die Dateifreigabe verwendet wird. Kann nur beim Erstellen einer Freigabe angegeben werden.

Wert	Beschreibung
SMB
NFS

FileShare

Objekt

Eigenschaften der Dateifreigabe, einschließlich ID, Ressourcenname, Ressourcentyp, Etag.

Name	Typ	Beschreibung
etag	string	Ressourcen-Etag.
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Zum Beispiel - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.accessTier	ShareAccessTier	Zugriffsebene für bestimmte Freigaben. GpV2-Konto kann zwischen TransactionOptimized (Standard), Hot und Cool wählen. FileStorage-Konto kann Premium auswählen.
properties.accessTierChangeTime	string (date-time)	Gibt den Zeitpunkt der letzten Änderung für die Freigabezugriffsebene an.
properties.accessTierStatus	string	Gibt an, ob ein Übergang für die Zugriffsebene aussteht.
properties.deleted	boolean	Gibt an, ob die Freigabe gelöscht wurde.
properties.deletedTime	string (date-time)	Der Zeitpunkt des Löschens, wenn die Freigabe gelöscht wurde.
properties.enabledProtocols	EnabledProtocols	Das Authentifizierungsprotokoll, das für die Dateifreigabe verwendet wird. Kann nur beim Erstellen einer Freigabe angegeben werden.
properties.fileSharePaidBursting	FileSharePropertiesFileSharePaidBursting	Eigenschaften für "Kostenpflichtige Platzierung" für Dateifreigaben.
properties.includedBurstIops	integer (int32)	Die berechneten Burst-IOPS der Freigabe. Diese Eigenschaft ist nur für Dateifreigaben vorgesehen, die unter dem Kontotyp "Files Provisioned v2" erstellt wurden.
properties.lastModifiedTime	string (date-time)	Gibt das Datum und die Uhrzeit der letzten Änderung der Freigabe zurück.
properties.leaseDuration	LeaseDuration	Gibt an, ob die Lease für eine Freigabe nur dann von unendlicher oder fester Dauer ist, wenn die Freigabe geleast ist.
properties.leaseState	LeaseState	Leasingstatus der Aktie.
properties.leaseStatus	LeaseStatus	Der Leasingstatus der Aktie.
properties.maxBurstCreditsForIops	integer (int64)	Die berechneten maximalen Burst-Gutschriften für die Freigabe. Diese Eigenschaft ist nur für Dateifreigaben vorgesehen, die unter dem Kontotyp "Files Provisioned v2" erstellt wurden.
properties.metadata	object	Ein Name-Wert-Paar, das der Freigabe als Metadaten zugeordnet werden soll.
properties.nextAllowedProvisionedBandwidthDowngradeTime	string (date-time-rfc7231)	Gibt die nächste zulässige Zeit für das Downgrade der bereitgestellten Bandbreite für die Freigabe zurück. Diese Eigenschaft ist nur für Dateifreigaben vorgesehen, die unter dem Kontotyp "Files Provisioned v2" erstellt wurden.
properties.nextAllowedProvisionedIopsDowngradeTime	string (date-time-rfc7231)	Gibt die nächste zulässige Zeit für das bereitgestellte IOPS-Downgrade für die Freigabe zurück. Diese Eigenschaft ist nur für Dateifreigaben vorgesehen, die unter dem Kontotyp "Files Provisioned v2" erstellt wurden.
properties.nextAllowedQuotaDowngradeTime	string (date-time-rfc7231)	Gibt die nächste zulässige Zeit für das Downgrade der bereitgestellten Speichergröße für die Freigabe zurück. Diese Eigenschaft gilt nur für Dateifreigaben, die unter dem Kontotyp "Files Provisioned v1 SSD" und "Files Provisioned v2" erstellt wurden
properties.provisionedBandwidthMibps	integer (int32)	Die bereitgestellte Bandbreite der Freigabe in mebibytes pro Sekunde. Diese Eigenschaft ist nur für Dateifreigaben vorgesehen, die unter dem Kontotyp "Files Provisioned v2" erstellt wurden. Bitte lesen Sie die GetFileServiceUsage-API-Antwort für den minimalen und maximal zulässigen Wert für die bereitgestellte Bandbreite.
properties.provisionedIops	integer (int32)	Die bereitgestellten IOPS der Freigabe. Diese Eigenschaft ist nur für Dateifreigaben vorgesehen, die unter dem Kontotyp "Files Provisioned v2" erstellt wurden. Bitte lesen Sie die GetFileServiceUsage-API-Antwort für den minimalen und maximal zulässigen Wert für bereitgestellte IOPS.
properties.remainingRetentionDays	integer (int32)	Verbleibende Aufbewahrungstage für Freigaben, die vorläufig gelöscht wurden.
properties.rootSquash	RootSquashType	Die Eigenschaft ist nur für NFS-Freigabe vorgesehen. Der Standardwert ist NoRootSquash.
properties.shareQuota	integer (int32)	Die bereitgestellte Größe des Anteils in gibibytes. Muss größer als 0 und kleiner oder gleich 5 TB (5120) sein. Bei großen Dateifreigaben beträgt die maximale Größe 102400. Informationen zu Dateifreigaben, die unter dem Kontotyp "Files Provisioned v2" erstellt wurden, finden Sie in der GetFileServiceUsage-API-Antwort für die minimale und maximal zulässige bereitgestellte Speichergröße.
properties.shareUsageBytes	integer (int64)	Die ungefähre Größe der Daten, die auf der Freigabe gespeichert sind. Beachten Sie, dass dieser Wert möglicherweise nicht alle kürzlich erstellten Dateien oder Dateien umfasst, deren Größe kürzlich geändert wurde.
properties.signedIdentifiers	SignedIdentifier[]	Liste der auf der Freigabe angegebenen gespeicherten Zugriffsrichtlinien.
properties.snapshotTime	string (date-time)	Erstellungszeit des Freigabe-Snapshots, der in der Antwort von Listenfreigaben mit dem expand-Parameter "snapshots" zurückgegeben wird.
properties.version	string	Die Version der Freigabe.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

FileSharePropertiesFileSharePaidBursting

Objekt

Eigenschaften für "Kostenpflichtige Platzierung" für Dateifreigaben.

Name	Typ	Beschreibung
paidBurstingEnabled	boolean	Gibt an, ob kostenpflichtiges Bursting für die Freigabe aktiviert ist. Diese Eigenschaft gilt nur für Dateifreigaben, die unter dem Ssd-Kontotyp "Files Provisioned v1" erstellt wurden.
paidBurstingMaxBandwidthMibps	integer (int32)	Die maximale bezahlte Platzbandbreite für den Anteil pro Sekunde in Mebibytes. Diese Eigenschaft gilt nur für Dateifreigaben, die unter dem Ssd-Kontotyp "Files Provisioned v1" erstellt wurden. Der maximal zulässige Wert ist 10340, was die maximale zulässige Bandbreite für eine Freigabe ist.
paidBurstingMaxIops	integer (int32)	Die maximal bezahlten IOPS für die Aktie. Diese Eigenschaft gilt nur für Dateifreigaben, die unter dem Ssd-Kontotyp "Files Provisioned v1" erstellt wurden. Der maximal zulässige Wert ist 102400, was die maximal zulässigen IOPS für eine Freigabe ist.

LeaseDuration

Enumeration

Gibt an, ob die Lease für einen Container nur dann von unendlicher oder fester Dauer ist, wenn der Container geleast wird.

Wert	Beschreibung
Infinite
Fixed

LeaseState

Enumeration

Leasestatus des Containers.

Wert	Beschreibung
Available
Leased
Expired
Breaking
Broken

LeaseStatus

Enumeration

Der Lease-Status des Containers.

Wert	Beschreibung
Locked
Unlocked

RootSquashType

Enumeration

Die Eigenschaft ist nur für NFS-Freigabe vorgesehen. Der Standardwert ist NoRootSquash.

Wert	Beschreibung
NoRootSquash
RootSquash
AllSquash

ShareAccessTier

Enumeration

Zugriffsebene für bestimmte Freigaben. GpV2-Konto kann zwischen TransactionOptimized (Standard), Hot und Cool wählen. FileStorage-Konto kann Premium auswählen.

Wert	Beschreibung
TransactionOptimized
Hot
Cool
Premium

SignedIdentifier

Objekt

Name	Typ	Beschreibung
accessPolicy	AccessPolicy	Zugriffsrichtlinie
id	string	Ein eindeutiger Bezeichner der gespeicherten Zugriffsrichtlinie.

Freigeben über

File Shares - Get

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

GetSharePaidBursting

Beispielanforderung

Beispiel für eine Antwort

GetShareProvisionedV2

Beispielanforderung

Beispiel für eine Antwort

GetShares

Beispielanforderung

Beispiel für eine Antwort

GetShareStats

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AccessPolicy

CloudError

CloudErrorBody

EnabledProtocols

FileShare

FileSharePropertiesFileSharePaidBursting

LeaseDuration

LeaseState

LeaseStatus

RootSquashType

ShareAccessTier

SignedIdentifier