WCF Relays - List By Namespace

Service:

Relay

API Version:

2017-04-01

Mencantumkan relai WCF dalam namespace.

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

Parameter URI

Name	In	Required	Type	Description
namespaceName	path	True	string	Nama namespace
resourceGroupName	path	True	string	Nama grup Sumber Daya dalam langganan Azure.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API klien.

Respons

Name	Type	Description
200 OK	WcfRelaysListResult	Relai WCF berhasil dikembalikan.
Other Status Codes	ErrorResponse	Respons kesalahan relai yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

RelayListAll

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for WcfRelays ListByNamespace. */
public final class Main {
    /*
     * x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayListAll.json
     */
    /**
     * Sample code: RelayListAll.
     *
     * @param manager Entry point to RelayManager.
     */
    public static void relayListAll(com.azure.resourcemanager.relay.RelayManager manager) {
        manager.wcfRelays().listByNamespace("resourcegroup", "example-RelayNamespace-01", Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Go

package armrelay_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/relay/armrelay"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayListAll.json
func ExampleWCFRelaysClient_NewListByNamespacePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
		return
	}
	ctx := context.Background()
	client, err := armrelay.NewWCFRelaysClient("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
		return
	}
	pager := client.NewListByNamespacePager("<resource-group-name>",
		"<namespace-name>",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
			return
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

JavaScript

const { RelayAPI } = require("@azure/arm-relay");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the WCF relays within the namespace.
 *
 * @summary Lists the WCF relays within the namespace.
 * x-ms-original-file: specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayListAll.json
 */
async function relayListAll() {
  const subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
  const resourceGroupName = "resourcegroup";
  const namespaceName = "example-RelayNamespace-01";
  const credential = new DefaultAzureCredential();
  const client = new RelayAPI(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.wCFRelays.listByNamespace(resourceGroupName, namespaceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

relayListAll().catch(console.error);

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:

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

Definisi

ErrorResponse	Respons kesalahan menunjukkan layanan Relay tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.
Relaytype	Jenis relai WCF.
WcfRelay	Deskripsi sumber daya relai WCF.
WcfRelaysListResult	Respons operasi relai WCF daftar.

ErrorResponse

Respons kesalahan menunjukkan layanan Relay tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan.

Name	Type	Description
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

Relaytype

Jenis relai WCF.

Name	Type	Description
Http	string
NetTcp	string

WcfRelay

Deskripsi sumber daya relai WCF.

Name	Type	Description
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.createdAt	string	Waktu relai WCF dibuat.
properties.isDynamic	boolean	Mengembalikan true jika relai bersifat dinamis; jika tidak, salah.
properties.listenerCount	integer	Jumlah pendengar untuk relai ini. Perhatikan bahwa min :1 dan max:25 didukung.
properties.relayType	Relaytype	Jenis relai WCF.
properties.requiresClientAuthorization	boolean	Mengembalikan true jika otorisasi klien diperlukan untuk relai ini; jika tidak, salah.
properties.requiresTransportSecurity	boolean	Mengembalikan true jika keamanan transportasi diperlukan untuk relai ini; jika tidak, salah.
properties.updatedAt	string	Waktu namespace diperbarui.
properties.userMetadata	string	Usermetadata adalah tempat penampung untuk menyimpan data string yang ditentukan pengguna untuk titik akhir WCF Relay. Misalnya, ini dapat digunakan untuk menyimpan data deskriptif, seperti daftar tim dan informasi kontak mereka. Selain itu, pengaturan konfigurasi yang ditentukan pengguna dapat disimpan.
type	string	Jenis sumber daya

WcfRelaysListResult

Respons operasi relai WCF daftar.

Name	Type	Description
nextLink	string	Tautkan ke kumpulan hasil berikutnya. Tidak kosong jika nilai berisi daftar relai WCF yang tidak lengkap.
value	WcfRelay[]	Hasil operasi relai WCF daftar.