Communication Services - List By Resource Group

Szolgáltatás:

Communication

API-verzió:

2023-04-01

Lista erőforráscsoport szerint
Kezeli az erőforráscsoport összes erőforrásának listázására vonatkozó kérelmeket.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices?api-version=2023-04-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	CommunicationServiceResourceList	Siker. A válasz a ResourceGroupban található CommunicationServices listáját írja le.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Példák

List by resource group

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/communicationServices?api-version=2023-04-01

Java

/**
 * Samples for CommunicationServices ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/
     * communicationServices/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", com.azure.core.util.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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.communication import CommunicationServiceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-communication
# USAGE
    python list_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CommunicationServiceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="11112222-3333-4444-5555-666677778888",
    )

    response = client.communication_services.list_by_resource_group(
        resource_group_name="MyResourceGroup",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/communicationServices/listByResourceGroup.json
if __name__ == "__main__":
    main()

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/communicationServices/listByResourceGroup.json
func ExampleServicesClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcommunication.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewServicesClient().NewListByResourceGroupPager("MyResourceGroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServiceResourceList = armcommunication.ServiceResourceList{
		// 	Value: []*armcommunication.ServiceResource{
		// 		{
		// 			Name: to.Ptr("MyCommunicationResource"),
		// 			Type: to.Ptr("Microsoft.Communication/CommunicationServices"),
		// 			ID: to.Ptr("/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource"),
		// 			Location: to.Ptr("Global"),
		// 			Properties: &armcommunication.ServiceProperties{
		// 				DataLocation: to.Ptr("United States"),
		// 				HostName: to.Ptr("mycommunicationservice.comms.azure.net"),
		// 				ProvisioningState: to.Ptr(armcommunication.CommunicationServicesProvisioningStateSucceeded),
		// 				Version: to.Ptr("0.2.0"),
		// 			},
		// 	}},
		// }
	}
}

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/2023-04-01/examples/communicationServices/listByResourceGroup.json
 */
async function listByResourceGroup() {
  const subscriptionId =
    process.env["COMMUNICATION_SUBSCRIPTION_ID"] || "11112222-3333-4444-5555-666677778888";
  const resourceGroupName = process.env["COMMUNICATION_RESOURCE_GROUP"] || "MyResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.communicationServices.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Communication;

// Generated from example definition: specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/communicationServices/listByResourceGroup.json
// this example is just showing the usage of "CommunicationServices_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "MyResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this CommunicationServiceResource
CommunicationServiceResourceCollection collection = resourceGroupResource.GetCommunicationServiceResources();

// invoke the operation and iterate over the result
await foreach (CommunicationServiceResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    CommunicationServiceResourceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
      "name": "MyCommunicationResource",
      "type": "Microsoft.Communication/CommunicationServices",
      "location": "Global",
      "properties": {
        "provisioningState": "Running",
        "dataLocation": "United States",
        "hostName": "mycommunicationservice.comms.azure.net",
        "version": "0.2.0"
      }
    }
  ]
}

Definíciók

Name	Description
CommunicationServiceResource	Egy CommunicationService-erőforrást képviselő osztály.
CommunicationServiceResourceList	Olyan objektum, amely a CommunicationServices tömböt és egy lehetséges hivatkozást tartalmaz a következő készlethez.
CommunicationServices_ProvisioningState	Az erőforrás kiépítési állapota.
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ManagedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)
ManagedServiceIdentityType	A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentity	Felhasználó által hozzárendelt identitástulajdonságok

CommunicationServiceResource

Objektum

Egy CommunicationService-erőforrást képviselő osztály.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.dataLocation	string	Az a hely, ahol a kommunikációs szolgáltatás inaktív állapotban tárolja az adatait.
properties.hostName	string	A CommunicationService-példány teljes tartományneve.
properties.immutableResourceId	string	A kommunikációs szolgáltatás nem módosítható erőforrás-azonosítója.
properties.linkedDomains	string[]	Az e-mail tartomány erőforrás-azonosítóinak listája.
properties.notificationHubId	string	Az erőforráshoz társított Azure Notification Hub erőforrás-azonosítója.
properties.provisioningState	CommunicationServices_ProvisioningState	Az erőforrás kiépítési állapota.
properties.version	string	A CommunicationService-erőforrás verziója. Valószínűleg az ügyféloldali SDK-k azonos vagy magasabb verziójára van szüksége.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

CommunicationServiceResourceList

Objektum

Olyan objektum, amely a CommunicationServices tömböt és egy lehetséges hivatkozást tartalmaz a következő készlethez.

Name	Típus	Description
nextLink	string	Az az URL-cím, amelyet az ügyfélnek használnia kell a következő lap lekéréséhez (kiszolgálóoldali lapozásonként). Egyelőre null értékű, későbbi használatra hozzáadva.
value	CommunicationServiceResource[]	A CommunicationService listája

CommunicationServices_ProvisioningState

Enumerálás

Az erőforrás kiépítési állapota.

Érték	Description
Canceled
Creating
Deleting
Failed
Moving
Running
Succeeded
Unknown
Updating

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ManagedServiceIdentity

Objektum

Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)

Name	Típus	Description
principalId	string (uuid)	A rendszer által hozzárendelt identitás szolgáltatásnév-azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
tenantId	string (uuid)	A rendszer által hozzárendelt identitás bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
type	ManagedServiceIdentityType	A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned identitások Az erőforráshoz társított felhasználó által hozzárendelt identitások készlete. A userAssignedIdentities szótárkulcsok arm-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. A szótár értékei lehetnek üres objektumok ({}) a kérelmekben.

ManagedServiceIdentityType

Enumerálás

A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).

Érték	Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UserAssignedIdentity

Objektum

Felhasználó által hozzárendelt identitástulajdonságok

Name	Típus	Description
clientId	string (uuid)	A hozzárendelt identitás ügyfélazonosítója.
principalId	string (uuid)	A hozzárendelt identitás egyszerű azonosítója.