File Shares - Get

Riferimento

Service:: Storage Resource Provider

API Version:: 2023-01-01

Ottiene le proprietà di una condivisione specificata.

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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account di archiviazione all'interno del gruppo di risorse specificato. I nomi degli account di archiviazione devono essere di lunghezza compresa tra 3 e 24 caratteri e utilizzare solo numeri e lettere minuscole. Regex pattern: `^[a-z0-9]+$`
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione dell'utente. Per il nome non viene fatta distinzione tra maiuscole e minuscole. Regex pattern: `^[-\w\._]+$`
shareName	path	True	string	Nome della condivisione file all'interno dell'account di archiviazione specificato. I nomi delle condivisioni file devono avere una lunghezza compresa tra 3 e 63 caratteri e usare numeri, lettere minuscole e solo trattino (-). Ogni carattere trattino (-) deve essere immediatamente preceduto e seguito da una lettera o un numero.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$expand	query		string	Facoltativo, usato per espandere le proprietà all'interno delle proprietà della condivisione. I valori validi sono: statistiche. Deve essere passato come stringa con delimitatore ','.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-snapshot		string	Facoltativo, utilizzato per recuperare le proprietà di uno snapshot.

Risposte

Nome	Tipo	Descrizione
200 OK	FileShare	OK - Operazione Di condivisione completata correttamente.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
AccessPolicy
CloudError	Risposta di errore dal servizio di archiviazione.
CloudErrorBody	Risposta di errore dal servizio di archiviazione.
EnabledProtocols	Protocollo di autenticazione utilizzato per la condivisione file. Può essere specificato solo durante la creazione di una condivisione.
FileShare	Proprietà della condivisione file, tra cui ID, nome risorsa, tipo di risorsa, Etag.
LeaseDuration	Specifica se il lease di una condivisione è di durata fissa o infinita, solo quando la condivisione viene con lease.
LeaseState	Stato di lease della condivisione.
LeaseStatus	Stato del lease della condivisione.
RootSquashType	La proprietà è solo per la condivisione NFS. Il valore predefinito è NoRootSquash.
ShareAccessTier	Livello di accesso per una condivisione specifica. L'account GpV2 può scegliere tra TransactionOptimized (impostazione predefinita), Accesso frequente e Sporadico. L'account FileStorage può scegliere Premium.
SignedIdentifier

AccessPolicy

Nome	Tipo	Descrizione
expiryTime	string	Scadenza dei criteri di accesso
permission	string	Elenco di autorizzazioni abbreviate.
startTime	string	Ora di inizio dei criteri di accesso

CloudError

Risposta di errore dal servizio di archiviazione.

Nome	Tipo	Descrizione
error	CloudErrorBody	Risposta di errore dal servizio di archiviazione.

CloudErrorBody

Risposta di errore dal servizio di archiviazione.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
details	CloudErrorBody[]	Elenco di dettagli aggiuntivi sull'errore.
message	string	Messaggio che descrive l'errore, che deve essere adatto per la visualizzazione in un'interfaccia utente.
target	string	Destinazione dell'errore specifico. Ad esempio, il nome della proprietà in errore.

EnabledProtocols

Protocollo di autenticazione utilizzato per la condivisione file. Può essere specificato solo durante la creazione di una condivisione.

Nome	Tipo	Descrizione
NFS	string
SMB	string

FileShare

Proprietà della condivisione file, tra cui ID, nome risorsa, tipo di risorsa, Etag.

Nome	Tipo	Descrizione
etag	string	Etag delle risorse.
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.accessTier	ShareAccessTier	Livello di accesso per una condivisione specifica. L'account GpV2 può scegliere tra TransactionOptimized (impostazione predefinita), Accesso frequente e Sporadico. L'account FileStorage può scegliere Premium.
properties.accessTierChangeTime	string	Indica l'ora dell'ultima modifica per il livello di accesso alla condivisione.
properties.accessTierStatus	string	Indica se è presente una transizione in sospeso per il livello di accesso.
properties.deleted	boolean	Indica se la condivisione è stata eliminata.
properties.deletedTime	string	Ora eliminata se la condivisione è stata eliminata.
properties.enabledProtocols	EnabledProtocols	Protocollo di autenticazione utilizzato per la condivisione file. Può essere specificato solo durante la creazione di una condivisione.
properties.lastModifiedTime	string	Restituisce la data e l'ora dell'ultima modifica apportata alla condivisione.
properties.leaseDuration	LeaseDuration	Specifica se il lease di una condivisione è di durata fissa o infinita, solo quando la condivisione viene con lease.
properties.leaseState	LeaseState	Stato di lease della condivisione.
properties.leaseStatus	LeaseStatus	Stato del lease della condivisione.
properties.metadata	object	Coppia nome-valore da associare alla condivisione come metadati.
properties.remainingRetentionDays	integer	Giorni di conservazione rimanenti per la condivisione eliminata soft.
properties.rootSquash	RootSquashType	La proprietà è solo per la condivisione NFS. Il valore predefinito è NoRootSquash.
properties.shareQuota	integer	Dimensione massima della condivisione, espressa in gigabyte. Deve essere maggiore di 0 e minore o uguale a 5 TB (5120). Per le condivisioni file di grandi dimensioni, la dimensione massima è 102400.
properties.shareUsageBytes	integer	Dimensioni approssimative dei dati archiviati nella condivisione. Si noti che questo valore potrebbe non includere tutti i file appena creati o ridimensionati di recente.
properties.signedIdentifiers	SignedIdentifier[]	Elenco dei criteri di accesso archiviati specificati nella condivisione.
properties.snapshotTime	string	Ora di creazione dello snapshot di condivisione restituita nella risposta delle condivisioni elenco con estensione param "snapshot".
properties.version	string	Versione della condivisione.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

LeaseDuration

Specifica se il lease di una condivisione è di durata fissa o infinita, solo quando la condivisione viene con lease.

Nome	Tipo	Descrizione
Fixed	string
Infinite	string

LeaseState

Stato di lease della condivisione.

Nome	Tipo	Descrizione
Available	string
Breaking	string
Broken	string
Expired	string
Leased	string

LeaseStatus

Stato del lease della condivisione.

Nome	Tipo	Descrizione
Locked	string
Unlocked	string

RootSquashType

La proprietà è solo per la condivisione NFS. Il valore predefinito è NoRootSquash.

Nome	Tipo	Descrizione
AllSquash	string
NoRootSquash	string
RootSquash	string

ShareAccessTier

Livello di accesso per una condivisione specifica. L'account GpV2 può scegliere tra TransactionOptimized (impostazione predefinita), Accesso frequente e Sporadico. L'account FileStorage può scegliere Premium.

Nome	Tipo	Descrizione
Cool	string
Hot	string
Premium	string
TransactionOptimized	string

SignedIdentifier

Nome	Tipo	Descrizione
accessPolicy	AccessPolicy	Criterio di accesso
id	string	Identificatore univoco dei criteri di accesso archiviati.

Condividi tramite

File Shares - Get

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

GetShares

Sample Request

Sample Response

GetShareStats

Sample Request

Sample Response

Definizioni

AccessPolicy

CloudError

CloudErrorBody

EnabledProtocols

FileShare

LeaseDuration

LeaseState

LeaseStatus

RootSquashType

ShareAccessTier

SignedIdentifier

Risorse aggiuntive