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

Fleets - List By Subscription

列出指定订阅中的机群。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/fleets?api-version=2025-03-01

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string (uuid)

目标订阅的 ID。 该值必须是 UUID。

api-version
query True

string

minLength: 1

用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

FleetListResult

Azure 操作已成功完成。

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Lists the Fleet resources in a subscription.
Lists the Fleet resources in a subscription. - generated by [MaximumSet] rule

Lists the Fleet resources in a subscription.

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/fleets?api-version=2025-03-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/fleets/fleet1",
      "name": "fleet-1",
      "type": "Microsoft.ContainerService/fleets",
      "systemData": {
        "createdBy": "someUser",
        "createdByType": "User",
        "createdAt": "2022-03-23T05:40:40.657Z",
        "lastModifiedBy": "someOtherUser",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2022-03-23T05:40:40.657Z"
      },
      "tags": {
        "tier": "production",
        "archv2": ""
      },
      "location": "East US",
      "eTag": "23ujdflewrj3=",
      "properties": {
        "hubProfile": {
          "dnsPrefix": "dnsprefix1",
          "fqdn": "dnsprefix1-abcd1234.flt.eastus.azmk8s.io",
          "portalFqdn": "dnsprefix1-abcd1234.flt.eastus.azmk8s.io",
          "kubernetesVersion": "1.22.4",
          "agentProfile": {
            "vmSize": "Standard_DS1"
          }
        },
        "provisioningState": "Succeeded",
        "status": {
          "lastOperationId": "operation-12345",
          "lastOperationError": {
            "code": "None",
            "message": "No error"
          }
        }
      }
    }
  ],
  "nextLink": null
}

Lists the Fleet resources in a subscription. - generated by [MaximumSet] rule

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/fleets?api-version=2025-03-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/fleets/fleet1",
      "name": "fleet-1",
      "type": "Microsoft.ContainerService/fleets",
      "systemData": {
        "createdBy": "someUser",
        "createdByType": "User",
        "createdAt": "2022-03-23T05:40:40.657Z",
        "lastModifiedBy": "someOtherUser",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2022-03-23T05:40:40.657Z"
      },
      "tags": {},
      "location": "East US",
      "eTag": "23ujdflewrj3=",
      "properties": {
        "hubProfile": {
          "dnsPrefix": "dnsprefix1",
          "fqdn": "dnsprefix1-abcd1234.flt.eastus.azmk8s.io",
          "portalFqdn": "dnsprefix1-abcd1234.flt.eastus.azmk8s.io",
          "kubernetesVersion": "1.22.4",
          "agentProfile": {
            "vmSize": "Standard_DS1",
            "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgfleets/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1"
          },
          "apiServerAccessProfile": {
            "enablePrivateCluster": true,
            "enableVnetIntegration": true,
            "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgfleets/providers/Microsoft.Network/virtualNetwork/myvnet/subnets/mysubnet1"
          }
        },
        "provisioningState": "Succeeded"
      },
      "identity": {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "type": "None",
        "userAssignedIdentities": {
          "key126": {
            "principalId": "00000000-0000-0000-0000-000000000000",
            "clientId": "00000000-0000-0000-0000-000000000000"
          }
        }
      }
    }
  ],
  "nextLink": "https://microsoft.com/adyccxeh"
}

定义

名称 说明
AgentProfile

舰队中心的代理配置文件。

APIServerAccessProfile

机队中心 API 服务器的访问配置文件。

createdByType

创建资源的标识的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

Fleet

舰队资源。

FleetHubProfile

FleetHubProfile 配置机群中心。

FleetListResult

舰队列表操作的响应。

FleetProvisioningState

上次接受操作的预配状态。

FleetStatus

机队的状态信息。

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

systemData

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

UserAssignedIdentity

用户分配的标识属性

AgentProfile

舰队中心的代理配置文件。

名称 类型 说明
subnetId

string (arm-id)

机队中心节点将在启动时加入的子网的 ID。 如果未指定,将生成和使用 vnet 和子网。

vmSize

string

机队中心的虚拟机大小。

APIServerAccessProfile

机队中心 API 服务器的访问配置文件。

名称 类型 说明
enablePrivateCluster

boolean

是否创建舰队中心作为专用群集。

enableVnetIntegration

boolean

是否为 Fleet 中心启用 apiserver vnet 集成。

subnetId

string (arm-id)

启用 apiserver vnet 集成时要使用的子网。 使用 BYO vnet 创建新机队时需要用到它。

createdByType

创建资源的标识的类型。

说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

Fleet

舰队资源。

名称 类型 说明
eTag

string

如果在响应正文中提供了 eTag,则还可以根据正常的 etag 约定将其作为标头提供。 实体标记用于比较同一请求资源的两个或多个实体。 HTTP/1.1 在 etag(第 14.19 节)、If-Match(第 14.24 节)、If-None-Match(第 14.26 节)和 If-Range(第 14.27 节)标头字段中使用实体标记。

id

string (arm-id)

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”

identity

ManagedServiceIdentity

托管标识。

location

string

资源所在的地理位置

name

string

资源的名称

properties.hubProfile

FleetHubProfile

FleetHubProfile 配置舰队的中心。

properties.provisioningState

FleetProvisioningState

上次操作的状态。

properties.status

FleetStatus

机队的状态信息。

systemData

systemData

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

tags

object

资源标记。

type

string

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

FleetHubProfile

FleetHubProfile 配置机群中心。

名称 类型 说明
agentProfile

AgentProfile

舰队中心的代理配置文件。

apiServerAccessProfile

APIServerAccessProfile

机队中心 API 服务器的访问配置文件。

dnsPrefix

string

minLength: 1
maxLength: 54
pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,52}[a-zA-Z0-9]$

用于为舰队中心创建 FQDN 的 DNS 前缀。

fqdn

string

舰队中心的 FQDN。

kubernetesVersion

string

Fleet 中心的 Kubernetes 版本。

portalFqdn

string

车队中心的 Azure 门户 FQDN。

FleetListResult

舰队列表操作的响应。

名称 类型 说明
nextLink

string (uri)

指向下一页项的链接

value

Fleet[]

此页上的机队项

FleetProvisioningState

上次接受操作的预配状态。

说明
Canceled

资源创建已取消。

Creating

正在创建的机群的预配状态。

Deleting

正在删除的机群的预配状态。

Failed

资源创建失败。

Succeeded

已创建资源。

Updating

正在更新的机群的预配状态。

FleetStatus

机队的状态信息。

名称 类型 说明
lastOperationError

ErrorDetail

机队的最后一个作错误。

lastOperationId

string

机队的最后一个作 ID。

ManagedServiceIdentity

托管服务标识(系统分配和/或用户分配的标识)

名称 类型 说明
principalId

string (uuid)

系统分配标识的服务主体 ID。 此属性仅针对系统分配的标识提供。

tenantId

string (uuid)

系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。

type

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

userAssignedIdentities

<string,  UserAssignedIdentity>

User-Assigned 标识
与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。

ManagedServiceIdentityType

托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。

说明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

systemData

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

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string (date-time)

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

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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

UserAssignedIdentity

用户分配的标识属性

名称 类型 说明
clientId

string (uuid)

分配的标识的客户端 ID。

principalId

string (uuid)

已分配标识的主体 ID。