WCF Relays - List By Namespace

Dienst:

Relay

API-Version:

2024-01-01

Listet die WCF-Relays im Namespace auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
namespaceName	path	True	string minLength: 6 maxLength: 50	Der Namespacename
resourceGroupName	path	True	string minLength: 1 maxLength: 90	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	Typ	Beschreibung
200 OK	WcfRelaysListResult	WCF-Relays wurden erfolgreich zurückgegeben.
Other Status Codes	ErrorResponse	Relayfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

RelayListAll

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Relaytype	WCF-Relaytyp.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
WcfRelay	Beschreibung der WCF-Relayressource.
WcfRelaysListResult	Die Antwort des WCF-Relay-Listenvorgangs.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Relaytype

Enumeration

WCF-Relaytyp.

Wert	Beschreibung
Http
NetTcp

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

WcfRelay

Objekt

Beschreibung der WCF-Relayressource.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.createdAt	string (date-time)	Der Zeitpunkt, zu dem das WCF-Relay erstellt wurde.
properties.isDynamic	boolean	Gibt true zurück, wenn das Relay dynamisch ist; andernfalls "false".
properties.listenerCount	integer (int32) minimum: 0 maximum: 25	Die Anzahl der Listener für dieses Relay. Beachten Sie, dass min:1 und max:25 unterstützt werden.
properties.relayType	Relaytype	WCF-Relaytyp.
properties.requiresClientAuthorization	boolean	Gibt "true" zurück, wenn für dieses Relay eine Clientautorisierung 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 (date-time)	Der Zeitpunkt, zu dem der Namespace aktualisiert wurde.
properties.userMetadata	string	Die Usermetadata ist ein Platzhalter zum Speichern von benutzerdefinierten Zeichenfolgendaten für den WCF-Relay-Endpunkt. Beispielsweise kann es verwendet werden, um beschreibende Daten zu speichern, z. B. eine Liste von Teams und deren Kontaktinformationen. Außerdem können benutzerdefinierte Konfigurationseinstellungen gespeichert werden.
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs"

WcfRelaysListResult

Objekt

Die Antwort des WCF-Relay-Listenvorgangs.

Name	Typ	Beschreibung
nextLink	string	Verknüpfen Sie den nächsten Ergebnissatz. Nicht leer, wenn der Wert eine unvollständige Liste von WCF-Relays enthält.
value	WcfRelay[]	Ergebnis des WCF-Relay-Listenvorgangs.