Consumer Invitations - Reject Invitation
Rejects the invitation identified by invitationId
Reject an invitation
POST https://management.azure.com/providers/Microsoft.DataShare/locations/{location}/rejectInvitation?api-version=2021-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
location
|
path | True |
string |
Location of the invitation |
api-version
|
query | True |
string |
The api version to use. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
properties.invitationId | True |
string |
Unique id of the invitation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
An error response received from the Microsoft.DataShare resource provider. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
ConsumerInvitations_RejectInvitation
Sample Request
Sample Response
Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
{
"properties": {
"location": "eastus2",
"invitationId": "4256e2cf-0f82-4865-961b-12f83333f487",
"providerName": "John Smith",
"providerEmail": "john.smith@microsoft.com",
"providerTenantName": "microsoft",
"sentAt": "2019-01-15T01:45:25.6226946Z",
"respondedAt": "2019-01-15T02:01:51.8953054Z",
"invitationStatus": "Rejected",
"description": "Some share",
"termsOfUse": "Confidential",
"dataSetCount": 1,
"shareName": "share1",
"expirationDate": "2020-08-26T22:33:24.5785265Z"
},
"id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487",
"name": "invitation1",
"type": "Microsoft.DataShare/locations/consumerInvitations"
}
Definitions
Name | Description |
---|---|
Consumer |
A consumer Invitation data transfer object. |
created |
The type of identity that created the resource. |
Data |
The data share error model. |
Data |
The data share error body model. |
invitation |
The status of the invitation. |
last |
The type of identity that last modified the resource. |
System |
Metadata pertaining to creation and last modification of the resource. |
ConsumerInvitation
A consumer Invitation data transfer object.
Name | Type | Description |
---|---|---|
id |
string |
The resource id of the azure resource |
name |
string |
Name of the azure resource |
properties.dataSetCount |
integer |
Number of data sets in a share |
properties.description |
string |
Description shared when the invitation was created |
properties.expirationDate |
string |
The expiration date for the share subscription created by accepting the invitation. |
properties.invitationId |
string |
Unique id of the invitation. |
properties.invitationStatus |
The status of the invitation. |
|
properties.location |
string |
invitation location |
properties.providerEmail |
string |
Email of the provider who created the resource |
properties.providerName |
string |
Name of the provider who created the resource |
properties.providerTenantName |
string |
Tenant name of the provider who created the resource |
properties.respondedAt |
string |
The time the recipient responded to the invitation. |
properties.sentAt |
string |
Gets the time at which the invitation was sent. |
properties.shareName |
string |
Gets the source share Name. |
properties.termsOfUse |
string |
Terms of use shared when the invitation was created |
properties.userEmail |
string |
Email of the user who created the resource |
properties.userName |
string |
Name of the user who created the resource |
systemData |
System Data of the Azure resource. |
|
type |
string |
Type of the azure resource |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DataShareError
The data share error model.
Name | Type | Description |
---|---|---|
error |
The data share error body |
DataShareErrorInfo
The data share error body model.
Name | Type | Description |
---|---|---|
code |
string |
Code of the error |
details |
Nested details of the error model |
|
message |
string |
Message of the error |
target |
string |
Target of the error |
invitationStatus
The status of the invitation.
Name | Type | Description |
---|---|---|
Accepted |
string |
|
Pending |
string |
|
Rejected |
string |
|
Withdrawn |
string |
lastModifiedByType
The type of identity that last modified the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
SystemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
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 |
The type of identity that last modified the resource. |