Notification Channels - Update

Service:

Dev Test Labs

API Version:

2018-09-15

Allows modifying tags of notification channels. All other properties will be ignored.

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

URI Parameters

Name	In	Required	Type	Description
labName	path	True	string	The name of the lab.
name	path	True	string	The name of the notification channel.
resourceGroupName	path	True	string	The name of the resource group.
subscriptionId	path	True	string	The subscription ID.
api-version	query	True	string	Client API version.

Request Body

Name	Type	Description
tags	object	The tags of the resource.

Responses

Name	Type	Description
200 OK	NotificationChannel	OK
Other Status Codes	CloudError	BadRequest

Security

azure_auth

OAuth2 Implicit Grant

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

Scopes

Name	Description
user_impersonation	Access Microsoft Azure

Examples

NotificationChannels_Update

Sample Request

HTTP

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

{}

Java

import com.azure.resourcemanager.devtestlabs.models.NotificationChannel;

/** Samples for NotificationChannels Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/NotificationChannels_Update.json
     */
    /**
     * Sample code: NotificationChannels_Update.
     *
     * @param manager Entry point to DevTestLabsManager.
     */
    public static void notificationChannelsUpdate(com.azure.resourcemanager.devtestlabs.DevTestLabsManager manager) {
        NotificationChannel resource =
            manager
                .notificationChannels()
                .getWithResponse(
                    "resourceGroupName",
                    "{labName}",
                    "{notificationChannelName}",
                    null,
                    com.azure.core.util.Context.NONE)
                .getValue();
        resource.update().apply();
    }
}

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.devtestlabs import DevTestLabsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-devtestlabs
# USAGE
    python notification_channels_update.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.update(
        resource_group_name="resourceGroupName",
        lab_name="{labName}",
        name="{notificationChannelName}",
    )
    print(response)


# x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/NotificationChannels_Update.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 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_Update.json
func ExampleNotificationChannelsClient_Update() {
	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)
	}
	res, err := clientFactory.NewNotificationChannelsClient().Update(ctx, "resourceGroupName", "{labName}", "{notificationChannelName}", armdevtestlabs.NotificationChannelFragment{}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NotificationChannel = armdevtestlabs.NotificationChannel{
	// 	Name: to.Ptr("{notificationChannelName}"),
	// 	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:14:05.239Z"); 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}"),
	// 	},
	// }
}

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 { DevTestLabsClient } = require("@azure/arm-devtestlabs");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Allows modifying tags of notification channels. All other properties will be ignored.
 *
 * @summary Allows modifying tags of notification channels. All other properties will be ignored.
 * x-ms-original-file: specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/NotificationChannels_Update.json
 */
async function notificationChannelsUpdate() {
  const subscriptionId = "{subscriptionId}";
  const resourceGroupName = "resourceGroupName";
  const labName = "{labName}";
  const name = "{notificationChannelName}";
  const notificationChannel = {};
  const credential = new DefaultAzureCredential();
  const client = new DevTestLabsClient(credential, subscriptionId);
  const result = await client.notificationChannels.update(
    resourceGroupName,
    labName,
    name,
    notificationChannel
  );
  console.log(result);
}

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

dotnet

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_Update.json
// this example is just showing the usage of "NotificationChannels_Update" 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 DevTestLabNotificationChannelResource created on azure
// for more information of creating DevTestLabNotificationChannelResource, please refer to the document of DevTestLabNotificationChannelResource
string subscriptionId = "{subscriptionId}";
string resourceGroupName = "resourceGroupName";
string labName = "{labName}";
string name = "{notificationChannelName}";
ResourceIdentifier devTestLabNotificationChannelResourceId = DevTestLabNotificationChannelResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, labName, name);
DevTestLabNotificationChannelResource devTestLabNotificationChannel = client.GetDevTestLabNotificationChannelResource(devTestLabNotificationChannelResourceId);

// invoke the operation
DevTestLabNotificationChannelPatch patch = new DevTestLabNotificationChannelPatch();
DevTestLabNotificationChannelResource result = await devTestLabNotificationChannel.UpdateAsync(patch);

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "properties": {
    "webHookUrl": "{webhookUrl}",
    "emailRecipient": "{email}",
    "notificationLocale": "en",
    "description": "Integration configured for auto-shutdown",
    "events": [
      {
        "eventName": "AutoShutdown"
      }
    ],
    "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": "{notificationChannelName}",
  "type": "Microsoft.DevTestLab/labs/notificationChannels",
  "location": "{location}",
  "tags": {
    "tagName1": "tagValue1"
  }
}

Definitions

Name	Description
CloudError	Error from a REST request.
CloudErrorBody	Body of an error from a REST request.
Event	An event to be notified for.
NotificationChannel	A notification.
NotificationChannelEventType	The event type for which this notification is enabled (i.e. AutoShutdown, Cost)
NotificationChannelFragment	A notification.

CloudError

Error from a REST request.

Name	Type	Description
error	CloudErrorBody	The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name	Type	Description
code	string	The error code.
details	CloudErrorBody[]	Inner errors.
message	string	The error message.
target	string	The error target.

Event

An event to be notified for.

Name	Type	Description
eventName	NotificationChannelEventType	The event type for which this notification is enabled (i.e. AutoShutdown, Cost)

NotificationChannel

A notification.

Name	Type	Description
id	string	The identifier of the resource.
location	string	The location of the resource.
name	string	The name of the resource.
properties.createdDate	string	The creation date of the notification channel.
properties.description	string	Description of notification.
properties.emailRecipient	string	The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
properties.events	Event[]	The list of event for which this notification is enabled.
properties.notificationLocale	string	The locale to use when sending a notification (fallback for unsupported languages is EN).
properties.provisioningState	string	The provisioning status of the resource.
properties.uniqueIdentifier	string	The unique immutable identifier of a resource (Guid).
properties.webHookUrl	string	The webhook URL to send notifications to.
tags	object	The tags of the resource.
type	string	The type of the resource.

NotificationChannelEventType

The event type for which this notification is enabled (i.e. AutoShutdown, Cost)

Name	Type	Description
AutoShutdown	string
Cost	string

NotificationChannelFragment

A notification.

Name	Type	Description
tags	object	The tags of the resource.