WCF Relays - Get

Gibt die Beschreibung für das angegebene WCF-Relay zurück.

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

URI-Parameter

Name In Required Type Description
namespaceName
path True
  • string

Der Namespacename

relayName
path True
  • string

Der Relayname.

resourceGroupName
path True
  • string

Name der Ressourcengruppe innerhalb des Azure-Abonnements.

subscriptionId
path True
  • string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True
  • string

Client-API-Version.

Antworten

Name Type Description
200 OK

Die WCF-Relaybeschreibung wurde erfolgreich abgerufen.

204 No Content

WCF-Relay wurde nicht gefunden

Other Status Codes

Relay-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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
  }
}

Definitionen

ErrorResponse

Fehlerbekehrung gibt an, dass der Relaydienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Relaytype

WCF-Relaytyp.

WcfRelay

Beschreibung der WCF-Relayressource.

ErrorResponse

Fehlerbekehrung gibt an, dass der Relaydienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name Type Description
code
  • string

Fehlercode

message
  • string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Relaytype

WCF-Relaytyp.

Name Type Description
Http
  • string
NetTcp
  • string

WcfRelay

Beschreibung der WCF-Relayressource.

Name Type Description
id
  • string

Ressourcen-ID

name
  • string

Name der Ressource.

properties.createdAt
  • string

Die Zeit, zu der das WCF-Relay erstellt wurde.

properties.isDynamic
  • boolean

Gibt true zurück, wenn das Relay dynamisch ist; andernfalls "false".

properties.listenerCount
  • integer

Die Anzahl der Listener für dieses Relay. Beachten Sie, dass min:1 und max:25 unterstützt werden.

properties.relayType

WCF-Relaytyp.

properties.requiresClientAuthorization
  • boolean

Gibt true zurück, wenn die Clientautorisierung für dieses Relay erforderlich ist; andernfalls "false".

properties.requiresTransportSecurity
  • boolean

Gibt true zurück, wenn die Transportsicherheit für dieses Relay erforderlich ist; andernfalls "false".

properties.updatedAt
  • string

Der Zeitpunkt, an dem der Namespace aktualisiert wurde.

properties.userMetadata
  • string

Die Usermetadata ist ein Platzhalter zum Speichern benutzerdefinierter Zeichenfolgendaten für den WCF-Relayendpunkt. Sie kann beispielsweise verwendet werden, um beschreibende Daten zu speichern, z. B. eine Liste der Teams und deren Kontaktinformationen. Außerdem können benutzerdefinierte Konfigurationseinstellungen gespeichert werden.

type
  • string

Der Ressourcentyp.