Authorization Rules - Event Hubs - Create Or Update Authorization Rule
指定したイベント ハブの AuthorizationRule を作成または更新します。 AuthorizationRule の作成/更新が有効になるには数秒かかります。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName}?api-version=2024-01-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
authorization
|
path | True |
string |
承認規則の名前。 |
event
|
path | True |
string |
イベント ハブ名 |
namespace
|
path | True |
string |
名前空間名 正規表現パターン: |
resource
|
path | True |
string |
Azure サブスクリプション内のリソース グループの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
api-version
|
query | True |
string |
クライアント API のバージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.rights | True |
ルールに関連付けられている権限。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Event Hub AuthorizationRule が正常に作成されました。 |
|
Other Status Codes |
操作が失敗した理由を説明する Eventhub エラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
EventHubAuthorizationRuleCreate
要求のサンプル
PUT https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513?api-version=2024-01-01
{
"properties": {
"rights": [
"Listen",
"Send"
]
}
}
応答のサンプル
{
"id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.EventHub/namespaces/sdk-Namespace-960/eventhubs/sdk-EventHub-532/authorizationRules/sdk-Authrules-2513",
"name": "sdk-Authrules-2513",
"type": "Microsoft.EventHub/Namespaces/EventHubs/AuthorizationRules",
"properties": {
"rights": [
"Listen",
"Send"
]
}
}
定義
名前 | 説明 |
---|---|
Access |
ルールに関連付けられている権限。 |
Authorization |
List 操作または Get AuthorizationRule 操作の 1 つの項目 |
created |
リソースを作成した ID の種類。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに示されています。 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
AccessRights
ルールに関連付けられている権限。
名前 | 型 | 説明 |
---|---|---|
Listen |
string |
|
Manage |
string |
|
Send |
string |
AuthorizationRule
List 操作または Get AuthorizationRule 操作の 1 つの項目
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
リソースが保存されている地理的な場所 |
name |
string |
リソースの名前 |
properties.rights |
ルールに関連付けられている権限。 |
|
systemData |
このリソースに関連するシステム メタデータ。 |
|
type |
string |
リソースの型。 例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs" |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに示されています。
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースを最後に変更した ID の種類。 |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |