WCF Relays - List By Namespace

サービス:

Relay

API バージョン:

2024-01-01

名前空間内の WCF リレーを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays?api-version=2024-01-01

URI パラメーター

名前	/	必須	型	説明
namespaceName	path	True	string minLength: 6 maxLength: 50	名前空間名
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Azure サブスクリプション内のリソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	WcfRelaysListResult	WCF リレーが正常に返されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するリレー エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

RelayListAll

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/wcfRelays?api-version=2024-01-01

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/WcfRelays/example-Relay-Wcf-01",
      "name": "example-Relay-Wcf-01",
      "type": "Microsoft.Relay/Namespaces/WcfRelays",
      "properties": {
        "createdAt": "2017-01-24T00:46:27.0049983Z",
        "updatedAt": "2017-01-24T00:46:27.0049983Z",
        "relayType": "NetTcp",
        "requiresClientAuthorization": true,
        "requiresTransportSecurity": true,
        "isDynamic": false,
        "userMetadata": "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store  descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored"
      }
    }
  ]
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
Relaytype	WCF リレーの種類。
systemData	リソースの作成と最後の変更に関連するメタデータ。
WcfRelay	WCF リレー リソースの説明。
WcfRelaysListResult	WCF リレー操作の一覧の応答。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

Relaytype

列挙

WCF リレーの種類。

値	説明
Http
NetTcp

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

WcfRelay

Object

WCF リレー リソースの説明。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.createdAt	string (date-time)	WCF リレーが作成された時刻。
properties.isDynamic	boolean	リレーが動的な場合は true を返します。それ以外の場合は false。
properties.listenerCount	integer (int32) minimum: 0 maximum: 25	このリレーのリスナーの数。 最小 :1 と最大:25 がサポートされていることに注意してください。
properties.relayType	Relaytype	WCF リレーの種類。
properties.requiresClientAuthorization	boolean	このリレーにクライアント承認が必要な場合は true を返します。それ以外の場合は false。
properties.requiresTransportSecurity	boolean	このリレーにトランスポート セキュリティが必要な場合は true を返します。それ以外の場合は false。
properties.updatedAt	string (date-time)	名前空間が更新された時刻。
properties.userMetadata	string	usermetadata は、WCF Relay エンドポイントのユーザー定義文字列データを格納するためのプレースホルダーです。 たとえば、チームのリストや連絡先情報などの説明データを格納するために使用できます。 また、ユーザー定義の構成設定を格納することもできます。
systemData	systemData	このリソースに関連するシステム メタデータ。
type	string	リソースの種類。 例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs"

WcfRelaysListResult

Object

WCF リレー操作の一覧の応答。

名前	型	説明
nextLink	string	次の結果セットにリンクします。 値に WCF リレーの不完全な一覧が含まれている場合は空ではありません。
value	WcfRelay[]	WCF リレー操作の一覧の結果。