WCF Relays - List By Namespace

Služba:

Relay

Verze rozhraní API:

2024-01-01

Vypíše přenosy WCF v rámci oboru názvů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Název oboru názvů
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků v rámci předplatného Azure
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	WcfRelaysListResult	Přenosy WCF se úspěšně vrátily.
Other Status Codes	ErrorResponse	Odpověď na chybu služby Relay popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

RelayListAll

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Relaytype	Typ přenosu WCF.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.
WcfRelay	Popis prostředku služby WCF relay
WcfRelaysListResult	Odpověď operace předávání WCF seznamu.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Relaytype

Výčet

Typ přenosu WCF.

Hodnota	Description
Http
NetTcp

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

WcfRelay

Objekt

Popis prostředku služby WCF relay

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.createdAt	string (date-time)	Čas vytvoření předávání WCF.
properties.isDynamic	boolean	Vrátí hodnotu true, pokud je relé dynamické; jinak nepravda.
properties.listenerCount	integer (int32) minimum: 0 maximum: 25	Počet naslouchacích procesů pro tento přenos. Mějte na paměti, že se podporuje min:1 a max:25.
properties.relayType	Relaytype	Typ přenosu WCF.
properties.requiresClientAuthorization	boolean	Vrátí hodnotu true, pokud je pro tento přenos nutná autorizace klienta; jinak nepravda.
properties.requiresTransportSecurity	boolean	Vrátí hodnotu true, pokud je pro tuto relé nutné zabezpečení přenosu; jinak nepravda.
properties.updatedAt	string (date-time)	Čas aktualizace oboru názvů.
properties.userMetadata	string	Usermetadata je zástupný symbol pro ukládání uživatelem definovaných řetězcových dat pro koncový bod WCF Relay. Dá se například použít k ukládání popisných dat, jako je seznam týmů a jejich kontaktní údaje. Můžete také uložit uživatelsky definovaná nastavení konfigurace.
systemData	systemData	Systémová meta data týkající se tohoto prostředku.
type	string	Typ prostředku. Například Microsoft.EventHub/Namespaces nebo Microsoft.EventHub/Namespaces

WcfRelaysListResult

Objekt

Odpověď operace předávání WCF seznamu.

Name	Typ	Description
nextLink	string	Odkaz na další sadu výsledků Není prázdné, pokud hodnota obsahuje neúplný seznam přenosů WCF.
value	WcfRelay[]	Výsledek operace předávání WCF seznamu