Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. WorkspaceNotificationRecipientEmail
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.WorkspaceNotificationRecipientEmail

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

Recipient Email details. Azure REST API version: 2022-09-01-preview.

Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

Example Usage

ApiManagementCreateWorkspaceNotificationRecipientEmail

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workspaceNotificationRecipientEmail = new AzureNative.ApiManagement.WorkspaceNotificationRecipientEmail("workspaceNotificationRecipientEmail", new()
    {
        Email = "foobar@live.com",
        NotificationName = "RequestPublisherNotificationMessage",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        WorkspaceId = "wks1",
    });

});
Copy
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewWorkspaceNotificationRecipientEmail(ctx, "workspaceNotificationRecipientEmail", &apimanagement.WorkspaceNotificationRecipientEmailArgs{
			Email:             pulumi.String("foobar@live.com"),
			NotificationName:  pulumi.String("RequestPublisherNotificationMessage"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			WorkspaceId:       pulumi.String("wks1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceNotificationRecipientEmail;
import com.pulumi.azurenative.apimanagement.WorkspaceNotificationRecipientEmailArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var workspaceNotificationRecipientEmail = new WorkspaceNotificationRecipientEmail("workspaceNotificationRecipientEmail", WorkspaceNotificationRecipientEmailArgs.builder()
            .email("foobar@live.com")
            .notificationName("RequestPublisherNotificationMessage")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .workspaceId("wks1")
            .build());

    }
}
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace_notification_recipient_email = azure_native.apimanagement.WorkspaceNotificationRecipientEmail("workspaceNotificationRecipientEmail",
    email="foobar@live.com",
    notification_name="RequestPublisherNotificationMessage",
    resource_group_name="rg1",
    service_name="apimService1",
    workspace_id="wks1")
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workspaceNotificationRecipientEmail = new azure_native.apimanagement.WorkspaceNotificationRecipientEmail("workspaceNotificationRecipientEmail", {
    email: "foobar@live.com",
    notificationName: "RequestPublisherNotificationMessage",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    workspaceId: "wks1",
});
Copy
resources:
  workspaceNotificationRecipientEmail:
    type: azure-native:apimanagement:WorkspaceNotificationRecipientEmail
    properties:
      email: foobar@live.com
      notificationName: RequestPublisherNotificationMessage
      resourceGroupName: rg1
      serviceName: apimService1
      workspaceId: wks1
Copy

Create WorkspaceNotificationRecipientEmail Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new WorkspaceNotificationRecipientEmail(name: string, args: WorkspaceNotificationRecipientEmailArgs, opts?: CustomResourceOptions);
@overload
def WorkspaceNotificationRecipientEmail(resource_name: str,
                                        args: WorkspaceNotificationRecipientEmailArgs,
                                        opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceNotificationRecipientEmail(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        notification_name: Optional[str] = None,
                                        resource_group_name: Optional[str] = None,
                                        service_name: Optional[str] = None,
                                        workspace_id: Optional[str] = None,
                                        email: Optional[str] = None)
func NewWorkspaceNotificationRecipientEmail(ctx *Context, name string, args WorkspaceNotificationRecipientEmailArgs, opts ...ResourceOption) (*WorkspaceNotificationRecipientEmail, error)
public WorkspaceNotificationRecipientEmail(string name, WorkspaceNotificationRecipientEmailArgs args, CustomResourceOptions? opts = null)
public WorkspaceNotificationRecipientEmail(String name, WorkspaceNotificationRecipientEmailArgs args)
public WorkspaceNotificationRecipientEmail(String name, WorkspaceNotificationRecipientEmailArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:WorkspaceNotificationRecipientEmail
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceNotificationRecipientEmailArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkspaceNotificationRecipientEmailArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceNotificationRecipientEmailArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceNotificationRecipientEmailArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkspaceNotificationRecipientEmailArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var workspaceNotificationRecipientEmailResource = new AzureNative.Apimanagement.WorkspaceNotificationRecipientEmail("workspaceNotificationRecipientEmailResource", new()
{
    NotificationName = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    WorkspaceId = "string",
    Email = "string",
});
Copy
example, err := apimanagement.NewWorkspaceNotificationRecipientEmail(ctx, "workspaceNotificationRecipientEmailResource", &apimanagement.WorkspaceNotificationRecipientEmailArgs{
	NotificationName:  "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	WorkspaceId:       "string",
	Email:             "string",
})
Copy
var workspaceNotificationRecipientEmailResource = new WorkspaceNotificationRecipientEmail("workspaceNotificationRecipientEmailResource", WorkspaceNotificationRecipientEmailArgs.builder()
    .notificationName("string")
    .resourceGroupName("string")
    .serviceName("string")
    .workspaceId("string")
    .email("string")
    .build());
Copy
workspace_notification_recipient_email_resource = azure_native.apimanagement.WorkspaceNotificationRecipientEmail("workspaceNotificationRecipientEmailResource",
    notification_name=string,
    resource_group_name=string,
    service_name=string,
    workspace_id=string,
    email=string)
Copy
const workspaceNotificationRecipientEmailResource = new azure_native.apimanagement.WorkspaceNotificationRecipientEmail("workspaceNotificationRecipientEmailResource", {
    notificationName: "string",
    resourceGroupName: "string",
    serviceName: "string",
    workspaceId: "string",
    email: "string",
});
Copy
type: azure-native:apimanagement:WorkspaceNotificationRecipientEmail
properties:
    email: string
    notificationName: string
    resourceGroupName: string
    serviceName: string
    workspaceId: string
Copy

WorkspaceNotificationRecipientEmail Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The WorkspaceNotificationRecipientEmail resource accepts the following input properties:

NotificationName
This property is required.
Changes to this property will trigger replacement.
string
Notification Name Identifier.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
Email Changes to this property will trigger replacement. string
Email identifier.
NotificationName
This property is required.
Changes to this property will trigger replacement.
string
Notification Name Identifier.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
Email Changes to this property will trigger replacement. string
Email identifier.
notificationName
This property is required.
Changes to this property will trigger replacement.
String
Notification Name Identifier.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
email Changes to this property will trigger replacement. String
Email identifier.
notificationName
This property is required.
Changes to this property will trigger replacement.
string
Notification Name Identifier.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
email Changes to this property will trigger replacement. string
Email identifier.
notification_name
This property is required.
Changes to this property will trigger replacement.
str
Notification Name Identifier.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
email Changes to this property will trigger replacement. str
Email identifier.
notificationName
This property is required.
Changes to this property will trigger replacement.
String
Notification Name Identifier.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
email Changes to this property will trigger replacement. String
Email identifier.

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkspaceNotificationRecipientEmail resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:WorkspaceNotificationRecipientEmail foobar@live.com /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/notifications/{notificationName}/recipientEmails/{email}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native