File Shares - Get

Referenz

Service:: Storage Resource Provider

API Version:: 2023-01-01

Ruft 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=2023-01-01

With optional parameters:

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

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]+$`
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\._]+$`
shareName	path	True	string	Der Name der Dateifreigabe innerhalb des angegebenen Speicherkontos. Dateinamen müssen zwischen 3 und 63 Zeichen lang sein und nur Zahlen, Kleinbuchstaben und Bindestriche (-) verwenden. Direkt vor und nach jedem Bindestrich (-) muss ein Buchstabe oder eine Ziffer stehen.
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.
$expand	query		string	Optional, wird verwendet, um die Eigenschaften innerhalb der 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 einer Momentaufnahme verwendet.

Antworten

Name	Typ	Beschreibung
200 OK	FileShare	OK : Der Freigabevorgang wurde erfolgreich abgeschlossen.
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

GetShares

GetShareStats

GetShares

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2023-01-01


/** Samples for FileShares Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-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/2023-01-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"
)

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

/**
 * 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/2023-01-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

Sample Response

Status code:: 200

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

GetShareStats

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634?api-version=2023-01-01&$expand=stats


/** Samples for FileShares Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-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/2023-01-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"
)

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

/**
 * 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/2023-01-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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9871/providers/Microsoft.Storage/storageAccounts/sto6217/fileServices/default/shares/share1634",
  "name": "share1634",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "etag": "\"0x8D592D74CC20EBA\"",
  "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.
LeaseDuration	Gibt an, ob die Lease für eine Freigabe von unendlicher oder fester Dauer ist, nur wenn die Freigabe geleast wird.
LeaseState	Leasestatus der Aktie.
LeaseStatus	Die Lease-status der Aktie.
RootSquashType	Die Eigenschaft gilt nur für die NFS-Freigabe. Der Standardwert ist NoRootSquash.
ShareAccessTier	Zugriffsebene für eine bestimmte Freigabe. GpV2-Konto kann zwischen TransactionOptimized (Standard), Hot und Cool wählen. Das FileStorage-Konto kann Premium auswählen.
SignedIdentifier

AccessPolicy

Name	Typ	Beschreibung
expiryTime	string	Ablaufzeit der Zugriffsrichtlinie
permission	string	Liste der abgekürzten Berechtigungen.
startTime	string	Startzeit der Zugriffsrichtlinie

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, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
target	string	Das Ziel des jeweiligen Fehlers. Beispiel: Der Name der -Eigenschaft im Fehler.

EnabledProtocols

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

Name	Typ	Beschreibung
NFS	string
SMB	string

FileShare

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. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.accessTier	ShareAccessTier	Zugriffsebene für eine bestimmte Freigabe. GpV2-Konto kann zwischen TransactionOptimized (Standard), Hot und Cool wählen. Das FileStorage-Konto kann Premium auswählen.
properties.accessTierChangeTime	string	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	Der gelöschte Zeitpunkt, 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.lastModifiedTime	string	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 von unendlicher oder fester Dauer ist, nur wenn die Freigabe geleast wird.
properties.leaseState	LeaseState	Leasestatus der Aktie.
properties.leaseStatus	LeaseStatus	Die Lease-status der Aktie.
properties.metadata	object	Ein Name-Wert-Paar, das der Freigabe als Metadaten zugeordnet wird.
properties.remainingRetentionDays	integer	Verbleibende Aufbewahrungstage für freigaben, die vorläufig gelöscht wurden.
properties.rootSquash	RootSquashType	Die Eigenschaft gilt nur für die NFS-Freigabe. Der Standardwert ist NoRootSquash.
properties.shareQuota	integer	Die maximale Größe der Freigabe in Gigabyte. Muss größer als 0 und kleiner gleich 5 TB (5120) sein. Für große Dateifreigaben beträgt die maximale Größe 102400.
properties.shareUsageBytes	integer	Die ungefähre Größe der in der Freigabe gespeicherten Daten. Beachten Sie, dass dieser Wert möglicherweise nicht alle kürzlich erstellten oder kürzlich geänderten Dateien enthält.
properties.signedIdentifiers	SignedIdentifier[]	Liste der gespeicherten Zugriffsrichtlinien, die in der Freigabe angegeben sind.
properties.snapshotTime	string	Die Erstellungszeit der Freigabe Momentaufnahme in der Antwort von Listenfreigaben mit dem Erweiterungsparam "Momentaufnahmen" zurückgegeben.
properties.version	string	Die Version der Freigabe.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

LeaseDuration

Gibt an, ob die Lease für eine Freigabe von unendlicher oder fester Dauer ist, nur wenn die Freigabe geleast wird.

Name	Typ	Beschreibung
Fixed	string
Infinite	string

LeaseState

Leasestatus der Aktie.

Name	Typ	Beschreibung
Available	string
Breaking	string
Broken	string
Expired	string
Leased	string

LeaseStatus

Die Lease-status der Aktie.

Name	Typ	Beschreibung
Locked	string
Unlocked	string

RootSquashType

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

Name	Typ	Beschreibung
AllSquash	string
NoRootSquash	string
RootSquash	string

ShareAccessTier

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

Name	Typ	Beschreibung
Cool	string
Hot	string
Premium	string
TransactionOptimized	string

SignedIdentifier

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

File Shares - Get

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

GetShares

Sample Request

Sample Response

GetShareStats

Sample Request

Sample Response

Definitionen

AccessPolicy

CloudError

CloudErrorBody

EnabledProtocols

FileShare

LeaseDuration

LeaseState

LeaseStatus

RootSquashType

ShareAccessTier

SignedIdentifier

Zusätzliche Ressourcen