Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. datashare
  5. Invitation
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.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.datashare.Invitation

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.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

    A Invitation data transfer object. Azure REST API version: 2021-08-01. Prior API version in Azure Native 1.x: 2020-09-01.

    Example Usage

    Invitations_Create

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

return await Deployment.RunAsync(() => 
{
    var invitation = new AzureNative.DataShare.Invitation("invitation", new()
    {
        AccountName = "Account1",
        ExpirationDate = "2020-08-26T22:33:24.5785265Z",
        InvitationName = "Invitation1",
        ResourceGroupName = "SampleResourceGroup",
        ShareName = "Share1",
        TargetEmail = "receiver@microsoft.com",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datashare.NewInvitation(ctx, "invitation", &datashare.InvitationArgs{
			AccountName:       pulumi.String("Account1"),
			ExpirationDate:    pulumi.String("2020-08-26T22:33:24.5785265Z"),
			InvitationName:    pulumi.String("Invitation1"),
			ResourceGroupName: pulumi.String("SampleResourceGroup"),
			ShareName:         pulumi.String("Share1"),
			TargetEmail:       pulumi.String("receiver@microsoft.com"),
		})
		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.datashare.Invitation;
import com.pulumi.azurenative.datashare.InvitationArgs;
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 invitation = new Invitation("invitation", InvitationArgs.builder()        
            .accountName("Account1")
            .expirationDate("2020-08-26T22:33:24.5785265Z")
            .invitationName("Invitation1")
            .resourceGroupName("SampleResourceGroup")
            .shareName("Share1")
            .targetEmail("receiver@microsoft.com")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

invitation = azure_native.datashare.Invitation("invitation",
    account_name="Account1",
    expiration_date="2020-08-26T22:33:24.5785265Z",
    invitation_name="Invitation1",
    resource_group_name="SampleResourceGroup",
    share_name="Share1",
    target_email="receiver@microsoft.com")

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const invitation = new azure_native.datashare.Invitation("invitation", {
    accountName: "Account1",
    expirationDate: "2020-08-26T22:33:24.5785265Z",
    invitationName: "Invitation1",
    resourceGroupName: "SampleResourceGroup",
    shareName: "Share1",
    targetEmail: "receiver@microsoft.com",
});

    resources:
  invitation:
    type: azure-native:datashare:Invitation
    properties:
      accountName: Account1
      expirationDate: 2020-08-26T22:33:24.5785265Z
      invitationName: Invitation1
      resourceGroupName: SampleResourceGroup
      shareName: Share1
      targetEmail: receiver@microsoft.com

    Create Invitation Resource

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

    Constructor syntax

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

@overload
def Invitation(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               account_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               share_name: Optional[str] = None,
               expiration_date: Optional[str] = None,
               invitation_name: Optional[str] = None,
               target_active_directory_id: Optional[str] = None,
               target_email: Optional[str] = None,
               target_object_id: Optional[str] = None)
    func NewInvitation(ctx *Context, name string, args InvitationArgs, opts ...ResourceOption) (*Invitation, error)
    public Invitation(string name, InvitationArgs args, CustomResourceOptions? opts = null)
    public Invitation(String name, InvitationArgs args)
public Invitation(String name, InvitationArgs args, CustomResourceOptions options)

    type: azure-native:datashare:Invitation
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 InvitationArgs
    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 InvitationArgs
    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 InvitationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InvitationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InvitationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var invitationResource = new AzureNative.DataShare.Invitation("invitationResource", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    ShareName = "string",
    ExpirationDate = "string",
    InvitationName = "string",
    TargetActiveDirectoryId = "string",
    TargetEmail = "string",
    TargetObjectId = "string",
});

    example, err := datashare.NewInvitation(ctx, "invitationResource", &datashare.InvitationArgs{
AccountName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ShareName: pulumi.String("string"),
ExpirationDate: pulumi.String("string"),
InvitationName: pulumi.String("string"),
TargetActiveDirectoryId: pulumi.String("string"),
TargetEmail: pulumi.String("string"),
TargetObjectId: pulumi.String("string"),
})

    var invitationResource = new Invitation("invitationResource", InvitationArgs.builder()        
    .accountName("string")
    .resourceGroupName("string")
    .shareName("string")
    .expirationDate("string")
    .invitationName("string")
    .targetActiveDirectoryId("string")
    .targetEmail("string")
    .targetObjectId("string")
    .build());

    invitation_resource = azure_native.datashare.Invitation("invitationResource",
    account_name="string",
    resource_group_name="string",
    share_name="string",
    expiration_date="string",
    invitation_name="string",
    target_active_directory_id="string",
    target_email="string",
    target_object_id="string")

    const invitationResource = new azure_native.datashare.Invitation("invitationResource", {
    accountName: "string",
    resourceGroupName: "string",
    shareName: "string",
    expirationDate: "string",
    invitationName: "string",
    targetActiveDirectoryId: "string",
    targetEmail: "string",
    targetObjectId: "string",
});

    type: azure-native:datashare:Invitation
properties:
    accountName: string
    expirationDate: string
    invitationName: string
    resourceGroupName: string
    shareName: string
    targetActiveDirectoryId: string
    targetEmail: string
    targetObjectId: string

    Invitation Resource Properties

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

    Inputs

    The Invitation resource accepts the following input properties:

    AccountName string
    The name of the share account.
    ResourceGroupName string
    The resource group name.
    ShareName string
    The name of the share to send the invitation for.
    ExpirationDate string
    The expiration date for the invitation and share subscription.
    InvitationName string
    The name of the invitation.
    TargetActiveDirectoryId string
    The target Azure AD Id. Can't be combined with email.
    TargetEmail string
    The email the invitation is directed to.
    TargetObjectId string
    The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.
    AccountName string
    The name of the share account.
    ResourceGroupName string
    The resource group name.
    ShareName string
    The name of the share to send the invitation for.
    ExpirationDate string
    The expiration date for the invitation and share subscription.
    InvitationName string
    The name of the invitation.
    TargetActiveDirectoryId string
    The target Azure AD Id. Can't be combined with email.
    TargetEmail string
    The email the invitation is directed to.
    TargetObjectId string
    The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.
    accountName String
    The name of the share account.
    resourceGroupName String
    The resource group name.
    shareName String
    The name of the share to send the invitation for.
    expirationDate String
    The expiration date for the invitation and share subscription.
    invitationName String
    The name of the invitation.
    targetActiveDirectoryId String
    The target Azure AD Id. Can't be combined with email.
    targetEmail String
    The email the invitation is directed to.
    targetObjectId String
    The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.
    accountName string
    The name of the share account.
    resourceGroupName string
    The resource group name.
    shareName string
    The name of the share to send the invitation for.
    expirationDate string
    The expiration date for the invitation and share subscription.
    invitationName string
    The name of the invitation.
    targetActiveDirectoryId string
    The target Azure AD Id. Can't be combined with email.
    targetEmail string
    The email the invitation is directed to.
    targetObjectId string
    The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.
    account_name str
    The name of the share account.
    resource_group_name str
    The resource group name.
    share_name str
    The name of the share to send the invitation for.
    expiration_date str
    The expiration date for the invitation and share subscription.
    invitation_name str
    The name of the invitation.
    target_active_directory_id str
    The target Azure AD Id. Can't be combined with email.
    target_email str
    The email the invitation is directed to.
    target_object_id str
    The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.
    accountName String
    The name of the share account.
    resourceGroupName String
    The resource group name.
    shareName String
    The name of the share to send the invitation for.
    expirationDate String
    The expiration date for the invitation and share subscription.
    invitationName String
    The name of the invitation.
    targetActiveDirectoryId String
    The target Azure AD Id. Can't be combined with email.
    targetEmail String
    The email the invitation is directed to.
    targetObjectId String
    The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    InvitationId string
    unique invitation id
    InvitationStatus string
    The status of the invitation.
    Name string
    Name of the azure resource
    RespondedAt string
    The time the recipient responded to the invitation.
    SentAt string
    Gets the time at which the invitation was sent.
    SystemData Pulumi.AzureNative.DataShare.Outputs.SystemDataResponse
    System Data of the Azure resource.
    Type string
    Type of the azure resource
    UserEmail string
    Email of the user who created the resource
    UserName string
    Name of the user who created the resource
    Id string
    The provider-assigned unique ID for this managed resource.
    InvitationId string
    unique invitation id
    InvitationStatus string
    The status of the invitation.
    Name string
    Name of the azure resource
    RespondedAt string
    The time the recipient responded to the invitation.
    SentAt string
    Gets the time at which the invitation was sent.
    SystemData SystemDataResponse
    System Data of the Azure resource.
    Type string
    Type of the azure resource
    UserEmail string
    Email of the user who created the resource
    UserName string
    Name of the user who created the resource
    id String
    The provider-assigned unique ID for this managed resource.
    invitationId String
    unique invitation id
    invitationStatus String
    The status of the invitation.
    name String
    Name of the azure resource
    respondedAt String
    The time the recipient responded to the invitation.
    sentAt String
    Gets the time at which the invitation was sent.
    systemData SystemDataResponse
    System Data of the Azure resource.
    type String
    Type of the azure resource
    userEmail String
    Email of the user who created the resource
    userName String
    Name of the user who created the resource
    id string
    The provider-assigned unique ID for this managed resource.
    invitationId string
    unique invitation id
    invitationStatus string
    The status of the invitation.
    name string
    Name of the azure resource
    respondedAt string
    The time the recipient responded to the invitation.
    sentAt string
    Gets the time at which the invitation was sent.
    systemData SystemDataResponse
    System Data of the Azure resource.
    type string
    Type of the azure resource
    userEmail string
    Email of the user who created the resource
    userName string
    Name of the user who created the resource
    id str
    The provider-assigned unique ID for this managed resource.
    invitation_id str
    unique invitation id
    invitation_status str
    The status of the invitation.
    name str
    Name of the azure resource
    responded_at str
    The time the recipient responded to the invitation.
    sent_at str
    Gets the time at which the invitation was sent.
    system_data SystemDataResponse
    System Data of the Azure resource.
    type str
    Type of the azure resource
    user_email str
    Email of the user who created the resource
    user_name str
    Name of the user who created the resource
    id String
    The provider-assigned unique ID for this managed resource.
    invitationId String
    unique invitation id
    invitationStatus String
    The status of the invitation.
    name String
    Name of the azure resource
    respondedAt String
    The time the recipient responded to the invitation.
    sentAt String
    Gets the time at which the invitation was sent.
    systemData Property Map
    System Data of the Azure resource.
    type String
    Type of the azure resource
    userEmail String
    Email of the user who created the resource
    userName String
    Name of the user who created the resource

    Supporting Types

    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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 type of identity that last modified the resource.
    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:datashare:Invitation Invitation1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/invitations/{invitationName}

    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.38.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure-native