1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  5. PartnerDestination
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.71.0 published on Friday, Nov 8, 2024 by Pulumi

azure-native.eventgrid.PartnerDestination

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.71.0 published on Friday, Nov 8, 2024 by Pulumi

    Event Grid Partner Destination. Azure REST API version: 2023-06-01-preview. Prior API version in Azure Native 1.x: 2021-10-15-preview.

    Other available API versions: 2021-10-15-preview, 2023-12-15-preview, 2024-06-01-preview.

    Example Usage

    PartnerDestinations_CreateOrUpdate

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var partnerDestination = new AzureNative.EventGrid.PartnerDestination("partnerDestination", new()
        {
            EndpointBaseUrl = "https://www.example/endpoint",
            EndpointServiceContext = "This is an example",
            ExpirationTimeIfNotActivatedUtc = "2022-03-14T19:33:43.430Z",
            Location = "westus2",
            MessageForActivation = "Sample Activation message",
            PartnerDestinationName = "examplePartnerDestinationName1",
            PartnerRegistrationImmutableId = "0bd70ee2-7d95-447e-ab1f-c4f320019404",
            ResourceGroupName = "examplerg",
        });
    
    });
    
    package main
    
    import (
    	eventgrid "github.com/pulumi/pulumi-azure-native-sdk/eventgrid/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := eventgrid.NewPartnerDestination(ctx, "partnerDestination", &eventgrid.PartnerDestinationArgs{
    			EndpointBaseUrl:                 pulumi.String("https://www.example/endpoint"),
    			EndpointServiceContext:          pulumi.String("This is an example"),
    			ExpirationTimeIfNotActivatedUtc: pulumi.String("2022-03-14T19:33:43.430Z"),
    			Location:                        pulumi.String("westus2"),
    			MessageForActivation:            pulumi.String("Sample Activation message"),
    			PartnerDestinationName:          pulumi.String("examplePartnerDestinationName1"),
    			PartnerRegistrationImmutableId:  pulumi.String("0bd70ee2-7d95-447e-ab1f-c4f320019404"),
    			ResourceGroupName:               pulumi.String("examplerg"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.eventgrid.PartnerDestination;
    import com.pulumi.azurenative.eventgrid.PartnerDestinationArgs;
    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 partnerDestination = new PartnerDestination("partnerDestination", PartnerDestinationArgs.builder()
                .endpointBaseUrl("https://www.example/endpoint")
                .endpointServiceContext("This is an example")
                .expirationTimeIfNotActivatedUtc("2022-03-14T19:33:43.430Z")
                .location("westus2")
                .messageForActivation("Sample Activation message")
                .partnerDestinationName("examplePartnerDestinationName1")
                .partnerRegistrationImmutableId("0bd70ee2-7d95-447e-ab1f-c4f320019404")
                .resourceGroupName("examplerg")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    partner_destination = azure_native.eventgrid.PartnerDestination("partnerDestination",
        endpoint_base_url="https://www.example/endpoint",
        endpoint_service_context="This is an example",
        expiration_time_if_not_activated_utc="2022-03-14T19:33:43.430Z",
        location="westus2",
        message_for_activation="Sample Activation message",
        partner_destination_name="examplePartnerDestinationName1",
        partner_registration_immutable_id="0bd70ee2-7d95-447e-ab1f-c4f320019404",
        resource_group_name="examplerg")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const partnerDestination = new azure_native.eventgrid.PartnerDestination("partnerDestination", {
        endpointBaseUrl: "https://www.example/endpoint",
        endpointServiceContext: "This is an example",
        expirationTimeIfNotActivatedUtc: "2022-03-14T19:33:43.430Z",
        location: "westus2",
        messageForActivation: "Sample Activation message",
        partnerDestinationName: "examplePartnerDestinationName1",
        partnerRegistrationImmutableId: "0bd70ee2-7d95-447e-ab1f-c4f320019404",
        resourceGroupName: "examplerg",
    });
    
    resources:
      partnerDestination:
        type: azure-native:eventgrid:PartnerDestination
        properties:
          endpointBaseUrl: https://www.example/endpoint
          endpointServiceContext: This is an example
          expirationTimeIfNotActivatedUtc: 2022-03-14T19:33:43.430Z
          location: westus2
          messageForActivation: Sample Activation message
          partnerDestinationName: examplePartnerDestinationName1
          partnerRegistrationImmutableId: 0bd70ee2-7d95-447e-ab1f-c4f320019404
          resourceGroupName: examplerg
    

    Create PartnerDestination Resource

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

    Constructor syntax

    new PartnerDestination(name: string, args: PartnerDestinationArgs, opts?: CustomResourceOptions);
    @overload
    def PartnerDestination(resource_name: str,
                           args: PartnerDestinationArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def PartnerDestination(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           resource_group_name: Optional[str] = None,
                           activation_state: Optional[Union[str, PartnerDestinationActivationState]] = None,
                           endpoint_base_url: Optional[str] = None,
                           endpoint_service_context: Optional[str] = None,
                           expiration_time_if_not_activated_utc: Optional[str] = None,
                           location: Optional[str] = None,
                           message_for_activation: Optional[str] = None,
                           partner_destination_name: Optional[str] = None,
                           partner_registration_immutable_id: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None)
    func NewPartnerDestination(ctx *Context, name string, args PartnerDestinationArgs, opts ...ResourceOption) (*PartnerDestination, error)
    public PartnerDestination(string name, PartnerDestinationArgs args, CustomResourceOptions? opts = null)
    public PartnerDestination(String name, PartnerDestinationArgs args)
    public PartnerDestination(String name, PartnerDestinationArgs args, CustomResourceOptions options)
    
    type: azure-native:eventgrid:PartnerDestination
    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 PartnerDestinationArgs
    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 PartnerDestinationArgs
    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 PartnerDestinationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PartnerDestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PartnerDestinationArgs
    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 partnerDestinationResource = new AzureNative.EventGrid.PartnerDestination("partnerDestinationResource", new()
    {
        ResourceGroupName = "string",
        ActivationState = "string",
        EndpointBaseUrl = "string",
        EndpointServiceContext = "string",
        ExpirationTimeIfNotActivatedUtc = "string",
        Location = "string",
        MessageForActivation = "string",
        PartnerDestinationName = "string",
        PartnerRegistrationImmutableId = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := eventgrid.NewPartnerDestination(ctx, "partnerDestinationResource", &eventgrid.PartnerDestinationArgs{
    	ResourceGroupName:               pulumi.String("string"),
    	ActivationState:                 pulumi.String("string"),
    	EndpointBaseUrl:                 pulumi.String("string"),
    	EndpointServiceContext:          pulumi.String("string"),
    	ExpirationTimeIfNotActivatedUtc: pulumi.String("string"),
    	Location:                        pulumi.String("string"),
    	MessageForActivation:            pulumi.String("string"),
    	PartnerDestinationName:          pulumi.String("string"),
    	PartnerRegistrationImmutableId:  pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var partnerDestinationResource = new PartnerDestination("partnerDestinationResource", PartnerDestinationArgs.builder()
        .resourceGroupName("string")
        .activationState("string")
        .endpointBaseUrl("string")
        .endpointServiceContext("string")
        .expirationTimeIfNotActivatedUtc("string")
        .location("string")
        .messageForActivation("string")
        .partnerDestinationName("string")
        .partnerRegistrationImmutableId("string")
        .tags(Map.of("string", "string"))
        .build());
    
    partner_destination_resource = azure_native.eventgrid.PartnerDestination("partnerDestinationResource",
        resource_group_name="string",
        activation_state="string",
        endpoint_base_url="string",
        endpoint_service_context="string",
        expiration_time_if_not_activated_utc="string",
        location="string",
        message_for_activation="string",
        partner_destination_name="string",
        partner_registration_immutable_id="string",
        tags={
            "string": "string",
        })
    
    const partnerDestinationResource = new azure_native.eventgrid.PartnerDestination("partnerDestinationResource", {
        resourceGroupName: "string",
        activationState: "string",
        endpointBaseUrl: "string",
        endpointServiceContext: "string",
        expirationTimeIfNotActivatedUtc: "string",
        location: "string",
        messageForActivation: "string",
        partnerDestinationName: "string",
        partnerRegistrationImmutableId: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:eventgrid:PartnerDestination
    properties:
        activationState: string
        endpointBaseUrl: string
        endpointServiceContext: string
        expirationTimeIfNotActivatedUtc: string
        location: string
        messageForActivation: string
        partnerDestinationName: string
        partnerRegistrationImmutableId: string
        resourceGroupName: string
        tags:
            string: string
    

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

    ResourceGroupName string
    The name of the resource group within the user's subscription.
    ActivationState string | Pulumi.AzureNative.EventGrid.PartnerDestinationActivationState
    Activation state of the partner destination.
    EndpointBaseUrl string
    Endpoint Base URL of the partner destination
    EndpointServiceContext string
    Endpoint context associated with this partner destination.
    ExpirationTimeIfNotActivatedUtc string
    Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted.
    Location string
    Location of the resource.
    MessageForActivation string
    Context or helpful message that can be used during the approval process.
    PartnerDestinationName string
    Name of the partner destination.
    PartnerRegistrationImmutableId string
    The immutable Id of the corresponding partner registration.
    Tags Dictionary<string, string>
    Tags of the resource.
    ResourceGroupName string
    The name of the resource group within the user's subscription.
    ActivationState string | PartnerDestinationActivationState
    Activation state of the partner destination.
    EndpointBaseUrl string
    Endpoint Base URL of the partner destination
    EndpointServiceContext string
    Endpoint context associated with this partner destination.
    ExpirationTimeIfNotActivatedUtc string
    Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted.
    Location string
    Location of the resource.
    MessageForActivation string
    Context or helpful message that can be used during the approval process.
    PartnerDestinationName string
    Name of the partner destination.
    PartnerRegistrationImmutableId string
    The immutable Id of the corresponding partner registration.
    Tags map[string]string
    Tags of the resource.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    activationState String | PartnerDestinationActivationState
    Activation state of the partner destination.
    endpointBaseUrl String
    Endpoint Base URL of the partner destination
    endpointServiceContext String
    Endpoint context associated with this partner destination.
    expirationTimeIfNotActivatedUtc String
    Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted.
    location String
    Location of the resource.
    messageForActivation String
    Context or helpful message that can be used during the approval process.
    partnerDestinationName String
    Name of the partner destination.
    partnerRegistrationImmutableId String
    The immutable Id of the corresponding partner registration.
    tags Map<String,String>
    Tags of the resource.
    resourceGroupName string
    The name of the resource group within the user's subscription.
    activationState string | PartnerDestinationActivationState
    Activation state of the partner destination.
    endpointBaseUrl string
    Endpoint Base URL of the partner destination
    endpointServiceContext string
    Endpoint context associated with this partner destination.
    expirationTimeIfNotActivatedUtc string
    Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted.
    location string
    Location of the resource.
    messageForActivation string
    Context or helpful message that can be used during the approval process.
    partnerDestinationName string
    Name of the partner destination.
    partnerRegistrationImmutableId string
    The immutable Id of the corresponding partner registration.
    tags {[key: string]: string}
    Tags of the resource.
    resource_group_name str
    The name of the resource group within the user's subscription.
    activation_state str | PartnerDestinationActivationState
    Activation state of the partner destination.
    endpoint_base_url str
    Endpoint Base URL of the partner destination
    endpoint_service_context str
    Endpoint context associated with this partner destination.
    expiration_time_if_not_activated_utc str
    Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted.
    location str
    Location of the resource.
    message_for_activation str
    Context or helpful message that can be used during the approval process.
    partner_destination_name str
    Name of the partner destination.
    partner_registration_immutable_id str
    The immutable Id of the corresponding partner registration.
    tags Mapping[str, str]
    Tags of the resource.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    activationState String | "NeverActivated" | "Activated"
    Activation state of the partner destination.
    endpointBaseUrl String
    Endpoint Base URL of the partner destination
    endpointServiceContext String
    Endpoint context associated with this partner destination.
    expirationTimeIfNotActivatedUtc String
    Expiration time of the partner destination. If this timer expires and the partner destination was never activated, the partner destination and corresponding channel are deleted.
    location String
    Location of the resource.
    messageForActivation String
    Context or helpful message that can be used during the approval process.
    partnerDestinationName String
    Name of the partner destination.
    partnerRegistrationImmutableId String
    The immutable Id of the corresponding partner registration.
    tags Map<String>
    Tags of the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the resource.
    ProvisioningState string
    Provisioning state of the partner destination.
    SystemData Pulumi.AzureNative.EventGrid.Outputs.SystemDataResponse
    The system metadata relating to Partner Destination resource.
    Type string
    Type of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the resource.
    ProvisioningState string
    Provisioning state of the partner destination.
    SystemData SystemDataResponse
    The system metadata relating to Partner Destination resource.
    Type string
    Type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the resource.
    provisioningState String
    Provisioning state of the partner destination.
    systemData SystemDataResponse
    The system metadata relating to Partner Destination resource.
    type String
    Type of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the resource.
    provisioningState string
    Provisioning state of the partner destination.
    systemData SystemDataResponse
    The system metadata relating to Partner Destination resource.
    type string
    Type of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the resource.
    provisioning_state str
    Provisioning state of the partner destination.
    system_data SystemDataResponse
    The system metadata relating to Partner Destination resource.
    type str
    Type of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the resource.
    provisioningState String
    Provisioning state of the partner destination.
    systemData Property Map
    The system metadata relating to Partner Destination resource.
    type String
    Type of the resource.

    Supporting Types

    PartnerDestinationActivationState, PartnerDestinationActivationStateArgs

    NeverActivated
    NeverActivated
    Activated
    Activated
    PartnerDestinationActivationStateNeverActivated
    NeverActivated
    PartnerDestinationActivationStateActivated
    Activated
    NeverActivated
    NeverActivated
    Activated
    Activated
    NeverActivated
    NeverActivated
    Activated
    Activated
    NEVER_ACTIVATED
    NeverActivated
    ACTIVATED
    Activated
    "NeverActivated"
    NeverActivated
    "Activated"
    Activated

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

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

    $ pulumi import azure-native:eventgrid:PartnerDestination examplePartnerDestinationName1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerDestinations/{partnerDestinationName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.71.0 published on Friday, Nov 8, 2024 by Pulumi