Notification Channels - List

Referência

Service:: Dev Test Labs

API Version:: 2018-09-15

Listar canais de notificação em um determinado laboratório.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels?api-version=2018-09-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels?$expand={$expand}&$filter={$filter}&$top={$top}&$orderby={$orderby}&api-version=2018-09-15

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
labName	path	True	string	O nome do lab.
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	A ID da assinatura.
api-version	query	True	string	Versão de API do cliente.
$expand	query		string	Especifique a consulta $expand. Exemplo: 'properties($select=webHookUrl)'
$filter	query		string	O filtro a ser aplicado à operação. Exemplo: '$filter=contains(name,'myName')
$orderby	query		string	A expressão de ordenação para os resultados, usando a notação OData. Exemplo: '$orderby=name desc'
$top	query		integer int32	O número máximo de recursos a serem retornados da operação. Exemplo: '$top=10'

Respostas

Nome	Tipo	Description
200 OK	NotificationChannelList	OK
Other Status Codes	CloudError	BadRequest

Segurança

azure_auth

Concessão Implícita OAuth2

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

Scopes

Nome	Description
user_impersonation	Acessar o Microsoft Azure

Exemplos

NotificationChannels_List

Sample Request

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels?api-version=2018-09-15

/** Samples for NotificationChannels List. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/NotificationChannels_List.json
     */
    /**
     * Sample code: NotificationChannels_List.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void notificationChannelsList(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        manager
            .notificationChannels()
            .list("resourceGroupName", "{labName}", null, null, null, null, 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.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python notification_channels_list.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 = DevTestLabsClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscriptionId}",
    )

    response = client.notification_channels.list(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/NotificationChannels_List.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 armdevtestlabs_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devtestlabs/armdevtestlabs"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/NotificationChannels_List.json
func ExampleNotificationChannelsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdevtestlabs.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewNotificationChannelsClient().NewListPager("resourceGroupName", "{labName}", &armdevtestlabs.NotificationChannelsClientListOptions{Expand: nil,
		Filter:  nil,
		Top:     nil,
		Orderby: 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.NotificationChannelList = armdevtestlabs.NotificationChannelList{
		// 	Value: []*armdevtestlabs.NotificationChannel{
		// 		{
		// 			Name: to.Ptr("autoshutdown"),
		// 			Type: to.Ptr("Microsoft.DevTestLab/labs/notificationChannels"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationChannels/{notificationChannelName}"),
		// 			Location: to.Ptr("{location}"),
		// 			Tags: map[string]*string{
		// 				"tagName1": to.Ptr("tagValue1"),
		// 			},
		// 			Properties: &armdevtestlabs.NotificationChannelProperties{
		// 				Description: to.Ptr("Integration configured for auto-shutdown"),
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-05T02:12:10.656Z"); return t}()),
		// 				EmailRecipient: to.Ptr("{email}"),
		// 				Events: []*armdevtestlabs.Event{
		// 					{
		// 						EventName: to.Ptr(armdevtestlabs.NotificationChannelEventTypeAutoShutdown),
		// 				}},
		// 				NotificationLocale: to.Ptr("en"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
		// 				WebHookURL: to.Ptr("{webhookUrl}"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("costThreshold"),
		// 			Type: to.Ptr("Microsoft.DevTestLab/labs/notificationChannels"),
		// 			ID: to.Ptr("/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationChannels/{notificationChannelName}"),
		// 			Location: to.Ptr("{location}"),
		// 			Tags: map[string]*string{
		// 				"tagName1": to.Ptr("tagValue1"),
		// 			},
		// 			Properties: &armdevtestlabs.NotificationChannelProperties{
		// 				Description: to.Ptr("Integration configured for cost"),
		// 				CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-05T02:14:05.239Z"); return t}()),
		// 				Events: []*armdevtestlabs.Event{
		// 					{
		// 						EventName: to.Ptr(armdevtestlabs.NotificationChannelEventTypeCost),
		// 				}},
		// 				NotificationLocale: to.Ptr("en"),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				UniqueIdentifier: to.Ptr("{uniqueIdentifier}"),
		// 				WebHookURL: to.Ptr("{webhookUrl}"),
		// 			},
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to List notification channels in a given lab.
 *
 * @summary List notification channels in a given lab.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/NotificationChannels_List.json
 */
async function notificationChannelsList() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.notificationChannels.list(resourceGroupName, labName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

notificationChannelsList().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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DevTestLabs;
using Azure.ResourceManager.DevTestLabs.Models;

// Generated from example definition: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/NotificationChannels_List.json
// this example is just showing the usage of "NotificationChannels_List" 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 DevTestLabResource created on azure
// for more information of creating DevTestLabResource, please refer to the document of DevTestLabResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
ResourceIdentifier devTestLabResourceId = DevTestLabResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName);
DevTestLabResource devTestLab = client.GetDevTestLabResource(devTestLabResourceId);

// get the collection of this DevTestLabNotificationChannelResource
DevTestLabNotificationChannelCollection collection = devTestLab.GetDevTestLabNotificationChannels();

// invoke the operation and iterate over the result
await foreach (DevTestLabNotificationChannelResource 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
    DevTestLabNotificationChannelData 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

Status code:: 200

{
  "value": [
    {
      "properties": {
        "webHookUrl": "{webhookUrl}",
        "emailRecipient": "{email}",
        "notificationLocale": "en",
        "description": "Integration configured for auto-shutdown",
        "events": [
          {
            "eventName": "AutoShutdown"
          }
        ],
        "createdDate": "2021-01-05T02:12:10.6566371+00:00",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationChannels/{notificationChannelName}",
      "name": "autoshutdown",
      "type": "Microsoft.DevTestLab/labs/notificationChannels",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    },
    {
      "properties": {
        "webHookUrl": "{webhookUrl}",
        "notificationLocale": "en",
        "description": "Integration configured for cost",
        "events": [
          {
            "eventName": "Cost"
          }
        ],
        "createdDate": "2021-01-05T02:14:05.2392034+00:00",
        "provisioningState": "Succeeded",
        "uniqueIdentifier": "{uniqueIdentifier}"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/labs/{labName}/notificationChannels/{notificationChannelName}",
      "name": "costThreshold",
      "type": "Microsoft.DevTestLab/labs/notificationChannels",
      "location": "{location}",
      "tags": {
        "tagName1": "tagValue1"
      }
    }
  ]
}

Definições

Nome	Description
CloudError	Erro de uma solicitação REST.
CloudErrorBody	Corpo de um erro de uma solicitação REST.
Event	Um evento para o qual ser notificado.
NotificationChannel	Uma notificação.
NotificationChannelEventType	O tipo de evento para o qual essa notificação está habilitada (ou seja, AutoShutdown, Custo)
NotificationChannelList	A resposta de uma operação de lista.

CloudError

Erro de uma solicitação REST.

Nome	Tipo	Description
error	CloudErrorBody	O erro de nuvem que ocorreu

CloudErrorBody

Corpo de um erro de uma solicitação REST.

Nome	Tipo	Description
code	string	O código de erro.
details	CloudErrorBody[]	Erros internos.
message	string	A mensagem de erro.
target	string	O destino do erro.

Event

Um evento para o qual ser notificado.

Nome	Tipo	Description
eventName	NotificationChannelEventType	O tipo de evento para o qual essa notificação está habilitada (ou seja, AutoShutdown, Custo)

NotificationChannel

Uma notificação.

Nome	Tipo	Description
id	string	O identificador do recurso.
location	string	A localização do recurso.
name	string	O nome do recurso.
properties.createdDate	string	A data de criação do canal de notificação.
properties.description	string	Descrição da notificação.
properties.emailRecipient	string	O destinatário do email para o qual enviar notificações (pode ser uma lista de endereços de email separados por ponto e vírgula).
properties.events	Event[]	A lista de eventos para o qual essa notificação está habilitada.
properties.notificationLocale	string	A localidade a ser usada ao enviar uma notificação (o fallback para idiomas sem suporte é EN).
properties.provisioningState	string	O status de provisionamento do recurso.
properties.uniqueIdentifier	string	O identificador imutável exclusivo de um recurso (Guid).
properties.webHookUrl	string	A URL do webhook para a qual enviar notificações.
tags	object	As marcas do recurso.
type	string	Tipo do recurso.

NotificationChannelEventType

O tipo de evento para o qual essa notificação está habilitada (ou seja, AutoShutdown, Custo)

Nome	Tipo	Description
AutoShutdown	string
Cost	string

NotificationChannelList

A resposta de uma operação de lista.

Nome	Tipo	Description
nextLink	string	Link para o próximo conjunto de resultados.
value	NotificationChannel[]	Resultados da operação de lista.