你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

aml Filesystems - List By Resource Group

返回用户有权访问的资源组下的所有 AML 文件系统。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems?api-version=2024-07-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。

subscriptionId
path True

string

minLength: 1

目标订阅的 ID。

api-version
query True

string

minLength: 1

用于此作的 API 版本。

响应

名称 类型 说明
200 OK

AmlFilesystemsListResult

AmlFilesystem 对象的列表。 请注意,实体引用可能会替换完整的 AmlFilesystem 对象,如 http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference

Other Status Codes

CloudError

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

amlFilesystems_ListByResourceGroup

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems?api-version=2024-07-01

示例响应

{
  "value": [
    {
      "tags": {
        "Dept": "ContosoAds"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1",
      "location": "eastus",
      "zones": [
        "1"
      ],
      "identity": {
        "type": "UserAssigned",
        "userAssignedIdentities": {
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
        }
      },
      "name": "fs1",
      "type": "Microsoft.StorageCache/amlFilesystem",
      "properties": {
        "storageCapacityTiB": 16,
        "throughputProvisionedMBps": 500,
        "health": {
          "state": "Available",
          "statusDescription": "amlFilesystem is ok."
        },
        "provisioningState": "Succeeded",
        "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub1",
        "clientInfo": {
          "mgsAddress": "10.0.0.4",
          "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs",
          "lustreVersion": "2.15.0",
          "containerStorageInterface": {
            "persistentVolumeClaim": "<Base64 encoded YAML>",
            "persistentVolume": "<Base64 encoded YAML>",
            "storageClass": "<Base64 encoded YAML>"
          }
        },
        "encryptionSettings": {
          "keyEncryptionKey": {
            "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af",
            "sourceVault": {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk"
            }
          }
        },
        "maintenanceWindow": {
          "dayOfWeek": "Friday",
          "timeOfDayUTC": "22:00"
        },
        "hsm": {
          "settings": {
            "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername",
            "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername",
            "importPrefixesInitial": [
              "/"
            ]
          },
          "archiveStatus": [
            {
              "filesystemPath": "/",
              "status": {
                "state": "Completed",
                "lastCompletionTime": "2019-04-21T18:25:43.511Z",
                "lastStartedTime": "2019-04-21T17:25:43.511Z"
              }
            }
          ]
        },
        "rootSquashSettings": {
          "mode": "All",
          "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp",
          "squashUID": 99,
          "squashGID": 99,
          "status": "nodemap.active=1"
        }
      },
      "sku": {
        "name": "AMLFS-Durable-Premium-250"
      }
    },
    {
      "tags": {
        "Dept": "ContosoAds"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs2",
      "location": "eastus",
      "zones": [
        "1"
      ],
      "identity": {
        "type": "UserAssigned",
        "userAssignedIdentities": {
          "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
        }
      },
      "name": "fs2",
      "type": "Microsoft.StorageCache/amlFilesystem",
      "properties": {
        "storageCapacityTiB": 16,
        "throughputProvisionedMBps": 500,
        "health": {
          "state": "Available",
          "statusDescription": "amlFilesystem is ok."
        },
        "provisioningState": "Succeeded",
        "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub2",
        "clientInfo": {
          "mgsAddress": "10.0.0.4",
          "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs",
          "lustreVersion": "2.15.0",
          "containerStorageInterface": {
            "persistentVolumeClaim": "<Base64 encoded YAML>",
            "persistentVolume": "<Base64 encoded YAML>",
            "storageClass": "<Base64 encoded YAML>"
          }
        },
        "encryptionSettings": {
          "keyEncryptionKey": {
            "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af",
            "sourceVault": {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk"
            }
          }
        },
        "maintenanceWindow": {
          "dayOfWeek": "Friday",
          "timeOfDayUTC": "22:00"
        },
        "hsm": {
          "settings": {
            "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername",
            "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername",
            "importPrefixesInitial": [
              "/"
            ]
          },
          "archiveStatus": [
            {
              "filesystemPath": "/",
              "status": {
                "state": "Completed",
                "lastCompletionTime": "2019-04-21T18:25:43.511Z",
                "lastStartedTime": "2019-04-21T17:25:43.511Z"
              }
            }
          ]
        },
        "rootSquashSettings": {
          "mode": "All",
          "noSquashNidLists": "10.0.0.[5-6]@tcp;10.0.1.2@tcp",
          "squashUID": 99,
          "squashGID": 99,
          "status": "nodemap.active=1"
        }
      },
      "sku": {
        "name": "AMLFS-Durable-Premium-250"
      }
    }
  ]
}

定义

名称 说明
AmlFilesystem

AML 文件系统实例。 遵循 Azure 资源管理器标准:https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

AmlFilesystemArchive

有关 AML 文件系统存档的信息

AmlFilesystemClientInfo

AML 文件系统客户端信息

AmlFilesystemContainerStorageInterface

AML 文件系统容器存储接口信息

AmlFilesystemEncryptionSettings

AML 文件系统加密设置。

AmlFilesystemHealth

AML 文件系统运行状况的指示。 提供有关运行状况的详细信息,而不仅仅是与预配相关的运行状况。

AmlFilesystemHealthStateType

AML 文件系统运行状况状态的列表。

AmlFilesystemHsmSettings

AML 文件系统 HSM 设置。

AmlFilesystemIdentity

托管标识属性。

AmlFilesystemIdentityType

用于资源的标识类型。

AmlFilesystemProvisioningStateType

ARM 预配状态。

AmlFilesystemRootSquashSettings

AML 文件系统壁球设置。

AmlFilesystemsListResult

列出 AML 文件系统的请求的结果。 它包含 AML 文件系统列表和 URL 链接,用于获取下一组结果。

AmlFilesystemSquashMode

AML 文件系统的 Squash 模式。 “All”:文件上的用户和组 ID 将被压缩为非受信任系统上所有用户提供的值。 “RootOnly”:文件上的用户和组 ID 将被压缩为仅在不受信任的系统上为根用户提供值。 “无”:不会对任何系统上的任何用户执行用户和组 ID 的挤压。

ArchiveStatusType

存档作的状态

CloudError

错误响应。

CloudErrorBody

错误响应。

createdByType

创建资源的标识的类型。

Hsm

解除冻结和存档设置和状态

KeyVaultKeyReference

描述对密钥保管库密钥的引用。

MaintenanceDayOfWeekType

维护时段将发生一周中的一天。

MaintenanceWindow

每周维护时段 30 分钟的开始时间。

SkuName

资源的 SKU。

SourceVault

描述源密钥保管库的资源 ID。

Status

存档的状态

systemData

与创建和上次修改资源相关的元数据。

UserAssignedIdentities

一个字典,其中每个密钥是用户分配的标识资源 ID,并且每个密钥的值都是空字典。

AmlFilesystem

AML 文件系统实例。 遵循 Azure 资源管理器标准:https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

名称 类型 说明
id

string

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

AmlFilesystemIdentity

AML 文件系统使用的托管标识(如果已配置)。

location

string

资源所在的地理位置

name

string

资源的名称

properties.clientInfo

AmlFilesystemClientInfo

AML 文件系统的客户端信息。

properties.encryptionSettings

AmlFilesystemEncryptionSettings

指定 AML 文件系统的加密设置。

properties.filesystemSubnet

string

用于管理 AML 文件系统和面向客户端的作的子网。 此子网应在 VNET 的地址空间中至少具有 /24 子网掩码。

properties.health

AmlFilesystemHealth

AML 文件系统的运行状况。

properties.hsm

Hsm

解除冻结和存档设置和状态

properties.maintenanceWindow

MaintenanceWindow

每周维护时段 30 分钟的开始时间。

properties.provisioningState

AmlFilesystemProvisioningStateType

ARM 预配状态。

properties.rootSquashSettings

AmlFilesystemRootSquashSettings

指定 AML 文件系统的根壁球设置。

properties.storageCapacityTiB

number (float)

AML 文件系统的大小(以 TiB 为单位)。 这可能会向上舍入。

properties.throughputProvisionedMBps

integer (int32)

以 MB/秒为单位预配的吞吐量,计算为 storageCapacityTiB * 每单元存储吞吐量

sku

SkuName

资源的 SKU。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

资源标记。

type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

zones

string[]

资源的可用性区域。 此字段应仅包含数组中的单个元素。

AmlFilesystemArchive

有关 AML 文件系统存档的信息

名称 类型 说明
filesystemPath

string

相对于文件系统根目录存档的 Lustre 文件系统路径。 指定“/”以存档所有修改后的数据。

status

Status

存档的状态

AmlFilesystemClientInfo

AML 文件系统客户端信息

名称 类型 说明
containerStorageInterface

AmlFilesystemContainerStorageInterface

AML 文件系统的容器存储接口信息。

lustreVersion

string

在 AML 文件系统中运行的 Lustre 版本

mgsAddress

string

客户端用来装载 AML 文件系统 Lustre 管理服务 (MGS) 的 IPv4 地址。

mountCommand

string

用于装载 AML 文件系统的建议命令

AmlFilesystemContainerStorageInterface

AML 文件系统容器存储接口信息

名称 类型 说明
persistentVolume

string

适用于 CSI 驱动程序的推荐 AKS 永久性卷(在 Base64 编码的 YAML 中)

persistentVolumeClaim

string

在 Base64 编码的 YAML 中为 CSI 驱动程序推荐的 AKS 永久性卷声明

storageClass

string

适用于 CSI 驱动程序的推荐 AKS 存储类(在 Base64 编码的 YAML 中)

AmlFilesystemEncryptionSettings

AML 文件系统加密设置。

名称 类型 说明
keyEncryptionKey

KeyVaultKeyReference

指定 Key Vault 中加密密钥的位置。

AmlFilesystemHealth

AML 文件系统运行状况的指示。 提供有关运行状况的详细信息,而不仅仅是与预配相关的运行状况。

名称 类型 说明
state

AmlFilesystemHealthStateType

AML 文件系统运行状况状态的列表。

statusCode

string

AML 文件系统运行状况的服务器定义的错误代码

statusDescription

string

描述运行状况。

AmlFilesystemHealthStateType

AML 文件系统运行状况状态的列表。

说明
Available
Degraded
Maintenance
Transitioning
Unavailable

AmlFilesystemHsmSettings

AML 文件系统 HSM 设置。

名称 类型 默认值 说明
container

string

用于从命名空间中解除命名空间和存档的存储容器的资源 ID。 资源提供程序必须有权在存储帐户上创建 SAS 令牌。

importPrefix

string

/

只有以此路径/前缀开头的非日志记录容器中的 blob 才会导入到群集命名空间中。 这仅在初始创建 AML 文件系统期间使用。 它会自动创建可删除的导入作业资源。

importPrefixesInitial

string[]

仅此数组中以其中一个路径/前缀开头的非日志记录容器中的 Blob 导入到群集命名空间中。 这仅在初始创建 AML 文件系统期间使用,并将“/”用作默认值。 它会自动创建可删除的导入作业资源。

loggingContainer

string

用于记录事件和错误的存储容器的资源 ID。 必须是与冻结和存档容器位于同一存储帐户中的单独容器。 资源提供程序必须有权在存储帐户上创建 SAS 令牌。

AmlFilesystemIdentity

托管标识属性。

名称 类型 说明
principalId

string

资源的用户分配标识的主体 ID。

tenantId

string

与资源关联的租户 ID。

type

AmlFilesystemIdentityType

用于资源的标识类型。

userAssignedIdentities

UserAssignedIdentities

一个字典,其中每个密钥是用户分配的标识资源 ID,并且每个密钥的值都是空字典。

AmlFilesystemIdentityType

用于资源的标识类型。

说明
None
UserAssigned

AmlFilesystemProvisioningStateType

ARM 预配状态。

说明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

AmlFilesystemRootSquashSettings

AML 文件系统壁球设置。

名称 类型 说明
mode

AmlFilesystemSquashMode

AML 文件系统的 Squash 模式。 “All”:文件上的用户和组 ID 将被压缩为非受信任系统上所有用户提供的值。 “RootOnly”:文件上的用户和组 ID 将被压缩为仅在不受信任的系统上为根用户提供值。 “无”:不会对任何系统上的任何用户执行用户和组 ID 的挤压。

noSquashNidLists

string

要添加到 TrustedSystems 的分号分隔 NID IP 地址列表(s)。

squashGID

integer (int64)

要挤压到的组 ID。

squashUID

integer (int64)

要挤压到的用户 ID。

status

string

AML 文件系统壁球状态。

AmlFilesystemsListResult

列出 AML 文件系统的请求的结果。 它包含 AML 文件系统列表和 URL 链接,用于获取下一组结果。

名称 类型 说明
nextLink

string

用于获取下一组 AML 文件系统列表结果的 URL(如果有)。

value

AmlFilesystem[]

AML 文件系统列表。

AmlFilesystemSquashMode

AML 文件系统的 Squash 模式。 “All”:文件上的用户和组 ID 将被压缩为非受信任系统上所有用户提供的值。 “RootOnly”:文件上的用户和组 ID 将被压缩为仅在不受信任的系统上为根用户提供值。 “无”:不会对任何系统上的任何用户执行用户和组 ID 的挤压。

说明
All
None
RootOnly

ArchiveStatusType

存档作的状态

说明
Canceled
Cancelling
Completed
FSScanInProgress
Failed
Idle
InProgress
NotConfigured

CloudError

错误响应。

名称 类型 说明
error

CloudErrorBody

错误的正文。

CloudErrorBody

错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,旨在适合在用户界面中显示。

target

string

特定错误的目标。 例如,错误属性的名称。

createdByType

创建资源的标识的类型。

说明
Application
Key
ManagedIdentity
User

Hsm

解除冻结和存档设置和状态

名称 类型 说明
archiveStatus

AmlFilesystemArchive[]

存档状态

settings

AmlFilesystemHsmSettings

指定 AML 文件系统的 HSM 设置。

KeyVaultKeyReference

描述对密钥保管库密钥的引用。

名称 类型 说明
keyUrl

string

引用密钥保管库中的密钥加密密钥的 URL。

sourceVault

SourceVault

描述源密钥保管库的资源 ID。

MaintenanceDayOfWeekType

维护时段将发生一周中的一天。

说明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

MaintenanceWindow

每周维护时段 30 分钟的开始时间。

名称 类型 说明
dayOfWeek

MaintenanceDayOfWeekType

维护时段将发生一周中的一天。

timeOfDayUTC

string

pattern: ^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$

开始维护时段的一天时间(以 UTC 为单位)。

SkuName

资源的 SKU。

名称 类型 说明
name

string

此资源的 SKU 名称。

SourceVault

描述源密钥保管库的资源 ID。

名称 类型 说明
id

string

资源 ID。

Status

存档的状态

名称 类型 说明
errorCode

string

存档作的服务器定义的错误代码

errorMessage

string

存档作的服务器定义的错误消息

lastCompletionTime

string (date-time)

上次完成的存档作的时间

lastStartedTime

string (date-time)

启动最新存档作的时间

percentComplete

integer (int32)

存档作的完成百分比

state

ArchiveStatusType

存档作的状态

systemData

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。

UserAssignedIdentities

一个字典,其中每个密钥是用户分配的标识资源 ID,并且每个密钥的值都是空字典。

名称 类型 说明