File Shares - Get

Ссылка

Service:: Storage Resource Provider

API Version:: 2023-01-01

Возвращает свойства указанной общей папки.

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

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string	Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Regex pattern: `^[a-z0-9]+$`
resourceGroupName	path	True	string	Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Regex pattern: `^[-\w\._]+$`
shareName	path	True	string	Имя общей папки в указанной учетной записи хранения. Имена общих папок должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для данной операции.
$expand	query		string	Необязательный параметр, используемый для развертывания свойств в свойствах общей папки. Допустимые значения: stats. Должен передаваться в виде строки с разделителем ",".

Заголовок запроса

Имя	Обязательно	Тип	Описание
x-ms-snapshot		string	Необязательный параметр, используемый для получения свойств snapshot.

Ответы

Имя	Тип	Описание
200 OK	FileShare	ОК . Операция получения общего ресурса успешно завершена.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

Определения

Имя	Описание
AccessPolicy
CloudError	Ответ об ошибке от службы хранилища.
CloudErrorBody	Ответ об ошибке от службы хранилища.
EnabledProtocols	Протокол проверки подлинности, используемый для общей папки. Можно указать только при создании общей папки.
FileShare	Свойства общей папки, включая идентификатор, имя ресурса, тип ресурса, Etag.
LeaseDuration	Указывает, является ли аренда общей папки бесконечной или фиксированной, только в том случае, если общая папка арендуется.
LeaseState	Состояние аренды общей папки.
LeaseStatus	Состояние аренды общей папки.
RootSquashType	Свойство предназначено только для общей папки NFS. Значение по умолчанию — NoRootSquash.
ShareAccessTier	Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между TransactionOptimized (по умолчанию), Горячим и Холодным. Учетная запись FileStorage может выбрать Premium.
SignedIdentifier

AccessPolicy

Имя	Тип	Описание
expiryTime	string	Срок действия политики доступа
permission	string	Список сокращенных разрешений.
startTime	string	Время начала политики доступа

CloudError

Ответ об ошибке от службы хранилища.

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от службы хранилища.

CloudErrorBody

Ответ об ошибке от службы хранилища.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

EnabledProtocols

Протокол проверки подлинности, используемый для общей папки. Можно указать только при создании общей папки.

Имя	Тип	Описание
NFS	string
SMB	string

FileShare

Свойства общей папки, включая идентификатор, имя ресурса, тип ресурса, Etag.

Имя	Тип	Описание
etag	string	Etag ресурса.
id	string	Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties.accessTier	ShareAccessTier	Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между TransactionOptimized (по умолчанию), Горячим и Холодным. Учетная запись FileStorage может выбрать Premium.
properties.accessTierChangeTime	string	Указывает время последнего изменения уровня доступа к общей папке.
properties.accessTierStatus	string	Указывает, существует ли ожидающий переход для уровня доступа.
properties.deleted	boolean	Указывает, была ли удалена общая папка.
properties.deletedTime	string	Время удаления, если общая папка была удалена.
properties.enabledProtocols	EnabledProtocols	Протокол проверки подлинности, используемый для общей папки. Можно указать только при создании общей папки.
properties.lastModifiedTime	string	Возвращает дату и время последнего изменения общей папки.
properties.leaseDuration	LeaseDuration	Указывает, является ли аренда общей папки бесконечной или фиксированной, только в том случае, если общая папка арендуется.
properties.leaseState	LeaseState	Состояние аренды общей папки.
properties.leaseStatus	LeaseStatus	Состояние аренды общей папки.
properties.metadata	object	Пары имя-значение, которые будут связаны с общей папкой как метаданные.
properties.remainingRetentionDays	integer	Оставшиеся дни хранения для общей папки, которая была обратимо удалена.
properties.rootSquash	RootSquashType	Свойство предназначено только для общей папки NFS. Значение по умолчанию — NoRootSquash.
properties.shareQuota	integer	Максимальный размер общей папки в гигабайтах. Значение должно быть больше 0 и меньше или равно 5 ТБ (5120). Для больших общих папок максимальный размер — 102400.
properties.shareUsageBytes	integer	Приблизительный размер данных, хранящихся в общей папке. Обратите внимание, что это значение может не включать все недавно созданные или недавно измененные файлы.
properties.signedIdentifiers	SignedIdentifier[]	Список хранимых политик доступа, указанных в общей папке.
properties.snapshotTime	string	Время создания общей папки snapshot возвращено в ответе общих папок списка с расширением param "snapshots".
properties.version	string	Версия общей папки.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

LeaseDuration

Указывает, является ли аренда общей папки бесконечной или фиксированной, только в том случае, если общая папка арендуется.

Имя	Тип	Описание
Fixed	string
Infinite	string

LeaseState

Состояние аренды общей папки.

Имя	Тип	Описание
Available	string
Breaking	string
Broken	string
Expired	string
Leased	string

LeaseStatus

Состояние аренды общей папки.

Имя	Тип	Описание
Locked	string
Unlocked	string

RootSquashType

Свойство предназначено только для общей папки NFS. Значение по умолчанию — NoRootSquash.

Имя	Тип	Описание
AllSquash	string
NoRootSquash	string
RootSquash	string

ShareAccessTier

Уровень доступа для определенной общей папки. Учетная запись GpV2 может выбирать между TransactionOptimized (по умолчанию), Горячим и Холодным. Учетная запись FileStorage может выбрать Premium.

Имя	Тип	Описание
Cool	string
Hot	string
Premium	string
TransactionOptimized	string

SignedIdentifier

Имя	Тип	Описание
accessPolicy	AccessPolicy	Политика доступа
id	string	Уникальный идентификатор хранимой политики доступа.

Поделиться через

File Shares - Get

Параметры URI

Заголовок запроса

Ответы

Безопасность

azure_auth

Scopes

Примеры

GetShares

Sample Request

Sample Response

GetShareStats

Sample Request

Sample Response

Определения

AccessPolicy

CloudError

CloudErrorBody

EnabledProtocols

FileShare

LeaseDuration

LeaseState

LeaseStatus

RootSquashType

ShareAccessTier

SignedIdentifier

Дополнительные ресурсы