Communication Service - List By Resource Group

Hizmet:

Communication

API Sürümü:

2020-08-20

Kaynak Grubuna Göre Listele
Bir kaynak grubundaki tüm kaynakları listeleme isteklerini işler.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices?api-version=2020-08-20

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	CommunicationServiceResourceList	Başarı. Yanıt, resourceGroup içindeki CommunicationServices listesini açıklar.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

List by resource group

Örnek isteği

HTTP

GET https://management.azure.com/subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices?api-version=2020-08-20

Java

import com.azure.core.util.Context;

/** Samples for CommunicationService ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listByResourceGroup.json
     */
    /**
     * Sample code: List by resource group.
     *
     * @param manager Entry point to CommunicationManager.
     */
    public static void listByResourceGroup(com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager.communicationServices().listByResourceGroup("MyResourceGroup", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcommunication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/communication/armcommunication"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listByResourceGroup.json
func ExampleServiceClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcommunication.NewServiceClient("12345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("MyResourceGroup",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

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

/**
 * This sample demonstrates how to Handles requests to list all resources in a resource group.
 *
 * @summary Handles requests to list all resources in a resource group.
 * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2020-08-20/examples/listByResourceGroup.json
 */
async function listByResourceGroup() {
  const subscriptionId = "12345";
  const resourceGroupName = "MyResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.communicationService.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

listByResourceGroup().catch(console.error);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "properties": {
        "provisioningState": "Running",
        "dataLocation": "United States",
        "hostName": "mycommunicationservice.comms.azure.net",
        "version": "0.2.0"
      }
    }
  ]
}

Tanımlar

Name	Description
CommunicationServiceResource	CommunicationService kaynağını temsil eden bir sınıf.
CommunicationServiceResourceList	CommunicationServices dizisi ve sonraki küme için olası bir bağlantı içeren nesne.
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ProvisioningState	Kaynağın sağlama durumu.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

CommunicationServiceResource

Object

CommunicationService kaynağını temsil eden bir sınıf.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	CommunicationService'in çalıştığı Azure konumu.
name	string	Kaynağın adı
properties.dataLocation	string	İletişim hizmetinin bekleyen verilerini depoladığı konum.
properties.hostName	string	CommunicationService örneğinin FQDN'sini seçin.
properties.immutableResourceId	string	İletişim hizmetinin sabit kaynak kimliği.
properties.notificationHubId	string	Bu kaynağa bağlı bir Azure Notification Hub'ın kaynak kimliği.
properties.provisioningState	ProvisioningState	Kaynağın sağlama durumu.
properties.version	string	CommunicationService kaynağının sürümü. Büyük olasılıkla istemci SDK'larının aynı veya daha yüksek bir sürümüne ihtiyacınız vardır.
systemData	systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.
tags	object	Kaynağı açıklayan anahtar değer çiftlerinin listesi olan hizmetin etiketleri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

CommunicationServiceResourceList

Object

CommunicationServices dizisi ve sonraki küme için olası bir bağlantı içeren nesne.

Name	Tür	Description
nextLink	string	İstemcinin sonraki sayfayı getirmek için kullanması gereken URL (sunucu tarafı sayfalaması başına). Şimdilik null, gelecekte kullanılmak üzere eklendi.
value	CommunicationServiceResource[]	CommunicationService Listesi

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ProvisioningState

Listeleme

Kaynağın sağlama durumu.

Değer	Description
Unknown
Succeeded
Failed
Canceled
Running
Creating
Updating
Deleting
Moving

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.