Lijst per abonnement
Verwerkt aanvragen om alle resources in een abonnement weer te geven.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Communication/communicationServices?api-version=2023-03-31
URI-parameters
| Name |
In |
Vereist |
Type |
Description |
|
subscriptionId
|
path |
True
|
string
uuid
|
De id van het doelabonnement. De waarde moet een UUID zijn.
|
|
api-version
|
query |
True
|
string
|
De API-versie die voor deze bewerking moet worden gebruikt.
|
Antwoorden
| Name |
Type |
Description |
|
200 OK
|
CommunicationServiceResourceList
|
Voltooid. Het antwoord beschrijft de lijst met CommunicationServices in het abonnement.
|
|
Other Status Codes
|
ErrorResponse
|
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.
|
Voorbeelden
List by subscription
Sample Request
GET https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/communicationServices?api-version=2023-03-31
/** Samples for CommunicationServices List. */
public final class Main {
/*
* x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/listBySubscription.json
*/
/**
* Sample code: List by subscription.
*
* @param manager Entry point to CommunicationManager.
*/
public static void listBySubscription(com.azure.resourcemanager.communication.CommunicationManager manager) {
manager.communicationServices().list(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
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_subscription.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_subscription()
for item in response:
print(item)
# x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/listBySubscription.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
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/06042d4ffed6a1ea8319c39cd07ea21efe5d49f7/specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/listBySubscription.json
func ExampleServicesClient_NewListBySubscriptionPager() {
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().NewListBySubscriptionPager(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
const { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Handles requests to list all resources in a subscription.
*
* @summary Handles requests to list all resources in a subscription.
* x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/listBySubscription.json
*/
async function listBySubscription() {
const subscriptionId =
process.env["COMMUNICATION_SUBSCRIPTION_ID"] || "11112222-3333-4444-5555-666677778888";
const credential = new DefaultAzureCredential();
const client = new CommunicationServiceManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.communicationServices.listBySubscription()) {
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
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Communication;
using Azure.ResourceManager.Communication.Models;
using Azure.ResourceManager.Resources;
// Generated from example definition: specification/communication/resource-manager/Microsoft.Communication/stable/2023-03-31/examples/communicationServices/listBySubscription.json
// this example is just showing the usage of "CommunicationServices_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);
// invoke the operation and iterate over the result
await foreach (CommunicationServiceResource item in subscriptionResource.GetCommunicationServiceResourcesAsync())
{
// 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
Sample Response
{
"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"
}
}
]
}
Definities
CommunicationServiceResource
Een klasse die een CommunicationService-resource vertegenwoordigt.
| Name |
Type |
Description |
|
id
|
string
|
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
|
|
location
|
string
|
De geografische locatie waar de resource zich bevindt
|
|
name
|
string
|
De naam van de resource
|
|
properties.dataLocation
|
string
|
De locatie waar de communicatieservice de data-at-rest opslaat.
|
|
properties.hostName
|
string
|
FQDN van het CommunicationService-exemplaar.
|
|
properties.immutableResourceId
|
string
|
De onveranderbare resource-id van de communicatieservice.
|
|
properties.linkedDomains
|
string[]
|
Lijst met resource-id's van e-maildomein.
|
|
properties.notificationHubId
|
string
|
Resource-id van een Azure Notification Hub die is gekoppeld aan deze resource.
|
|
properties.provisioningState
|
CommunicationServices_ProvisioningState
|
Inrichtingsstatus van de resource.
|
|
properties.version
|
string
|
Versie van de CommunicationService-resource. Waarschijnlijk hebt u dezelfde of hogere versie van client-SDK's nodig.
|
|
systemData
|
systemData
|
Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy.
|
|
tags
|
object
|
Resourcetags.
|
|
type
|
string
|
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'
|
CommunicationServiceResourceList
Object dat een matrix van CommunicationServices en een mogelijke koppeling voor de volgende set bevat.
| Name |
Type |
Description |
|
nextLink
|
string
|
De URL die de client moet gebruiken om de volgende pagina op te halen (paginering aan serverzijde).
Het is nu null en wordt toegevoegd voor toekomstig gebruik.
|
|
value
|
CommunicationServiceResource[]
|
Lijst met CommunicationService
|
CommunicationServices_ProvisioningState
Inrichtingsstatus van de resource.
| Name |
Type |
Description |
|
Canceled
|
string
|
|
|
Creating
|
string
|
|
|
Deleting
|
string
|
|
|
Failed
|
string
|
|
|
Moving
|
string
|
|
|
Running
|
string
|
|
|
Succeeded
|
string
|
|
|
Unknown
|
string
|
|
|
Updating
|
string
|
|
createdByType
Het type identiteit waarmee de resource is gemaakt.
| Name |
Type |
Description |
|
Application
|
string
|
|
|
Key
|
string
|
|
|
ManagedIdentity
|
string
|
|
|
User
|
string
|
|
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
| Name |
Type |
Description |
|
info
|
object
|
De aanvullende informatie.
|
|
type
|
string
|
Het type aanvullende informatie.
|
ErrorDetail
De foutdetails.
| Name |
Type |
Description |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
Aanvullende informatie over de fout.
|
|
code
|
string
|
De foutcode.
|
|
details
|
ErrorDetail[]
|
De foutdetails.
|
|
message
|
string
|
Het foutbericht.
|
|
target
|
string
|
Het foutdoel.
|
ErrorResponse
Foutreactie
| Name |
Type |
Description |
|
error
|
ErrorDetail
|
Het foutobject.
|
systemData
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
| Name |
Type |
Description |
|
createdAt
|
string
|
Het tijdstempel van het maken van resources (UTC).
|
|
createdBy
|
string
|
De identiteit waarmee de resource is gemaakt.
|
|
createdByType
|
createdByType
|
Het type identiteit waarmee de resource is gemaakt.
|
|
lastModifiedAt
|
string
|
De tijdstempel van de laatste wijziging van de resource (UTC)
|
|
lastModifiedBy
|
string
|
De identiteit die de resource het laatst heeft gewijzigd.
|
|
lastModifiedByType
|
createdByType
|
Het type identiteit dat de resource het laatst heeft gewijzigd.
|