File Shares - Update
更新要求本文で指定されているプロパティを共有します。 要求に記載されていないプロパティは変更されません。 指定した共有がまだ存在しない場合、更新は失敗します。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2023-01-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
account
|
path | True |
string |
指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ~ 24 文字で、数字と小文字のみを使用する必要があります。 Regex pattern: |
resource
|
path | True |
string |
ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 Regex pattern: |
share
|
path | True |
string |
指定したストレージ アカウント内のファイル共有の名前。 ファイル共有名の長さは 3 ~ 63 文字にする必要があり、数字、小文字、ダッシュ (-) のみを使用してください。 すべてのダッシュ (-) 文字は、その直前および直後に文字または数字が使用されている必要があります。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties.accessTier |
特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定値)、ホット、クールのどちらかを選択できます。 FileStorage アカウントでは、Premium を選択できます。 |
|
properties.enabledProtocols |
ファイル共有に使用される認証プロトコル。 共有の作成時にのみ指定できます。 |
|
properties.metadata |
object |
共有にメタデータとして関連付ける名前と値のペアを指定します。 |
properties.rootSquash |
プロパティは NFS 共有専用です。 既定値は NoRootSquash です。 |
|
properties.shareQuota |
integer |
共有の最大サイズ (ギガバイト単位)。 0 より大きく 5 TB (5120) 以下である必要があります。 大きなファイル共有の場合、最大サイズは 102400 です。 |
properties.signedIdentifiers |
共有で指定された格納されているアクセス ポリシーの一覧。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK -- 共有操作の更新が正常に完了しました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Update |
Update |
UpdateShareAcls
Sample Request
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2023-01-01
{
"properties": {
"signedIdentifiers": [
{
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
"accessPolicy": {
"startTime": "2021-04-01T08:49:37.0000000Z",
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd"
}
}
]
}
}
Sample Response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"properties": {
"signedIdentifiers": [
{
"id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI",
"accessPolicy": {
"startTime": "2021-04-01T08:49:37.0000000Z",
"expiryTime": "2021-05-01T08:49:37.0000000Z",
"permission": "rwd"
}
}
]
}
}
UpdateShares
Sample Request
PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2023-01-01
{
"properties": {
"metadata": {
"type": "image"
}
}
}
Sample Response
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
"name": "share6185",
"type": "Microsoft.Storage/storageAccounts/fileServices/shares",
"properties": {
"metadata": {
"type": "image"
}
}
}
定義
名前 | 説明 |
---|---|
Access |
|
Cloud |
ストレージ サービスからのエラー応答。 |
Cloud |
ストレージ サービスからのエラー応答。 |
Enabled |
ファイル共有に使用される認証プロトコル。 共有の作成時にのみ指定できます。 |
File |
ID、リソース名、リソースの種類、Etag など、ファイル共有のプロパティ。 |
Lease |
共有のリース期間が無制限か固定期間かを指定します。これは、共有がリースされている場合に限られます。 |
Lease |
共有のリース状態。 |
Lease |
共有のリース状態。 |
Root |
プロパティは NFS 共有専用です。 既定値は NoRootSquash です。 |
Share |
特定の共有のアクセス層。 GpV2 アカウントでは、TransactionOptimized (既定値)、ホット、クールのどちらかを選択できます。 FileStorage アカウントでは、Premium を選択できます。 |
Signed |
AccessPolicy
名前 | 型 | 説明 |
---|---|---|
expiryTime |
string |
アクセス ポリシーの有効期限 |
permission |
string |
省略されたアクセス許可の一覧。 |
startTime |
string |
アクセス ポリシーの開始時刻 |
CloudError
ストレージ サービスからのエラー応答。
名前 | 型 | 説明 |
---|---|---|
error |
ストレージ サービスからのエラー応答。 |
CloudErrorBody
ストレージ サービスからのエラー応答。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。 |
details |
エラーに関する追加の詳細の一覧。 |
|
message |
string |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
target |
string |
特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。 |
EnabledProtocols
ファイル共有に使用される認証プロトコル。 共有の作成時にのみ指定できます。
名前 | 型 | 説明 |
---|---|---|
NFS |
string |
|
SMB |
string |
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 |
共有アクセス層の最終変更時刻を示します。 |
properties.accessTierStatus |
string |
アクセス層の移行が保留中かどうかを示します。 |
properties.deleted |
boolean |
共有が削除されたかどうかを示します。 |
properties.deletedTime |
string |
共有が削除された場合の削除時刻。 |
properties.enabledProtocols |
ファイル共有に使用される認証プロトコル。 共有の作成時にのみ指定できます。 |
|
properties.lastModifiedTime |
string |
共有が最後に更新された日時を返します。 |
properties.leaseDuration |
共有のリース期間が無制限か固定期間かを指定します。これは、共有がリースされている場合に限られます。 |
|
properties.leaseState |
共有のリース状態。 |
|
properties.leaseStatus |
共有のリース状態。 |
|
properties.metadata |
object |
共有にメタデータとして関連付ける名前と値のペアを指定します。 |
properties.remainingRetentionDays |
integer |
論理的に削除された共有の残りの保持日数。 |
properties.rootSquash |
プロパティは NFS 共有専用です。 既定値は NoRootSquash です。 |
|
properties.shareQuota |
integer |
共有の最大サイズ (ギガバイト単位)。 0 より大きく 5 TB (5120) 以下である必要があります。 大きなファイル共有の場合、最大サイズは 102400 です。 |
properties.shareUsageBytes |
integer |
共有に格納されているデータのおおよそのサイズ。 この値には、最近作成または最近サイズ変更されたすべてのファイルが含まれていない場合があることに注意してください。 |
properties.signedIdentifiers |
共有で指定された格納されているアクセス ポリシーの一覧。 |
|
properties.snapshotTime |
string |
共有の作成時間スナップショット展開パラメーター "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 |
アクセス ポリシー |
|
id |
string |
格納されているアクセス ポリシーの一意識別子。 |