Hybrid Connections - List Keys
ハイブリッド接続へのプライマリ接続文字列とセカンダリ接続文字列。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/hybridConnections/{hybridConnectionName}/authorizationRules/{authorizationRuleName}/listKeys?api-version=2021-11-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
authorization
|
path | True |
string |
承認規則の名前。 |
hybrid
|
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 バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
ハイブリッド接続への接続文字列を取得する要求が成功しました。 |
|
Other Status Codes |
操作が失敗した理由を説明するリレー エラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
RelayHybridConnectionAuthorizationRuleListKey
要求のサンプル
POST https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/hybridConnections/example-Relay-Hybrid-01/authorizationRules/example-RelayAuthRules-01/listKeys?api-version=2021-11-01
応答のサンプル
{
"primaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
"secondaryConnectionString": "Endpoint=sb://example-Relaynamespace-01.servicebus.windows.net/;SharedAccessKeyName=example-RelayAuthRules-01;SharedAccessKey=############################################",
"primaryKey": "############################################",
"secondaryKey": "############################################",
"keyName": "example-RelayAuthRules-01"
}
定義
名前 | 説明 |
---|---|
Access |
名前空間/リレー接続文字列 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
AccessKeys
名前空間/リレー接続文字列
名前 | 型 | 説明 |
---|---|---|
keyName |
string |
承認規則を説明する文字列。 |
primaryConnectionString |
string |
作成された名前空間承認規則のプライマリ 接続文字列。 |
primaryKey |
string |
SAS トークンの署名と検証用の Base64 でエンコードされた 256 ビットのプライマリ キー。 |
secondaryConnectionString |
string |
作成された名前空間承認規則のセカンダリ 接続文字列。 |
secondaryKey |
string |
SAS トークンの署名と検証用の Base64 でエンコードされた 256 ビットのセカンダリ キー。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |