File Shares - Update
要求本文で指定された共有プロパティを更新します。 要求に記載されていないプロパティは変更されません。 指定した共有がまだ存在しない場合、更新は失敗します。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2025-06-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
account
|
path | True |
string minLength: 3maxLength: 24 pattern: ^[a-z0-9]+$ |
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前は大文字と小文字が区別されます。 |
|
share
|
path | True |
string minLength: 3maxLength: 63 |
指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名は 3 文字から 63 文字の長さで、数字、小文字、ダッシュ (-) のみを使用する必要があります。 すべてのダッシュ (-) 文字は、文字または数字の直前に、その直後に文字または数字を付ける必要があります。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| properties.accessTier |
特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定)、ホット、クールを選択できます。 FileStorage アカウントでは、Premium を選択できます。 |
|
| properties.enabledProtocols |
ファイル共有に使用される認証プロトコル。 共有の作成時にのみ指定できます。 |
|
| properties.fileSharePaidBursting |
ファイル共有の有料バーストプロパティ。 |
|
| properties.metadata |
object |
共有にメタデータとして関連付ける名前と値のペア。 |
| properties.provisionedBandwidthMibps |
integer (int32) |
共有のプロビジョニングされた帯域幅 (1 秒あたりメビバイト単位)。 このプロパティは、Files Provisioned v2 アカウントの種類で作成されたファイル共有に対してのみ使用されます。 プロビジョニングされた帯域幅の最小値と最大値については、GetFileServiceUsage API 応答を参照してください。 |
| properties.provisionedIops |
integer (int32) |
共有のプロビジョニングされた IOPS。 このプロパティは、Files Provisioned v2 アカウントの種類で作成されたファイル共有に対してのみ使用されます。 プロビジョニングされた IOPS の最小値と最大値については、GetFileServiceUsage API 応答を参照してください。 |
| properties.rootSquash |
このプロパティは NFS 共有専用です。 既定値は NoRootSquash です。 |
|
| properties.shareQuota |
integer (int32) |
共有のプロビジョニング済みサイズ (ジビバイト単位)。 0 より大きく、5 TB (5120) 以下である必要があります。 大きなファイル共有の場合、最大サイズは 102400 です。 Files Provisioned v2 アカウントの種類で作成されたファイル共有については、プロビジョニングされたストレージ の最小サイズと最大許容サイズについては、GetFileServiceUsage API 応答を参照してください。 |
| properties.signedIdentifiers |
共有で指定された、保存されているアクセス ポリシーの一覧。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azure 操作は正常に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
|
Update |
|
Update |
|
Update |
|
Update |
UpdateShareAcls
要求のサンプル
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01
{
"properties": {
"signedIdentifiers": [
{
"accessPolicy": {
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd",
"startTime": "2021-04-01T08:49:37.0000000Z"
},
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI"
}
]
}
}
応答のサンプル
{
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"properties": {
"signedIdentifiers": [
{
"accessPolicy": {
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd",
"startTime": "2021-04-01T08:49:37.0000000Z"
},
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI"
}
]
}
}
UpdateSharePaidBursting
要求のサンプル
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01
{
"properties": {
"fileSharePaidBursting": {
"paidBurstingEnabled": true,
"paidBurstingMaxBandwidthMibps": 10340,
"paidBurstingMaxIops": 102400
}
}
}
応答のサンプル
{
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"properties": {
"fileSharePaidBursting": {
"paidBurstingEnabled": true,
"paidBurstingMaxBandwidthMibps": 10340,
"paidBurstingMaxIops": 102400
}
}
}
UpdateShareProvisionedV2
要求のサンプル
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01
{
"properties": {
"provisionedBandwidthMibps": 200,
"provisionedIops": 5000,
"shareQuota": 100
}
}
応答のサンプル
{
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"properties": {
"includedBurstIops": 15000,
"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
}
}
UpdateShares
要求のサンプル
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01
{
"properties": {
"metadata": {
"type": "image"
}
}
}
応答のサンプル
{
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"properties": {
"metadata": {
"type": "image"
}
}
}
定義
| 名前 | 説明 |
|---|---|
|
Access |
|
|
Cloud |
Storage サービスからのエラー応答。 |
|
Cloud |
Storage サービスからのエラー応答。 |
|
Enabled |
ファイル共有に使用される認証プロトコル。 共有の作成時にのみ指定できます。 |
|
File |
ID、リソース名、リソースの種類、Etag など、ファイル共有のプロパティ。 |
|
File |
ファイル共有の有料バーストプロパティ。 |
|
Lease |
コンテナーのリース期間が無限か固定かを指定します (コンテナーがリースされている場合のみ)。 |
|
Lease |
コンテナーのリース状態。 |
|
Lease |
コンテナーのリース状態。 |
|
Root |
このプロパティは NFS 共有専用です。 既定値は NoRootSquash です。 |
|
Share |
特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定)、ホット、クールを選択できます。 FileStorage アカウントでは、Premium を選択できます。 |
|
Signed |
AccessPolicy
| 名前 | 型 | 説明 |
|---|---|---|
| expiryTime |
string (date-time) |
アクセス ポリシーの有効期限 |
| permission |
string |
省略されたアクセス許可の一覧。 |
| startTime |
string (date-time) |
アクセス ポリシーの開始時刻 |
CloudError
Storage サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
Storage サービスからのエラー応答。 |
CloudErrorBody
Storage サービスからのエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
| details |
エラーに関する追加の詳細の一覧。 |
|
| message |
string |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
| target |
string |
特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。 |
EnabledProtocols
ファイル共有に使用される認証プロトコル。 共有の作成時にのみ指定できます。
| 値 | 説明 |
|---|---|
| SMB | |
| NFS |
FileShare
ID、リソース名、リソースの種類、Etag など、ファイル共有のプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| etag |
string |
リソース Etag。 |
| id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
リソースの名前 |
| properties.accessTier |
特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定)、ホット、クールを選択できます。 FileStorage アカウントでは、Premium を選択できます。 |
|
| properties.accessTierChangeTime |
string (date-time) |
共有アクセス層の最終変更時刻を示します。 |
| properties.accessTierStatus |
string |
アクセス層の保留中の移行があるかどうかを示します。 |
| properties.deleted |
boolean |
共有が削除されたかどうかを示します。 |
| properties.deletedTime |
string (date-time) |
共有が削除された場合の削除時刻。 |
| properties.enabledProtocols |
ファイル共有に使用される認証プロトコル。 共有の作成時にのみ指定できます。 |
|
| properties.fileSharePaidBursting |
ファイル共有の有料バーストプロパティ。 |
|
| properties.includedBurstIops |
integer (int32) |
共有の計算されたバースト IOPS。 このプロパティは、Files Provisioned v2 アカウントの種類で作成されたファイル共有に対してのみ使用されます。 |
| properties.lastModifiedTime |
string (date-time) |
共有が最後に変更された日時を返します。 |
| properties.leaseDuration |
共有のリース期間が無限か固定かを指定します (共有がリースされている場合のみ)。 |
|
| properties.leaseState |
共有のリース状態。 |
|
| properties.leaseStatus |
共有のリース状況。 |
|
| properties.maxBurstCreditsForIops |
integer (int64) |
共有の計算された最大バースト クレジット。 このプロパティは、Files Provisioned v2 アカウントの種類で作成されたファイル共有に対してのみ使用されます。 |
| properties.metadata |
object |
共有にメタデータとして関連付ける名前と値のペア。 |
| properties.nextAllowedProvisionedBandwidthDowngradeTime |
string (date-time-rfc7231) |
共有に対して次に許可されるプロビジョニングされた帯域幅のダウングレード時間を返します。 このプロパティは、Files Provisioned v2 アカウントの種類で作成されたファイル共有に対してのみ使用されます。 |
| properties.nextAllowedProvisionedIopsDowngradeTime |
string (date-time-rfc7231) |
共有に対して次に許可されるプロビジョニングされた IOPS ダウングレード時間を返します。 このプロパティは、Files Provisioned v2 アカウントの種類で作成されたファイル共有に対してのみ使用されます。 |
| properties.nextAllowedQuotaDowngradeTime |
string (date-time-rfc7231) |
共有に対して次に許可されるプロビジョニングされたストレージサイズのダウングレード時間を返します。 このプロパティは、Files Provisioned v1 SSD と Files Provisioned v2 アカウントの種類で作成されたファイル共有にのみ適用されます |
| properties.provisionedBandwidthMibps |
integer (int32) |
共有のプロビジョニングされた帯域幅 (1 秒あたりメビバイト単位)。 このプロパティは、Files Provisioned v2 アカウントの種類で作成されたファイル共有に対してのみ使用されます。 プロビジョニングされた帯域幅の最小値と最大値については、GetFileServiceUsage API 応答を参照してください。 |
| properties.provisionedIops |
integer (int32) |
共有のプロビジョニングされた IOPS。 このプロパティは、Files Provisioned v2 アカウントの種類で作成されたファイル共有に対してのみ使用されます。 プロビジョニングされた IOPS の最小値と最大値については、GetFileServiceUsage API 応答を参照してください。 |
| properties.remainingRetentionDays |
integer (int32) |
論理的に削除された共有の残りの保持日数。 |
| properties.rootSquash |
このプロパティは NFS 共有専用です。 既定値は NoRootSquash です。 |
|
| properties.shareQuota |
integer (int32) |
共有のプロビジョニング済みサイズ (ジビバイト単位)。 0 より大きく、5 TB (5120) 以下である必要があります。 大きなファイル共有の場合、最大サイズは 102400 です。 Files Provisioned v2 アカウントの種類で作成されたファイル共有については、プロビジョニングされたストレージ の最小サイズと最大許容サイズについては、GetFileServiceUsage API 応答を参照してください。 |
| properties.shareUsageBytes |
integer (int64) |
共有に格納されているデータのおおよそのサイズ。 この値には、最近作成されたファイルや最近サイズ変更されたファイルがすべて含まれていない場合があることに注意してください。 |
| properties.signedIdentifiers |
共有で指定された、保存されているアクセス ポリシーの一覧。 |
|
| properties.snapshotTime |
string (date-time) |
展開パラメータ「snapshots」を持つリスト共有の応答で返される共有スナップショットの作成時刻。 |
| properties.version |
string |
共有のバージョン。 |
| type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
FileSharePropertiesFileSharePaidBursting
ファイル共有の有料バーストプロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| paidBurstingEnabled |
boolean |
共有に対して有料バーストが有効かどうかを示します。 このプロパティは、Files Provisioned v1 SSD アカウントの種類で作成されたファイル共有に対してのみ使用されます。 |
| paidBurstingMaxBandwidthMibps |
integer (int32) |
共有の最大有料バースト帯域幅 (1 秒あたりのメビバイト単位)。 このプロパティは、Files Provisioned v1 SSD アカウントの種類で作成されたファイル共有に対してのみ使用されます。 許容される最大値は 10340 です。これは、共有で許可される最大帯域幅です。 |
| paidBurstingMaxIops |
integer (int32) |
共有の最大有料バースト IOPS。 このプロパティは、Files Provisioned v1 SSD アカウントの種類で作成されたファイル共有に対してのみ使用されます。 許可される最大値は 102400 です。これは、共有で許可される最大 IOPS です。 |
LeaseDuration
コンテナーのリース期間が無限か固定かを指定します (コンテナーがリースされている場合のみ)。
| 値 | 説明 |
|---|---|
| Infinite | |
| Fixed |
LeaseState
コンテナーのリース状態。
| 値 | 説明 |
|---|---|
| Available | |
| Leased | |
| Expired | |
| Breaking | |
| Broken |
LeaseStatus
コンテナーのリース状態。
| 値 | 説明 |
|---|---|
| Locked | |
| Unlocked |
RootSquashType
このプロパティは NFS 共有専用です。 既定値は NoRootSquash です。
| 値 | 説明 |
|---|---|
| NoRootSquash | |
| RootSquash | |
| AllSquash |
ShareAccessTier
特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定)、ホット、クールを選択できます。 FileStorage アカウントでは、Premium を選択できます。
| 値 | 説明 |
|---|---|
| TransactionOptimized | |
| Hot | |
| Cool | |
| Premium |
SignedIdentifier
| 名前 | 型 | 説明 |
|---|---|---|
| accessPolicy |
アクセス ポリシー |
|
| id |
string |
保存されているアクセス ポリシーの一意識別子。 |