WCF Relays - Get

指定した WCF リレーの説明を返します。

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

URI パラメーター

Name In Required Type Description
namespaceName
path True
  • string

名前空間名

relayName
path True
  • string

リレー名。

resourceGroupName
path True
  • string

Azure サブスクリプション内のリソース グループの名前。

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント API バージョン。

応答

Name Type Description
200 OK

WCF リレーの説明が正常に取得されました。

204 No Content

WCF リレーが見つかりません

Other Status Codes

操作が失敗した理由を説明するリレー エラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

RelayGet

Sample Request

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

Sample Response

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default-ServiceBus-WestUS/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9953/WcfRelays/example-Relay-Wcf-1194",
  "name": "example-Relay-Wcf-1194",
  "type": "Microsoft.Relay/WcfRelays",
  "properties": {
    "listenerCount": 0,
    "createdAt": "2017-03-16T00:26:17.5014661Z",
    "updatedAt": "2017-03-16T00:26:17.5014661Z",
    "relayType": "NetTcp",
    "requiresClientAuthorization": true,
    "requiresTransportSecurity": true,
    "isDynamic": false
  }
}

定義

ErrorResponse

エラー応答は、Relay サービスが受信要求を処理できないことを示します。 この理由は、エラー メッセージに記載されています。

Relaytype

WCF リレーの種類。

WcfRelay

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

ErrorResponse

エラー応答は、Relay サービスが受信要求を処理できないことを示します。 この理由は、エラー メッセージに記載されています。

Name Type Description
code
  • string

エラー コード。

message
  • string

操作が失敗した理由を示すエラー メッセージ。

Relaytype

WCF リレーの種類。

Name Type Description
Http
  • string
NetTcp
  • string

WcfRelay

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

Name Type Description
id
  • string

リソースの ID

name
  • string

リソース名。

properties.createdAt
  • string

WCF リレーが作成された時刻。

properties.isDynamic
  • boolean

リレーが動的な場合は true を返します。それ以外の場合は false。

properties.listenerCount
  • integer

このリレーのリスナーの数。 min :1 と max:25 がサポートされていることに注意してください。

properties.relayType

WCF リレーの種類。

properties.requiresClientAuthorization
  • boolean

このリレーにクライアント承認が必要な場合は true を返します。それ以外の場合は false。

properties.requiresTransportSecurity
  • boolean

このリレーにトランスポート セキュリティが必要な場合は true を返します。それ以外の場合は false。

properties.updatedAt
  • string

名前空間が更新された時刻。

properties.userMetadata
  • string

usermetadata は、WCF Relay エンドポイントのユーザー定義文字列データを格納するためのプレースホルダーです。 たとえば、チームのリストや連絡先情報などの説明データを格納するために使用できます。 また、ユーザー定義の構成設定を格納することもできます。

type
  • string

リソースの種類。