New-AzDataShareInvitation
Creates an invitation for share.
Syntax
ByFieldsParameterSet (Default)
New-AzDataShareInvitation
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByInvitationEmailParameterSet
New-AzDataShareInvitation
-ResourceGroupName <String>
-AccountName <String>
-ShareName <String>
-Name <String>
-TargetEmail <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByInvitationTenantParameterSet
New-AzDataShareInvitation
-ResourceGroupName <String>
-AccountName <String>
-ShareName <String>
-Name <String>
-TargetObjectId <String>
-TargetTenantId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzDataShareInvitation cmdlet sends an invitation to the target consumer with information about the provider share.
Examples
Example 1
New-AzDataShareInvitation -ResourceGroupName "ADS" -AccountName "WikiAds" -ShareName "AdsShare" -Name "AdsInvitation" -TargetEmail "adstest@microsoft.com"
InvitationId : 167e06ff-567f-4bc7-be0c-645a6de710f3
InvitationStatus : Pending
Sender : adsprovider@microsoft.com
SentAt : 7/8/2019 10:47:10 PM
TargetEmail : adstest@microsoft.com
TargetObjectId :
TargetTenantId :
Id : /subscriptions/1834da9b-787a-44f6-ae81-60707ab8c957/resourceGroups/ADS/ providers/Microsoft.DataShare/accounts/WikiAds/shares/AdsShare/invitations/AdsInvitation
Name : AdsInvitation
Type : Microsoft.DataShare/Invitations
This command creates an invitation AdsInvitation for share AdsShare and sends it to target email adstest@microsoft.com.
Parameters
-AccountName
Azure data share account name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByInvitationEmailParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ByInvitationTenantParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Azure data share invitation name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByInvitationEmailParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ByInvitationTenantParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The resource group name of the azure data share account
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByInvitationEmailParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ByInvitationTenantParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ShareName
Azure data share name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByInvitationEmailParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ByInvitationTenantParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TargetEmail
Target email id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByInvitationEmailParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TargetObjectId
Target object id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByInvitationTenantParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TargetTenantId
Target tenant id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByInvitationTenantParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
None
Outputs
