Validations - Validate Organization V 2

服务:

Confluent

API 版本:

2024-07-01

组织验证代理资源

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/validations/{organizationName}/orgvalidateV2?api-version=2024-07-01

URI 参数

名称	在	必需	类型	说明
organizationName	path	True	string	组织资源名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	必需	类型	说明
location	True	string	资源所在的地理位置
properties.offerDetail	True	OfferDetail	Confluent 产品/服务详细信息
properties.userDetail	True	UserDetail	订阅者详细信息
properties.linkOrganization		LinkOrganization	链接现有 Confluent 组织
tags		object	资源标记。

响应

名称	类型	说明
200 OK	ValidationResponse	Azure作已成功完成。
Other Status Codes	ResourceProviderDefaultErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Validations_ValidateOrganizations

示例请求

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/validations/myOrganization/orgvalidateV2?api-version=2024-07-01

{
  "location": "West US",
  "properties": {
    "offerDetail": {
      "id": "string",
      "planId": "string",
      "planName": "string",
      "privateOfferId": "string",
      "privateOfferIds": [
        "string"
      ],
      "publisherId": "string",
      "termUnit": "string"
    },
    "userDetail": {
      "aadEmail": "abc@microsoft.com",
      "emailAddress": "abc@microsoft.com",
      "firstName": "string",
      "lastName": "string",
      "userPrincipalName": "abc@microsoft.com"
    }
  },
  "tags": {
    "Environment": "Dev"
  }
}

示例响应

状态代码:

200

{
  "info": {
    "displayMessage": "This is display message"
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorResponseBody	错误响应正文
LinkOrganization	链接现有 Confluent 组织
OfferDetail	Confluent 产品/服务详细信息
OrganizationResource	组织资源。
ProvisionState	为 confluent RP 预配状态
ResourceProviderDefaultErrorResponse	资源提供程序的默认错误响应
SaaSOfferStatus	融合 RP 的 SaaS 产品/服务状态
systemData	与创建和上次修改资源相关的元数据。
UserDetail	订阅者详细信息
ValidationResponse	来自提供程序的验证响应

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorResponseBody

Object

错误响应正文

名称	类型	说明
code	string	错误代码
details	ErrorResponseBody[]	错误详细信息
message	string	错误消息
target	string	错误目标

LinkOrganization

Object

链接现有 Confluent 组织

名称	类型	说明
token	string (password)	用户身份验证令牌

OfferDetail

Object

Confluent 产品/服务详细信息

名称	类型	说明
id	string maxLength: 50	产品/服务 ID
planId	string maxLength: 200	套餐计划 ID
planName	string maxLength: 200	套餐计划名称
privateOfferId	string maxLength: 255	专用套餐 ID
privateOfferIds	string[]	专用产品/服务 ID 数组
publisherId	string maxLength: 50	发布者 ID
status	SaaSOfferStatus	SaaS 产品/服务状态
termId	string maxLength: 50	产品/服务计划期限 ID
termUnit	string maxLength: 25	产品/服务计划期限单位

OrganizationResource

Object

组织资源。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties.createdTime	string (date-time)	资源的创建时间。
properties.linkOrganization	LinkOrganization	链接现有 Confluent 组织
properties.offerDetail	OfferDetail	Confluent 产品/服务详细信息
properties.organizationId	string	Confluent 组织的 ID。
properties.provisioningState	ProvisionState	为 confluent RP 预配状态
properties.ssoUrl	string	Confluent 组织的 SSO URL。
properties.userDetail	UserDetail	订阅者详细信息
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ProvisionState

枚举

为 confluent RP 预配状态

值	说明
Accepted
Creating
Updating
Deleting
Succeeded
Failed
Canceled
Deleted
NotSpecified

ResourceProviderDefaultErrorResponse

Object

资源提供程序的默认错误响应

名称	类型	说明
error	ErrorResponseBody	错误响应正文

SaaSOfferStatus

枚举

融合 RP 的 SaaS 产品/服务状态

值	说明
Started
PendingFulfillmentStart
InProgress
Subscribed
Suspended
Reinstated
Succeeded
Failed
Unsubscribed
Updating

systemData

Object

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

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserDetail

Object

订阅者详细信息

名称	类型	说明
aadEmail	string	AAD 电子邮件地址
emailAddress	string pattern: ^\S+@\S+\.\S+$	电子邮件地址
firstName	string maxLength: 50	名字
lastName	string maxLength: 50	姓氏
userPrincipalName	string	用户主体名称

ValidationResponse

Object

来自提供程序的验证响应

名称	类型	说明
info	object	响应中的信息