Purview Share Client (preview:2023-05-30)

2025/12/05 • 17 new methods

ReceivedShares_Get (new)
Description :  Get a received share
Reference :  Link ¶

⚼ Request

GET:  /receivedShares/{receivedShareId}
{
receivedShareId:
{
Description: Id of the received share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
ReceivedShares_CreateOrReplace (new)
Description :  Update changes to a received share
Reference :  Link ¶

⚼ Request

PUT:  /receivedShares/{receivedShareId}
{
receivedShareId:
{
Description: Id of the received share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
receivedShare:
{
Description: The received share to create or replace ,
Required: True ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}
,
$schema:
{
Description: A received share data transfer object. ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}
,
$schema:
{
Description: A received share data transfer object. ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
ReceivedShares_Delete (new)
Description :  Delete a received share
Reference :  Link ¶

⚼ Request

DELETE:  /receivedShares/{receivedShareId}
{
receivedShareId:
{
Description: Id of the received share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}
,
$schema:
{
Description: Response for long running operation. ,
}
{
endTime:
{
Description: End time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The purview share error body model. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
id:
{
Description: Job id of the long running operation ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: States for long running operations. ,
Enum:
{
Running: The long running operation is in 'Running' state ,
TransientFailure: The long running operation hit a transient failure ,
Succeeded: The long running operation is in 'Succeeded' state ,
Failed: The long running operation is in 'Failed' state ,
NotStarted: The long running operation has not started ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
ReceivedShares_ListAttached (new)
Description :  List attached received shares
Reference :  Link ¶

⚼ Request

GET:  /receivedShares/attached
{
referenceName:
{
Description: A name that references a data store. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Format: url ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type ReceivedShare ,
Required: True ,
}
[
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
ReceivedShares_ListDetached (new)
Description :  List detached received shares
Reference :  Link ¶

⚼ Request

GET:  /receivedShares/detached
{
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Format: url ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type ReceivedShare ,
Required: True ,
}
[
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_List (new)
Description :  List sent shares
Reference :  Link ¶

⚼ Request

GET:  /sentShares
{
referenceName:
{
Description: A name that references a data store. ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Format: url ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type SentShare ,
Required: True ,
}
[
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_Get (new)
Description :  Get a sent share
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareId}
{
sentShareId:
{
Description: Id of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_CreateOrReplace (new)
Description :  Create or replace a sent share
Reference :  Link ¶

⚼ Request

PUT:  /sentShares/{sentShareId}
{
sentShareId:
{
Description: Id of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
sentShare:
{
Description: The sent share to create or replace. ,
Required: True ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}
,
$schema:
{
Description: A sent share data transfer object. ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}
,
$schema:
{
Description: A sent share data transfer object. ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: The type of share is in-place sharing ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_Delete (new)
Description :  Delete a sent share
Reference :  Link ¶

⚼ Request

DELETE:  /sentShares/{sentShareId}
{
sentShareId:
{
Description: Id of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}
,
$schema:
{
Description: Response for long running operation. ,
}
{
endTime:
{
Description: End time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The purview share error body model. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
id:
{
Description: Job id of the long running operation ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: States for long running operations. ,
Enum:
{
Running: The long running operation is in 'Running' state ,
TransientFailure: The long running operation hit a transient failure ,
Succeeded: The long running operation is in 'Succeeded' state ,
Failed: The long running operation is in 'Failed' state ,
NotStarted: The long running operation has not started ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_ListInvitations (new)
Description :  List sent share recipients
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareId}/sentShareInvitations
{
sentShareId:
{
Description: Id of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Format: url ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type SentShareInvitation ,
Required: True ,
}
[
{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: The invitation is sent to a user ,
Service: The invitation is sent to a service ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_GetInvitation (new)
Description :  Get recipient for a given sent share
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}
{
sentShareId:
{
Description: Id of the sent share ,
Required: True ,
}
string ,
sentShareInvitationId:
{
Description: Id of the sent share invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: The invitation is sent to a user ,
Service: The invitation is sent to a service ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_CreateInvitation (new)
Description :  Create a recipient for a given sent share
Reference :  Link ¶

⚼ Request

PUT:  /sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}
{
sentShareId:
{
Description: Id of the sent share ,
Required: True ,
}
string ,
sentShareInvitationId:
{
Description: Id of the sent share invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
sentShareInvitation:
{
Description: The sent share invitation to create. ,
Required: True ,
}
{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: The invitation is sent to a user ,
Service: The invitation is sent to a service ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: The invitation is sent to a user ,
Service: The invitation is sent to a service ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_DeleteInvitation (new)
Description :  Delete a sent share invitation
Reference :  Link ¶

⚼ Request

DELETE:  /sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}
{
sentShareId:
{
Description: Id of the sent share ,
Required: True ,
}
string ,
sentShareInvitationId:
{
Description: Id of the sent share invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
$headers:
{
operation-location:
{
Description: The URL to track the status of the long running operation. ,
}
string ,
}
,
$schema:
{
Description: Response for long running operation. ,
}
{
endTime:
{
Description: End time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The purview share error body model. ,
Required: False ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
id:
{
Description: Job id of the long running operation ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: States for long running operations. ,
Enum:
{
Running: The long running operation is in 'Running' state ,
TransientFailure: The long running operation hit a transient failure ,
Succeeded: The long running operation is in 'Succeeded' state ,
Failed: The long running operation is in 'Failed' state ,
NotStarted: The long running operation has not started ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
SentShares_NotifyUserInvitation (new)
Description :  Notifies the user recipient of the sent share invitation, does not apply to service invitations.
Reference :  Link ¶

⚼ Request

POST:  /sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}:notify
{
sentShareId:
{
Description: Id of the sent share ,
Required: True ,
}
string ,
sentShareInvitationId:
{
Description: Id of the sent share invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: The invitation is sent to a user ,
Service: The invitation is sent to a service ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
ShareResources_List (new)
Description :  List share resources
Reference :  Link ¶

⚼ Request

GET:  /shareResources
{
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Format: url ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type ShareResource ,
Required: True ,
}
[
{
receivedSharesCount:
{
Description: A count of Received Shares associated with the Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource. ,
Format: int32 ,
Required: False ,
}
integer ,
sentSharesCount:
{
Description: A count of Sent Shares associated with the Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource. ,
Format: int32 ,
Required: False ,
}
integer ,
storeKind:
{
Description: The types of asset. ,
Enum:
{
AdlsGen2Account: The store kind is a Adls Gen 2 storage account ,
BlobAccount: The store kind is a Blob storage account ,
}
,
Required: False ,
}
enum ,
storeReference:
{
Description: A Store Reference for an artifact or sink. ,
Required: False ,
}
{
referenceName:
{
Description: Reference name for resource associated with the sink or artifact. ,
Required: False ,
}
string ,
type:
{
Description: Defines the type of resource being shared ,
Enum:
{
ArmResourceReference: The type of reference is an ARM resource ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
ReceivedShares_ActivateTenantEmailRegistration (new)
Description :  Activates the email registration for current tenant
Reference :  Link ¶

⚼ Request

POST:  /emails:activate
{
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
tenantEmailRegistration:
{
Description: The tenant email registration payload ,
Required: True ,
}
{
properties:
{
Description: Tenant email registration property bag. ,
Required: False ,
}
{
activationCode:
{
Description: Activation code for the registration. ,
Required: True ,
}
string ,
activationExpiration:
{
Description: Date of the activation expiration. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register. ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Defines the supported types for registration. ,
Enum:
{
ActivationPending: The tenant email registration is in pending state ,
Activated: The tenant email registration is complete and has been activated ,
ActivationAttemptsExhausted: The tenant email registration has exhausted the max attempts ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of the resource ,
Enum:
{
Unknown: The state of the resource is 'Unknown' ,
Succeeded: The state of the resource is 'Succeeded' ,
Creating: The state of the resource is 'Creating' ,
Deleting: The state of the resource is 'Deleting' ,
Moving: The state of the resource is 'Moving' ,
Failed: The state of the resource is 'Failed' ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id to register. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Tenant email registration property bag. ,
Required: False ,
}
{
activationCode:
{
Description: Activation code for the registration. ,
Required: True ,
}
string ,
activationExpiration:
{
Description: Date of the activation expiration. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register. ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Defines the supported types for registration. ,
Enum:
{
ActivationPending: The tenant email registration is in pending state ,
Activated: The tenant email registration is complete and has been activated ,
ActivationAttemptsExhausted: The tenant email registration has exhausted the max attempts ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of the resource ,
Enum:
{
Unknown: The state of the resource is 'Unknown' ,
Succeeded: The state of the resource is 'Succeeded' ,
Creating: The state of the resource is 'Creating' ,
Deleting: The state of the resource is 'Deleting' ,
Moving: The state of the resource is 'Moving' ,
Failed: The state of the resource is 'Failed' ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id to register. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}
ReceivedShares_RegisterTenantEmailRegistration (new)
Description :  Register an email for the current tenant
Reference :  Link ¶

⚼ Request

POST:  /emails:register
{
api-version:
{
Description: The api version to use ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Tenant email registration property bag. ,
Required: False ,
}
{
activationCode:
{
Description: Activation code for the registration. ,
Required: True ,
}
string ,
activationExpiration:
{
Description: Date of the activation expiration. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register. ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Defines the supported types for registration. ,
Enum:
{
ActivationPending: The tenant email registration is in pending state ,
Activated: The tenant email registration is complete and has been activated ,
ActivationAttemptsExhausted: The tenant email registration has exhausted the max attempts ,
}
,
Required: False ,
}
enum ,
state:
{
Description: State of the resource ,
Enum:
{
Unknown: The state of the resource is 'Unknown' ,
Succeeded: The state of the resource is 'Succeeded' ,
Creating: The state of the resource is 'Creating' ,
Deleting: The state of the resource is 'Deleting' ,
Moving: The state of the resource is 'Moving' ,
Failed: The state of the resource is 'Failed' ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id to register. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code ,
}
string ,
}
,
$schema:
{
Description: The purview share error model. ,
}
{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
,
}