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

Bmc Key Sets - Update

修补群集的基板管理控制器密钥集。
为提供的群集设置基板管理控制器密钥的修补属性,或更新与之关联的标记。 属性和标记更新可以独立完成。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/clusters/{clusterName}/bmcKeySets/{bmcKeySetName}?api-version=2023-07-01

URI 参数

名称 必需 类型 说明
bmcKeySetName
path True

string

基板管理控制器密钥集的名称。

正则表达式模式: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$

clusterName
path True

string

群集的名称。

正则表达式模式: ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$

resourceGroupName
path True

string

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

subscriptionId
path True

string

uuid

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

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 类型 说明
properties.expiration

string

此密钥集中的用户将从基板管理控制器中删除的日期和时间。

properties.userList

KeySetUser[]

允许用户的唯一列表。

tags

object

将替换现有资源的 Azure 资源标记。

响应

名称 类型 说明
200 OK

BmcKeySet

确定

202 Accepted

BmcKeySet

已接受

标头

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Patch baseboard management controller key set of cluster

示例请求

PATCH https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName?api-version=2023-07-01

{
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "properties": {
    "expiration": "2022-12-31T23:59:59.008Z",
    "userList": [
      {
        "azureUserName": "userABC",
        "sshPublicKey": {
          "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
        },
        "description": "Needs access for troubleshooting as a part of the support team"
      },
      {
        "azureUserName": "userXYZ",
        "sshPublicKey": {
          "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
        },
        "description": "Needs access for troubleshooting as a part of the support team"
      }
    ]
  }
}

示例响应

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName",
  "name": "bmcKeySetName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/clusters/bmcKeySets",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
  },
  "properties": {
    "privilegeLevel": "Administrator",
    "expiration": "2022-12-31T23:59:59.008Z",
    "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e",
    "userList": [
      {
        "azureUserName": "userABC",
        "sshPublicKey": {
          "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
        },
        "description": "Needs access for troubleshooting as a part of the support team"
      },
      {
        "azureUserName": "userXYZ",
        "sshPublicKey": {
          "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
        },
        "description": "Needs access for troubleshooting as a part of the support team"
      }
    ],
    "provisioningState": "Succeeded",
    "userListStatus": [
      {
        "azureUserName": "userABC",
        "status": "Active",
        "statusMessage": "User has been provisioned"
      },
      {
        "azureUserName": "userXYZ",
        "status": "Invalid",
        "statusMessage": "User is not a valid Azure user"
      }
    ],
    "lastValidation": "2022-12-12T12:00:00.008Z",
    "detailedStatus": "SomeInvalid",
    "detailedStatusMessage": "Inalid Azure user(s) were provided: userXYZ"
  }
}
Azure-AsyncOperation: https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2023-07-01
{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName/bmcKeySets/bmcKeySetName",
  "name": "bmcKeySetName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/clusters/bmcKeySets",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
  },
  "properties": {
    "privilegeLevel": "Administrator",
    "expiration": "2022-12-31T23:59:59.008Z",
    "azureGroupId": "f110271b-XXXX-4163-9b99-214d91660f0e",
    "userList": [
      {
        "azureUserName": "userABC",
        "sshPublicKey": {
          "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
        },
        "description": "Needs access for troubleshooting as a part of the support team"
      },
      {
        "azureUserName": "userXYZ",
        "sshPublicKey": {
          "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
        },
        "description": "Needs access for troubleshooting as a part of the support team"
      }
    ],
    "provisioningState": "Accepted",
    "lastValidation": "2022-12-12T12:00:00.008Z",
    "detailedStatus": "SomeInvalid",
    "detailedStatusMessage": "Inalid Azure user(s) were provided: userXYZ"
  }
}

定义

名称 说明
BareMetalMachineKeySetUserSetupStatus

指示用户当前是否部署了访问权限。

BmcKeySet

BmcKeySet 表示基板管理控制器密钥集。

BmcKeySetDetailedStatus

密钥集的更详细状态。

BmcKeySetPatchParameters

BmcKeySetPatchParameters 表示修补基板管理控制器密钥集的请求正文。

BmcKeySetPrivilegeLevel

此密钥集中的用户允许的访问级别。

BmcKeySetProvisioningState

基板管理控制器密钥集的预配状态。

createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ExtendedLocation

ExtendedLocation 表示将在其中创建资源的 Azure 自定义位置。

KeySetUser

KeySetUser 表示密钥集中用户的属性。

KeySetUserStatus

KeySetUserStatus 表示密钥集用户的状态。

SshPublicKey

SshPublicKey 表示用于通过 SSH 对资源进行身份验证的公钥。

systemData

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

BareMetalMachineKeySetUserSetupStatus

指示用户当前是否部署了访问权限。

名称 类型 说明
Active

string

Invalid

string

BmcKeySet

BmcKeySet 表示基板管理控制器密钥集。

名称 类型 说明
extendedLocation

ExtendedLocation

ExtendedLocation 表示将在其中创建资源的 Azure 自定义位置。
与资源关联的群集的扩展位置。

id

string

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

location

string

资源所在的地理位置

name

string

资源的名称

properties.azureGroupId

string

要授予访问权限,列表中所有用户必须位于的 Azure Active Directory 组的对象 ID。 不在组中的用户将没有访问权限。

properties.detailedStatus

BmcKeySetDetailedStatus

密钥集的更详细状态。

properties.detailedStatusMessage

string

有关当前详细状态的描述性消息。

properties.expiration

string

此密钥集中的用户将从基板管理控制器中删除的日期和时间。

properties.lastValidation

string

上次验证此密钥集的时间。

properties.privilegeLevel

BmcKeySetPrivilegeLevel

此密钥集中的用户允许的访问级别。

properties.provisioningState

BmcKeySetProvisioningState

基板管理控制器密钥集的预配状态。

properties.userList

KeySetUser[]

允许用户的唯一列表。

properties.userListStatus

KeySetUserStatus[]

每个用户的状态评估。

systemData

systemData

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

tags

object

资源标记。

type

string

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

BmcKeySetDetailedStatus

密钥集的更详细状态。

名称 类型 说明
AllActive

string

AllInvalid

string

SomeInvalid

string

Validating

string

BmcKeySetPatchParameters

BmcKeySetPatchParameters 表示修补基板管理控制器密钥集的请求正文。

名称 类型 说明
properties.expiration

string

此密钥集中的用户将从基板管理控制器中删除的日期和时间。

properties.userList

KeySetUser[]

允许用户的唯一列表。

tags

object

将替换现有资源的 Azure 资源标记。

BmcKeySetPrivilegeLevel

此密钥集中的用户允许的访问级别。

名称 类型 说明
Administrator

string

ReadOnly

string

BmcKeySetProvisioningState

基板管理控制器密钥集的预配状态。

名称 类型 说明
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ExtendedLocation

ExtendedLocation 表示将在其中创建资源的 Azure 自定义位置。

名称 类型 说明
name

string

将创建资源的扩展位置的资源 ID。

type

string

扩展的位置类型,例如 CustomLocation。

KeySetUser

KeySetUser 表示密钥集中用户的属性。

名称 类型 说明
azureUserName

string

将用于访问的用户名。

description

string

此用户的自由格式说明。

sshPublicKey

SshPublicKey

SshPublicKey 表示用于通过 SSH 对资源进行身份验证的公钥。
将为用户访问预配的 SSH 公钥。 用户应具有用于登录的相应 SSH 私钥。

KeySetUserStatus

KeySetUserStatus 表示密钥集用户的状态。

名称 类型 说明
azureUserName

string

将用于访问的用户名。

status

BareMetalMachineKeySetUserSetupStatus

指示用户当前是否部署了访问权限。

statusMessage

string

描述此用户的当前状态的其他信息(如果有)。

SshPublicKey

SshPublicKey 表示用于通过 SSH 对资源进行身份验证的公钥。

名称 类型 说明
keyData

string

SSH 公钥数据。

systemData

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

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

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

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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