Microsoft.DataShare accounts/shares/invitations 2019-11-01

  • Article

Bicep resource definition

The accounts/shares/invitations resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataShare/accounts/shares/invitations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataShare/accounts/shares/invitations@2019-11-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    targetActiveDirectoryId: 'string'
    targetEmail: 'string'
    targetObjectId: 'string'
  }
}

Property values

accounts/shares/invitations

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: shares
properties Properties on the Invitation InvitationProperties

InvitationProperties

Name Description Value
targetActiveDirectoryId The target Azure AD Id. Can't be combined with email. string
targetEmail The email the invitation is directed to. string
targetObjectId 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.		 string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a data share from a storage account

Deploy to Azure		 This template creates a data share from a storage account

ARM template resource definition

The accounts/shares/invitations resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataShare/accounts/shares/invitations resource, add the following JSON to your template.

{
  "type": "Microsoft.DataShare/accounts/shares/invitations",
  "apiVersion": "2019-11-01",
  "name": "string",
  "properties": {
    "targetActiveDirectoryId": "string",
    "targetEmail": "string",
    "targetObjectId": "string"
  }
}

Property values

accounts/shares/invitations

Name Description Value
type The resource type 'Microsoft.DataShare/accounts/shares/invitations'
apiVersion The resource api version '2019-11-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Properties on the Invitation InvitationProperties

InvitationProperties

Name Description Value
targetActiveDirectoryId The target Azure AD Id. Can't be combined with email. string
targetEmail The email the invitation is directed to. string
targetObjectId 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.		 string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create a data share from a storage account

Deploy to Azure		 This template creates a data share from a storage account

Terraform (AzAPI provider) resource definition

The accounts/shares/invitations resource type can be deployed to:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataShare/accounts/shares/invitations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataShare/accounts/shares/invitations@2019-11-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      targetActiveDirectoryId = "string"
      targetEmail = "string"
      targetObjectId = "string"
    }
  })
}

Property values

accounts/shares/invitations

Name Description Value
type The resource type "Microsoft.DataShare/accounts/shares/invitations@2019-11-01"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: shares
properties Properties on the Invitation InvitationProperties

InvitationProperties

Name Description Value
targetActiveDirectoryId The target Azure AD Id. Can't be combined with email. string
targetEmail The email the invitation is directed to. string
targetObjectId 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.		 string