你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Kafka Configurations - List By Account
获取帐户的 Kafka 配置列表。
Lists帐户中的 Kafka 配置
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations?api-version=2021-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}/kafkaConfigurations?api-version=2021-12-01&$skipToken={$skipToken}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
account
|
path | True |
string |
帐户的名称。 正则表达式模式: |
resource
|
path | True |
string |
资源组名称。 |
subscription
|
path | True |
string |
订阅标识符 |
api-version
|
query | True |
string |
要使用的 API 版本。 |
$skip
|
query |
string |
跳过标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功 |
|
Other Status Codes |
从提供程序收到的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
KafkaConfigurations_ListByAccount
示例请求
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgpurview/providers/Microsoft.Purview/accounts/account1/kafkaConfigurations?api-version=2021-12-01&$skipToken=token
示例响应
{
"value": [
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/kafkaConfigurations/default",
"name": "kafkaconfigName",
"type": "Microsoft.Purview/accounts/kafkaconfiguration",
"properties": {
"eventStreamingState": "Disabled",
"eventStreamingType": "None",
"consumerGroup": "consumerGroup",
"credentials": {
"identityId": "/subscriptions/47e8596d-ee73-4eb2-b6b4-cc13c2b87ssd/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testId",
"type": "UserAssigned"
},
"eventHubType": "Notification",
"eventHubPartitionId": "partitionId",
"eventHubResourceId": "/subscriptions/225be6fe-ec1c-4d51-a368-f69348d2e6c5/resourceGroups/testRG/providers/Microsoft.EventHub/namespaces/eventHubNameSpaceName"
},
"systemData": {
"createdAt": "2022-03-17T04:23:24.157Z",
"createdBy": "user",
"createdByType": "User",
"lastModifiedAt": "2022-03-17T04:23:24.157Z",
"lastModifiedBy": "user",
"lastModifiedByType": "User"
}
}
],
"nextLink": "nextLink"
}
定义
名称 | 说明 |
---|---|
created |
创建资源的标识类型。 |
Credentials |
用于访问附加到 purview 帐户的事件流式处理服务的凭据。 |
Credentials |
标识类型。 |
Error |
获取或设置错误。 |
Error |
默认错误模型 |
Error |
默认错误响应模型 |
event |
事件中心类型。 |
event |
事件流式处理服务的状态 |
event |
事件流式处理服务类型 |
Kafka |
附加到 Kafka 通知的 Purview 帐户的事件流式处理服务资源的配置。 |
Kafka |
kafka 配置资源的分页列表 |
last |
上次修改资源的标识类型。 |
System |
与资源的创建和上次修改相关的元数据。 |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Credentials
用于访问附加到 purview 帐户的事件流式处理服务的凭据。
名称 | 类型 | 说明 |
---|---|---|
identityId |
string |
UserAssign 类型的标识标识符。 |
type |
标识类型。 |
CredentialsType
标识类型。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
UserAssigned |
string |
Error
获取或设置错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
获取或设置代码。 |
details |
获取或设置详细信息。 |
|
message |
string |
获取或设置消息。 |
target |
string |
获取或设置目标。 |
ErrorModel
默认错误模型
名称 | 类型 | 说明 |
---|---|---|
code |
string |
获取或设置代码。 |
details |
获取或设置详细信息。 |
|
message |
string |
获取或设置消息。 |
target |
string |
获取或设置目标。 |
ErrorResponseModel
默认错误响应模型
名称 | 类型 | 说明 |
---|---|---|
error |
获取或设置错误。 |
eventHubType
事件中心类型。
名称 | 类型 | 说明 |
---|---|---|
Hook |
string |
|
Notification |
string |
eventStreamingState
事件流式处理服务的状态
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
eventStreamingType
事件流式处理服务类型
名称 | 类型 | 说明 |
---|---|---|
Azure |
string |
|
Managed |
string |
|
None |
string |
KafkaConfiguration
附加到 Kafka 通知的 Purview 帐户的事件流式处理服务资源的配置。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
获取或设置标识符。 |
|
name |
string |
获取或设置名称。 |
|
properties.consumerGroup |
string |
挂钩事件中心的使用者组。 |
|
properties.credentials |
用于访问事件中心的凭据。 |
||
properties.eventHubPartitionId |
string |
通知事件中心的可选分区 ID。 如果未设置,则将利用所有分区。 |
|
properties.eventHubResourceId |
string |
||
properties.eventHubType |
事件中心类型。 |
||
properties.eventStreamingState | Enabled |
事件流式处理服务的状态 |
|
properties.eventStreamingType | None |
事件流式处理服务类型 |
|
systemData |
与资源的创建和上次修改相关的元数据。 |
||
type |
string |
获取或设置类型。 |
KafkaConfigurationList
kafka 配置资源的分页列表
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
下一个结果页的 URL。 |
value |
结果类型的项的集合。 |
lastModifiedByType
上次修改资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
SystemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源的创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源的上次修改时间戳 (UTC) 。 |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |