Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. datashare
  5. getInvitation
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.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.datashare.getInvitation

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.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Get an invitation in a share Azure REST API version: 2021-08-01.

    Using getInvitation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInvitation(args: GetInvitationArgs, opts?: InvokeOptions): Promise<GetInvitationResult>
function getInvitationOutput(args: GetInvitationOutputArgs, opts?: InvokeOptions): Output<GetInvitationResult>
    def get_invitation(account_name: Optional[str] = None,
                   invitation_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   share_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetInvitationResult
def get_invitation_output(account_name: Optional[pulumi.Input[str]] = None,
                   invitation_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   share_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetInvitationResult]
    func LookupInvitation(ctx *Context, args *LookupInvitationArgs, opts ...InvokeOption) (*LookupInvitationResult, error)
func LookupInvitationOutput(ctx *Context, args *LookupInvitationOutputArgs, opts ...InvokeOption) LookupInvitationResultOutput

    > Note: This function is named LookupInvitation in the Go SDK.

    public static class GetInvitation 
{
    public static Task<GetInvitationResult> InvokeAsync(GetInvitationArgs args, InvokeOptions? opts = null)
    public static Output<GetInvitationResult> Invoke(GetInvitationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInvitationResult> getInvitation(GetInvitationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:datashare:getInvitation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of the share account.
    InvitationName string
    The name of the invitation.
    ResourceGroupName string
    The resource group name.
    ShareName string
    The name of the share.
    AccountName string
    The name of the share account.
    InvitationName string
    The name of the invitation.
    ResourceGroupName string
    The resource group name.
    ShareName string
    The name of the share.
    accountName String
    The name of the share account.
    invitationName String
    The name of the invitation.
    resourceGroupName String
    The resource group name.
    shareName String
    The name of the share.
    accountName string
    The name of the share account.
    invitationName string
    The name of the invitation.
    resourceGroupName string
    The resource group name.
    shareName string
    The name of the share.
    account_name str
    The name of the share account.
    invitation_name str
    The name of the invitation.
    resource_group_name str
    The resource group name.
    share_name str
    The name of the share.
    accountName String
    The name of the share account.
    invitationName String
    The name of the invitation.
    resourceGroupName String
    The resource group name.
    shareName String
    The name of the share.

    getInvitation Result

    The following output properties are available:

    Id string
    The resource id of the azure 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
    ExpirationDate string
    The expiration date for the invitation and share subscription.
    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.
    Id string
    The resource id of the azure 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
    ExpirationDate string
    The expiration date for the invitation and share subscription.
    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.
    id String
    The resource id of the azure 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
    expirationDate String
    The expiration date for the invitation and share subscription.
    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.
    id string
    The resource id of the azure 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
    expirationDate string
    The expiration date for the invitation and share subscription.
    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.
    id str
    The resource id of the azure 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
    expiration_date str
    The expiration date for the invitation and share subscription.
    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.
    id String
    The resource id of the azure 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
    expirationDate String
    The expiration date for the invitation and share subscription.
    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.

    Supporting Types

    SystemDataResponse

    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.

    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.47.1 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure-native