Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. NotificationRecipientUser

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.NotificationRecipientUser

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a API Management Notification Recipient User.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
    name: "example-apim",
    location: example.location,
    resourceGroupName: example.name,
    publisherName: "My Company",
    publisherEmail: "company@terraform.io",
    skuName: "Developer_1",
});
const exampleUser = new azure.apimanagement.User("example", {
    userId: "123",
    apiManagementName: exampleService.name,
    resourceGroupName: example.name,
    firstName: "Example",
    lastName: "User",
    email: "foo@bar.com",
    state: "active",
});
const exampleNotificationRecipientUser = new azure.apimanagement.NotificationRecipientUser("example", {
    apiManagementId: exampleService.id,
    notificationType: "AccountClosedPublisher",
    userId: exampleUser.userId,
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.apimanagement.Service("example",
    name="example-apim",
    location=example.location,
    resource_group_name=example.name,
    publisher_name="My Company",
    publisher_email="company@terraform.io",
    sku_name="Developer_1")
example_user = azure.apimanagement.User("example",
    user_id="123",
    api_management_name=example_service.name,
    resource_group_name=example.name,
    first_name="Example",
    last_name="User",
    email="foo@bar.com",
    state="active")
example_notification_recipient_user = azure.apimanagement.NotificationRecipientUser("example",
    api_management_id=example_service.id,
    notification_type="AccountClosedPublisher",
    user_id=example_user.user_id)

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
			Name:              pulumi.String("example-apim"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			PublisherName:     pulumi.String("My Company"),
			PublisherEmail:    pulumi.String("company@terraform.io"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		exampleUser, err := apimanagement.NewUser(ctx, "example", &apimanagement.UserArgs{
			UserId:            pulumi.String("123"),
			ApiManagementName: exampleService.Name,
			ResourceGroupName: example.Name,
			FirstName:         pulumi.String("Example"),
			LastName:          pulumi.String("User"),
			Email:             pulumi.String("foo@bar.com"),
			State:             pulumi.String("active"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewNotificationRecipientUser(ctx, "example", &apimanagement.NotificationRecipientUserArgs{
			ApiManagementId:  exampleService.ID(),
			NotificationType: pulumi.String("AccountClosedPublisher"),
			UserId:           exampleUser.UserId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.ApiManagement.Service("example", new()
    {
        Name = "example-apim",
        Location = example.Location,
        ResourceGroupName = example.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@terraform.io",
        SkuName = "Developer_1",
    });

    var exampleUser = new Azure.ApiManagement.User("example", new()
    {
        UserId = "123",
        ApiManagementName = exampleService.Name,
        ResourceGroupName = example.Name,
        FirstName = "Example",
        LastName = "User",
        Email = "foo@bar.com",
        State = "active",
    });

    var exampleNotificationRecipientUser = new Azure.ApiManagement.NotificationRecipientUser("example", new()
    {
        ApiManagementId = exampleService.Id,
        NotificationType = "AccountClosedPublisher",
        UserId = exampleUser.UserId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.User;
import com.pulumi.azure.apimanagement.UserArgs;
import com.pulumi.azure.apimanagement.NotificationRecipientUser;
import com.pulumi.azure.apimanagement.NotificationRecipientUserArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-apim")
            .location(example.location())
            .resourceGroupName(example.name())
            .publisherName("My Company")
            .publisherEmail("company@terraform.io")
            .skuName("Developer_1")
            .build());

        var exampleUser = new User("exampleUser", UserArgs.builder()
            .userId("123")
            .apiManagementName(exampleService.name())
            .resourceGroupName(example.name())
            .firstName("Example")
            .lastName("User")
            .email("foo@bar.com")
            .state("active")
            .build());

        var exampleNotificationRecipientUser = new NotificationRecipientUser("exampleNotificationRecipientUser", NotificationRecipientUserArgs.builder()
            .apiManagementId(exampleService.id())
            .notificationType("AccountClosedPublisher")
            .userId(exampleUser.userId())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: My Company
      publisherEmail: company@terraform.io
      skuName: Developer_1
  exampleUser:
    type: azure:apimanagement:User
    name: example
    properties:
      userId: '123'
      apiManagementName: ${exampleService.name}
      resourceGroupName: ${example.name}
      firstName: Example
      lastName: User
      email: foo@bar.com
      state: active
  exampleNotificationRecipientUser:
    type: azure:apimanagement:NotificationRecipientUser
    name: example
    properties:
      apiManagementId: ${exampleService.id}
      notificationType: AccountClosedPublisher
      userId: ${exampleUser.userId}

    Create NotificationRecipientUser Resource

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

    Constructor syntax

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

@overload
def NotificationRecipientUser(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              api_management_id: Optional[str] = None,
                              notification_type: Optional[str] = None,
                              user_id: Optional[str] = None)
    func NewNotificationRecipientUser(ctx *Context, name string, args NotificationRecipientUserArgs, opts ...ResourceOption) (*NotificationRecipientUser, error)
    public NotificationRecipientUser(string name, NotificationRecipientUserArgs args, CustomResourceOptions? opts = null)
    public NotificationRecipientUser(String name, NotificationRecipientUserArgs args)
public NotificationRecipientUser(String name, NotificationRecipientUserArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationRecipientUserArgs
    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 notificationRecipientUserResource = new Azure.ApiManagement.NotificationRecipientUser("notificationRecipientUserResource", new()
{
    ApiManagementId = "string",
    NotificationType = "string",
    UserId = "string",
});

    example, err := apimanagement.NewNotificationRecipientUser(ctx, "notificationRecipientUserResource", &apimanagement.NotificationRecipientUserArgs{
	ApiManagementId:  pulumi.String("string"),
	NotificationType: pulumi.String("string"),
	UserId:           pulumi.String("string"),
})

    var notificationRecipientUserResource = new NotificationRecipientUser("notificationRecipientUserResource", NotificationRecipientUserArgs.builder()
    .apiManagementId("string")
    .notificationType("string")
    .userId("string")
    .build());

    notification_recipient_user_resource = azure.apimanagement.NotificationRecipientUser("notificationRecipientUserResource",
    api_management_id="string",
    notification_type="string",
    user_id="string")

    const notificationRecipientUserResource = new azure.apimanagement.NotificationRecipientUser("notificationRecipientUserResource", {
    apiManagementId: "string",
    notificationType: "string",
    userId: "string",
});

    type: azure:apimanagement:NotificationRecipientUser
properties:
    apiManagementId: string
    notificationType: string
    userId: string

    NotificationRecipientUser 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 NotificationRecipientUser resource accepts the following input properties:

    ApiManagementId string
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    NotificationType string
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    UserId string
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    ApiManagementId string
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    NotificationType string
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    UserId string
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    apiManagementId String
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    notificationType String
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    userId String
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    apiManagementId string
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    notificationType string
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    userId string
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    api_management_id str
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    notification_type str
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    user_id str
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    apiManagementId String
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    notificationType String
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    userId String
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NotificationRecipientUser Resource

    Get an existing NotificationRecipientUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NotificationRecipientUserState, opts?: CustomResourceOptions): NotificationRecipientUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_id: Optional[str] = None,
        notification_type: Optional[str] = None,
        user_id: Optional[str] = None) -> NotificationRecipientUser
    func GetNotificationRecipientUser(ctx *Context, name string, id IDInput, state *NotificationRecipientUserState, opts ...ResourceOption) (*NotificationRecipientUser, error)
    public static NotificationRecipientUser Get(string name, Input<string> id, NotificationRecipientUserState? state, CustomResourceOptions? opts = null)
    public static NotificationRecipientUser get(String name, Output<String> id, NotificationRecipientUserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiManagementId string
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    NotificationType string
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    UserId string
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    ApiManagementId string
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    NotificationType string
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    UserId string
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    apiManagementId String
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    notificationType String
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    userId String
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    apiManagementId string
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    notificationType string
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    userId string
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    api_management_id str
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    notification_type str
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    user_id str
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.
    apiManagementId String
    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.
    notificationType String
    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.
    userId String
    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    Import

    API Management Notification Recipient Users can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/notificationRecipientUser:NotificationRecipientUser example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/notifications/notificationName1/recipientUsers/userid1

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure