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

Registration Definitions - List

获取注册定义的列表。

GET https://management.azure.com/{scope}/providers/Microsoft.ManagedServices/registrationDefinitions?api-version=2022-10-01
GET https://management.azure.com/{scope}/providers/Microsoft.ManagedServices/registrationDefinitions?api-version=2022-10-01&$filter={$filter}

URI 参数

名称 必需 类型 说明
scope
path True

string

资源的范围。

api-version
query True

string

要用于此操作的 API 版本。

$filter
query

string

用于筛选托管服务资源的筛选器查询参数。

响应

名称 类型 说明
200 OK

RegistrationDefinitionList

确定 - 返回注册定义的列表。

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

Get Registration Definitions
Get Registration Definitions with ManagedByTenantId eq filter
Get Registration Definitions with ManagedByTenantId in filter

Get Registration Definitions

Sample Request

GET https://management.azure.com/subscription/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions?api-version=2022-10-01

Sample Response

{
  "value": [
    {
      "properties": {
        "description": "Test",
        "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc",
        "registrationDefinitionName": "DefinitionName",
        "authorizations": [
          {
            "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
            "principalIdDisplayName": "Support User",
            "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
          },
          {
            "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
            "principalIdDisplayName": "User Access Administrator",
            "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
            "delegatedRoleDefinitionIds": [
              "b24988ac-6180-42a0-ab88-20f7382dd24c"
            ]
          }
        ],
        "eligibleAuthorizations": [
          {
            "justInTimeAccessPolicy": {
              "multiFactorAuthProvider": "Azure",
              "maximumActivationDuration": "PT8H",
              "managedByTenantApprovers": [
                {
                  "principalId": "d9b22cd6-6407-43cc-8c60-07c56df0b51a",
                  "principalIdDisplayName": "Approver Group"
                }
              ]
            },
            "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2",
            "principalIdDisplayName": "Support User",
            "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e"
          }
        ],
        "provisioningState": "Succeeded",
        "manageeTenantId": "0e06d6a3-55ae-40a3-ac29-350808980808",
        "manageeTenantName": "Test customer",
        "managedByTenantName": "Test Tenant"
      },
      "plan": {
        "name": "addesai-plan",
        "product": "test",
        "publisher": "marketplace-test",
        "version": "1.0.0"
      },
      "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2",
      "type": "Microsoft.ManagedServices/registrationDefinitions",
      "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2"
    }
  ]
}

Get Registration Definitions with ManagedByTenantId eq filter

Sample Request

GET https://management.azure.com/subscription/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions?api-version=2022-10-01&$filter=%24filter%3DmanagedByTenantId+eq+%2783ace5cd-bcc3-441a-hd86-e6a75360cecc%27

Sample Response

{
  "value": [
    {
      "properties": {
        "description": "Test",
        "registrationDefinitionName": "DefinitionName",
        "authorizations": [
          {
            "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
            "principalIdDisplayName": "Support User",
            "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
          },
          {
            "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
            "principalIdDisplayName": "User Access Administrator",
            "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
            "delegatedRoleDefinitionIds": [
              "b24988ac-6180-42a0-ab88-20f7382dd24c"
            ]
          }
        ],
        "eligibleAuthorizations": [
          {
            "justInTimeAccessPolicy": {
              "multiFactorAuthProvider": "Azure",
              "maximumActivationDuration": "PT8H",
              "managedByTenantApprovers": [
                {
                  "principalId": "d9b22cd6-6407-43cc-8c60-07c56df0b51a",
                  "principalIdDisplayName": "Approver Group"
                }
              ]
            },
            "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2",
            "principalIdDisplayName": "Support User",
            "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e"
          }
        ],
        "provisioningState": "Succeeded",
        "manageeTenantId": "01c0bcd5-4f47-4e4b-b492-418b7e2a8854",
        "manageeTenantName": "test_test_aad_SbtFhyGiLHPFm",
        "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc",
        "managedByTenantName": "Contoso Corp."
      },
      "plan": {
        "name": "addesai-plan",
        "product": "test",
        "publisher": "marketplace-test",
        "version": "1.0.0"
      },
      "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2",
      "type": "Microsoft.ManagedServices/registrationDefinitions",
      "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2",
      "systemData": {
        "createdBy": "testuser@outlook.com",
        "createdByType": "User",
        "createdAt": "2021-11-22T19:56:05.0703382Z",
        "lastModifiedBy": "testuser@outlook.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-11-22T19:56:05.0703382Z"
      }
    }
  ]
}

Get Registration Definitions with ManagedByTenantId in filter

Sample Request

GET https://management.azure.com/subscription/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions?api-version=2022-10-01&$filter=%24filter%3DmanagedByTenantId+in+%28%2783ace5cd-bcc3-441a-hd86-e6a75360cecc%27%2C+%27de83f4a9-a76a-4025-a91a-91171923eac7%27%29

Sample Response

{
  "value": [
    {
      "properties": {
        "description": "Test",
        "registrationDefinitionName": "DefinitionName",
        "authorizations": [
          {
            "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
            "principalIdDisplayName": "Support User",
            "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
          },
          {
            "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
            "principalIdDisplayName": "User Access Administrator",
            "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
            "delegatedRoleDefinitionIds": [
              "b24988ac-6180-42a0-ab88-20f7382dd24c"
            ]
          }
        ],
        "eligibleAuthorizations": [
          {
            "justInTimeAccessPolicy": {
              "multiFactorAuthProvider": "Azure",
              "maximumActivationDuration": "PT8H",
              "managedByTenantApprovers": [
                {
                  "principalId": "d9b22cd6-6407-43cc-8c60-07c56df0b51a",
                  "principalIdDisplayName": "Approver Group"
                }
              ]
            },
            "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2",
            "principalIdDisplayName": "Support User",
            "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e"
          }
        ],
        "provisioningState": "Succeeded",
        "manageeTenantId": "01c0bcd5-4f47-4e4b-b492-418b7e2a8854",
        "manageeTenantName": "test_test_aad_SbtFhyGiLHPFm",
        "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc",
        "managedByTenantName": "Contoso Corp."
      },
      "plan": {
        "name": "addesai-plan",
        "product": "test",
        "publisher": "marketplace-test",
        "version": "1.0.0"
      },
      "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2",
      "type": "Microsoft.ManagedServices/registrationDefinitions",
      "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2",
      "systemData": {
        "createdBy": "testuser@outlook.com",
        "createdByType": "User",
        "createdAt": "2021-11-22T19:56:05.0703382Z",
        "lastModifiedBy": "testuser@outlook.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-11-22T19:56:05.0703382Z"
      }
    },
    {
      "properties": {
        "description": "Test 2",
        "registrationDefinitionName": "DefinitionName",
        "authorizations": [
          {
            "principalId": "a2e38003-c234-42dc-a769-3ca55be53098",
            "principalIdDisplayName": "Support User",
            "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
          }
        ],
        "provisioningState": "Succeeded",
        "manageeTenantId": "01c0bcd5-4f47-4e4b-b492-418b7e2a8854",
        "manageeTenantName": "test_test_aad_SbtFhyGiLHPFm",
        "managedByTenantId": "de83f4a9-a76a-4025-a91a-91171923eac7",
        "managedByTenantName": "Test Corp."
      },
      "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/2a60751f-03d6-45a1-8797-24678246d54d",
      "type": "Microsoft.ManagedServices/registrationDefinitions",
      "name": "2a60751f-03d6-45a1-8797-24678246d54d",
      "systemData": {
        "createdBy": "testuser@msp.com",
        "createdByType": "User",
        "createdAt": "2021-11-21T08:56:05.0703382Z",
        "lastModifiedBy": "testuser@msp.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-11-22T08:56:05.0703382Z"
      }
    }
  ]
}

定义

名称 说明
Authorization

Azure Active Directory 主体标识符和 Azure 内置角色,用于描述主体将在托管租户中的委派资源上接收的访问。

createdByType

创建资源的标识类型。

EligibleApprover

定义 Azure Active Directory 主体,该主体可以通过 EligibleAuthorization 中定义的主体批准任何实时访问请求。

EligibleAuthorization

Azure Active Directory 主体标识符、Azure 内置角色和实时访问策略,用于描述主体将在托管租户中的委派资源上接收的实时访问。

ErrorDefinition

指示无法处理传入请求的原因的错误响应

ErrorResponse

错误响应。

JustInTimeAccessPolicy

实时访问策略设置。

MultiFactorAuthProvider

用于实时访问请求的多重授权提供程序。

Plan

托管服务产品/服务计划的详细信息,请参阅 Azure 市场。

ProvisioningState

注册定义的当前预配状态。

RegistrationDefinition

注册定义。

RegistrationDefinitionList

注册定义列表。

RegistrationDefinitionProperties

注册定义的属性。

systemData

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

Authorization

Azure Active Directory 主体标识符和 Azure 内置角色,用于描述主体将在托管租户中的委派资源上接收的访问。

名称 类型 说明
delegatedRoleDefinitionIds

string[]

roleDefinitionId 引用用户访问管理员角色时,需要 delegatedRoleDefinitionIds 字段。 它是角色定义 ID 的列表,用于定义授权中的用户可以分配给其他主体的所有权限。

principalId

string

Azure Active Directory 主体的标识符。

principalIdDisplayName

string

Azure Active Directory 主体的显示名称。

roleDefinitionId

string

Azure 内置角色的标识符,用于定义 Azure Active Directory 主体对投影范围拥有的权限。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

EligibleApprover

定义 Azure Active Directory 主体,该主体可以通过 EligibleAuthorization 中定义的主体批准任何实时访问请求。

名称 类型 说明
principalId

string

Azure Active Directory 主体的标识符。

principalIdDisplayName

string

Azure Active Directory 主体的显示名称。

EligibleAuthorization

Azure Active Directory 主体标识符、Azure 内置角色和实时访问策略,用于描述主体将在托管租户中的委派资源上接收的实时访问。

名称 类型 说明
justInTimeAccessPolicy

JustInTimeAccessPolicy

实时访问策略设置。

principalId

string

Azure Active Directory 主体的标识符。

principalIdDisplayName

string

Azure Active Directory 主体的显示名称。

roleDefinitionId

string

Azure 内置角色的标识符,用于定义 Azure Active Directory 主体对投影范围拥有的权限。

ErrorDefinition

指示无法处理传入请求的原因的错误响应

名称 类型 说明
code

string

错误代码。

details

ErrorDefinition[]

内部错误详细信息。

message

string

指示操作失败原因的错误消息。

ErrorResponse

错误响应。

名称 类型 说明
error

ErrorDefinition

错误详细信息。

JustInTimeAccessPolicy

实时访问策略设置。

名称 类型 默认值 说明
managedByTenantApprovers

EligibleApprover[]

符合条件的授权的 managedByTenant 审批者列表。

maximumActivationDuration

string

PT8H

实时访问请求的 ISO 8601 格式的最长访问持续时间。

multiFactorAuthProvider

MultiFactorAuthProvider

None

用于实时访问请求的多重授权提供程序。

MultiFactorAuthProvider

用于实时访问请求的多重授权提供程序。

名称 类型 说明
Azure

string

None

string

Plan

托管服务产品/服务计划的详细信息,请参阅 Azure 市场。

名称 类型 说明
name

string

Azure 市场计划名称。

product

string

Azure 市场产品代码。

publisher

string

Azure 市场发布者 ID。

version

string

Azure 市场计划的版本。

ProvisioningState

注册定义的当前预配状态。

名称 类型 说明
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

NotSpecified

string

Ready

string

Running

string

Succeeded

string

Updating

string

RegistrationDefinition

注册定义。

名称 类型 说明
id

string

注册定义的完全限定路径。

name

string

注册定义的名称。

plan

Plan

托管服务产品/服务计划的详细信息,请参阅 Azure 市场。

properties

RegistrationDefinitionProperties

注册定义的属性。

systemData

systemData

注册分配资源的元数据。

type

string

Azure 资源的类型 (Microsoft.ManagedServices/registrationDefinitions) 。

RegistrationDefinitionList

注册定义列表。

名称 类型 说明
nextLink

string

注册定义的下一页的链接。

value

RegistrationDefinition[]

注册定义列表。

RegistrationDefinitionProperties

注册定义的属性。

名称 类型 说明
authorizations

Authorization[]

描述 managedBy 租户中 Azure Active Directory 主体访问的授权对象的集合将在托管租户中的委托资源上接收。

description

string

注册定义的说明。

eligibleAuthorizations

EligibleAuthorization[]

描述 managedBy 租户中 Azure Active Directory 主体的实时访问的合格授权对象的集合将在托管租户中的委派资源上接收。

managedByTenantId

string

managedBy 租户的标识符。

managedByTenantName

string

managedBy 租户的名称。

manageeTenantId

string

托管租户的标识符。

manageeTenantName

string

托管租户的名称。

provisioningState

ProvisioningState

注册定义的当前预配状态。

registrationDefinitionName

string

注册定义的名称。

systemData

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

名称 类型 说明
createdAt

string

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

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

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

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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