@datafire/azure_datashare_datashare v3.0.0

@datafire/azure_datashare_datashare

Client library for DataShareManagementClient

Installation and Usage

npm install --save @datafire/azure_datashare_datashare

let azure_datashare_datashare = require('@datafire/azure_datashare_datashare').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Creates a Microsoft.DataShare management client.

Actions

ConsumerInvitations_ListInvitations

Lists invitations

azure_datashare_datashare.ConsumerInvitations_ListInvitations({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: The api version to use.
  • $skipToken string: The continuation token

Output

• output ConsumerInvitationList

ConsumerInvitations_RejectInvitation

Reject an invitation

azure_datashare_datashare.ConsumerInvitations_RejectInvitation({
  "location": "",
  "invitation": {
    "properties": {
      "invitationId": ""
    }
  },
  "api-version": ""
}, context)

Input

• input object
  • location required string: Location of the invitation
  • invitation required ConsumerInvitation
  • api-version required string: The api version to use.

Output

• output ConsumerInvitation

ConsumerInvitations_Get

Get an invitation

azure_datashare_datashare.ConsumerInvitations_Get({
  "location": "",
  "invitationId": "",
  "api-version": ""
}, context)

Input

• input object
  • location required string: Location of the invitation
  • invitationId required string: An invitation id
  • api-version required string: The api version to use.

Output

• output ConsumerInvitation

Operations_List

List of available operations

azure_datashare_datashare.Operations_List({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: The api version to use.

Output

• output OperationList

Accounts_ListBySubscription

List Accounts in Subscription

azure_datashare_datashare.Accounts_ListBySubscription({
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output AccountList

Accounts_ListByResourceGroup

List Accounts in ResourceGroup

azure_datashare_datashare.Accounts_ListByResourceGroup({
  "subscriptionId": "",
  "resourceGroupName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output AccountList

Accounts_Delete

DeleteAccount

azure_datashare_datashare.Accounts_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • api-version required string: The api version to use.

Output

• output OperationResponse

Accounts_Get

Get an account

azure_datashare_datashare.Accounts_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • api-version required string: The api version to use.

Output

• output Account

Accounts_Update

Patch an account

azure_datashare_datashare.Accounts_Update({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "accountUpdateParameters": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • accountUpdateParameters required AccountUpdateParameters
  • api-version required string: The api version to use.

Output

• output Account

Accounts_Create

Create an account

azure_datashare_datashare.Accounts_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "account": {
    "identity": {}
  },
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • account required Account
  • api-version required string: The api version to use.

Output

• output Account

ShareSubscriptions_ListByAccount

List share subscriptions in an account

azure_datashare_datashare.ShareSubscriptions_ListByAccount({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation Token

Output

• output ShareSubscriptionList

ShareSubscriptions_Delete

Delete a shareSubscription in an account

azure_datashare_datashare.ShareSubscriptions_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • api-version required string: The api version to use.

Output

• output OperationResponse

ShareSubscriptions_Get

Get a shareSubscription in an account

azure_datashare_datashare.ShareSubscriptions_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • api-version required string: The api version to use.

Output

• output ShareSubscription

ShareSubscriptions_Create

Create a shareSubscription in an account

azure_datashare_datashare.ShareSubscriptions_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "shareSubscription": {
    "properties": {
      "invitationId": "",
      "sourceShareLocation": ""
    }
  },
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • shareSubscription required ShareSubscription
  • api-version required string: The api version to use.

Output

• output ShareSubscription

ConsumerSourceDataSets_ListByShareSubscription

Get source dataSets of a shareSubscription

azure_datashare_datashare.ConsumerSourceDataSets_ListByShareSubscription({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output ConsumerSourceDataSetList

ShareSubscriptions_Synchronize

Initiate a copy

azure_datashare_datashare.ShareSubscriptions_Synchronize({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "synchronize": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of share subscription
  • synchronize required Synchronize
  • api-version required string: The api version to use.

Output

• output ShareSubscriptionSynchronization

ShareSubscriptions_CancelSynchronization

Request to cancel a synchronization.

azure_datashare_datashare.ShareSubscriptions_CancelSynchronization({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "shareSubscriptionSynchronization": {
    "synchronizationId": ""
  },
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • shareSubscriptionSynchronization required ShareSubscriptionSynchronization
  • api-version required string: The api version to use.

Output

• output ShareSubscriptionSynchronization

DataSetMappings_ListByShareSubscription

List DataSetMappings in a share subscription

azure_datashare_datashare.DataSetMappings_ListByShareSubscription({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the share subscription.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output DataSetMappingList

DataSetMappings_Delete

Delete a DataSetMapping in a shareSubscription

azure_datashare_datashare.DataSetMappings_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "dataSetMappingName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • dataSetMappingName required string: The name of the dataSetMapping.
  • api-version required string: The api version to use.

Output

Output schema unknown

DataSetMappings_Get

Get a DataSetMapping in a shareSubscription

azure_datashare_datashare.DataSetMappings_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "dataSetMappingName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • dataSetMappingName required string: The name of the dataSetMapping.
  • api-version required string: The api version to use.

Output

• output DataSetMapping

DataSetMappings_Create

Create a DataSetMapping

azure_datashare_datashare.DataSetMappings_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "dataSetMappingName": "",
  "dataSetMapping": {
    "kind": ""
  },
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the share subscription which will hold the data set sink.
  • dataSetMappingName required string: The name of the data set mapping to be created.
  • dataSetMapping required DataSetMapping
  • api-version required string: The api version to use.

Output

• output DataSetMapping

ShareSubscriptions_ListSourceShareSynchronizationSettings

Get synchronization settings set on a share

azure_datashare_datashare.ShareSubscriptions_ListSourceShareSynchronizationSettings({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output SourceShareSynchronizationSettingList

ShareSubscriptions_ListSynchronizationDetails

List synchronization details

azure_datashare_datashare.ShareSubscriptions_ListSynchronizationDetails({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "shareSubscriptionSynchronization": {
    "synchronizationId": ""
  },
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the share subscription.
  • shareSubscriptionSynchronization required ShareSubscriptionSynchronization
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output SynchronizationDetailsList

ShareSubscriptions_ListSynchronizations

List synchronizations of a share subscription

azure_datashare_datashare.ShareSubscriptions_ListSynchronizations({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the share subscription.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output ShareSubscriptionSynchronizationList

Triggers_ListByShareSubscription

List Triggers in a share subscription

azure_datashare_datashare.Triggers_ListByShareSubscription({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the share subscription.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output TriggerList

Triggers_Delete

Delete a Trigger in a shareSubscription

azure_datashare_datashare.Triggers_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "triggerName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • triggerName required string: The name of the trigger.
  • api-version required string: The api version to use.

Output

• output OperationResponse

Triggers_Get

Get a Trigger in a shareSubscription

azure_datashare_datashare.Triggers_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "triggerName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the shareSubscription.
  • triggerName required string: The name of the trigger.
  • api-version required string: The api version to use.

Output

• output Trigger

Triggers_Create

Create a Trigger

azure_datashare_datashare.Triggers_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareSubscriptionName": "",
  "triggerName": "",
  "trigger": {
    "kind": ""
  },
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareSubscriptionName required string: The name of the share subscription which will hold the data set sink.
  • triggerName required string: The name of the trigger.
  • trigger required Trigger
  • api-version required string: The api version to use.

Output

• output Trigger

Shares_ListByAccount

List shares in an account

azure_datashare_datashare.Shares_ListByAccount({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation Token

Output

• output ShareList

Shares_Delete

Delete a share

azure_datashare_datashare.Shares_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • api-version required string: The api version to use.

Output

• output OperationResponse

Shares_Get

Get a share

azure_datashare_datashare.Shares_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share to retrieve.
  • api-version required string: The api version to use.

Output

• output Share

Shares_Create

Create a share

azure_datashare_datashare.Shares_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "share": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • share required Share
  • api-version required string: The api version to use.

Output

• output Share

DataSets_ListByShare

List DataSets in a share

azure_datashare_datashare.DataSets_ListByShare({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • api-version required string: The api version to use.
  • $skipToken string: continuation token

Output

• output DataSetList

DataSets_Delete

Delete a DataSet in a share

azure_datashare_datashare.DataSets_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "dataSetName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • dataSetName required string: The name of the dataSet.
  • api-version required string: The api version to use.

Output

Output schema unknown

DataSets_Get

Get a DataSet in a share

azure_datashare_datashare.DataSets_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "dataSetName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • dataSetName required string: The name of the dataSet.
  • api-version required string: The api version to use.

Output

• output DataSet

DataSets_Create

Create a DataSet

azure_datashare_datashare.DataSets_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "dataSetName": "",
  "dataSet": {
    "kind": ""
  },
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share to add the data set to.
  • dataSetName required string: The name of the dataSet.
  • dataSet required DataSet
  • api-version required string: The api version to use.

Output

• output DataSet

Invitations_ListByShare

List invitations in a share

azure_datashare_datashare.Invitations_ListByShare({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • api-version required string: The api version to use.
  • $skipToken string: The continuation token

Output

• output InvitationList

Invitations_Delete

Delete an invitation in a share

azure_datashare_datashare.Invitations_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "invitationName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • invitationName required string: The name of the invitation.
  • api-version required string: The api version to use.

Output

Output schema unknown

Invitations_Get

Get an invitation in a share

azure_datashare_datashare.Invitations_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "invitationName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • invitationName required string: The name of the invitation.
  • api-version required string: The api version to use.

Output

• output Invitation

Invitations_Create

Create an invitation

azure_datashare_datashare.Invitations_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "invitationName": "",
  "invitation": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share to send the invitation for.
  • invitationName required string: The name of the invitation.
  • invitation required Invitation
  • api-version required string: The api version to use.

Output

• output Invitation

Shares_ListSynchronizationDetails

List synchronization details

azure_datashare_datashare.Shares_ListSynchronizationDetails({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "shareSynchronization": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • shareSynchronization required ShareSynchronization
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output SynchronizationDetailsList

Shares_ListSynchronizations

List synchronizations of a share

azure_datashare_datashare.Shares_ListSynchronizations({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation token

Output

• output ShareSynchronizationList

ProviderShareSubscriptions_ListByShare

List share subscriptions in a provider share

azure_datashare_datashare.ProviderShareSubscriptions_ListByShare({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • api-version required string: The api version to use.
  • $skipToken string: Continuation Token

Output

• output ProviderShareSubscriptionList

ProviderShareSubscriptions_GetByShare

Get share subscription in a provider share

azure_datashare_datashare.ProviderShareSubscriptions_GetByShare({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "providerShareSubscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • providerShareSubscriptionId required string: To locate shareSubscription
  • api-version required string: The api version to use.

Output

• output ProviderShareSubscription

ProviderShareSubscriptions_Reinstate

Reinstate share subscription in a provider share

azure_datashare_datashare.ProviderShareSubscriptions_Reinstate({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "providerShareSubscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • providerShareSubscriptionId required string: To locate shareSubscription
  • api-version required string: The api version to use.

Output

• output ProviderShareSubscription

ProviderShareSubscriptions_Revoke

Revoke share subscription in a provider share

azure_datashare_datashare.ProviderShareSubscriptions_Revoke({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "providerShareSubscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • providerShareSubscriptionId required string: To locate shareSubscription
  • api-version required string: The api version to use.

Output

• output ProviderShareSubscription

SynchronizationSettings_ListByShare

List synchronizationSettings in a share

azure_datashare_datashare.SynchronizationSettings_ListByShare({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • api-version required string: The api version to use.
  • $skipToken string: continuation token

Output

• output SynchronizationSettingList

SynchronizationSettings_Delete

Delete a synchronizationSetting in a share

azure_datashare_datashare.SynchronizationSettings_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "synchronizationSettingName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • synchronizationSettingName required string: The name of the synchronizationSetting .
  • api-version required string: The api version to use.

Output

• output OperationResponse

SynchronizationSettings_Get

Get a synchronizationSetting in a share

azure_datashare_datashare.SynchronizationSettings_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "synchronizationSettingName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share.
  • synchronizationSettingName required string: The name of the synchronizationSetting.
  • api-version required string: The api version to use.

Output

• output SynchronizationSetting

SynchronizationSettings_Create

Create or update a synchronizationSetting

azure_datashare_datashare.SynchronizationSettings_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "shareName": "",
  "synchronizationSettingName": "",
  "synchronizationSetting": {
    "kind": ""
  },
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: The subscription identifier
  • resourceGroupName required string: The resource group name.
  • accountName required string: The name of the share account.
  • shareName required string: The name of the share to add the synchronization setting to.
  • synchronizationSettingName required string: The name of the synchronizationSetting.
  • synchronizationSetting required SynchronizationSetting
  • api-version required string: The api version to use.

Output

• output SynchronizationSetting

Definitions

ADLSGen1FileDataSet

• ADLSGen1FileDataSet object: An ADLS Gen 1 file data set.
  • properties required ADLSGen1FileProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ADLSGen1FileProperties

• ADLSGen1FileProperties object: Properties of the ADLS Gen1 file data set.
  • accountName required string: The ADLS account name.
  • dataSetId string: Unique id for identifying a data set resource
  • fileName required string: The file name in the ADLS account.
  • folderPath required string: The folder path within the ADLS account.
  • resourceGroup required string: Resource group of ADLS account.
  • subscriptionId required string: Subscription id of ADLS account.

ADLSGen1FolderDataSet

• ADLSGen1FolderDataSet object: An ADLS Gen 1 folder data set.
  • properties required ADLSGen1FolderProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ADLSGen1FolderProperties

• ADLSGen1FolderProperties object: Properties of the ADLS Gen1 folder data set.
  • accountName required string: The ADLS account name.
  • dataSetId string: Unique id for identifying a data set resource
  • folderPath required string: The folder path within the ADLS account.
  • resourceGroup required string: Resource group of ADLS account.
  • subscriptionId required string: Subscription id of ADLS account.

ADLSGen2FileDataSet

• ADLSGen2FileDataSet object: An ADLS Gen 2 file data set.
  • properties required ADLSGen2FileProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ADLSGen2FileDataSetMapping

• ADLSGen2FileDataSetMapping object: An ADLS Gen2 file data set mapping.
  • properties required ADLSGen2FileDataSetMappingProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ADLSGen2FileDataSetMappingProperties

• ADLSGen2FileDataSetMappingProperties object: ADLS Gen 2 file data set mapping property bag.
  • dataSetId required string: The id of the source data set.
  • dataSetMappingStatus string (values: Ok, Broken): Gets the status of the data set mapping.
  • filePath required string: File path within the file system.
  • fileSystem required string: File system to which the file belongs.
  • outputType string (values: Csv, Parquet): Type of output file
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the data set mapping.
  • resourceGroup required string: Resource group of storage account.
  • storageAccountName required string: Storage account name of the source data set.
  • subscriptionId required string: Subscription id of storage account.

ADLSGen2FileProperties

• ADLSGen2FileProperties object: Properties of the ADLS Gen2 file data set.
  • dataSetId string: Unique id for identifying a data set resource
  • filePath required string: File path within the file system.
  • fileSystem required string: File system to which the file belongs.
  • resourceGroup required string: Resource group of storage account
  • storageAccountName required string: Storage account name of the source data set
  • subscriptionId required string: Subscription id of storage account

ADLSGen2FileSystemDataSet

• ADLSGen2FileSystemDataSet object: An ADLS Gen 2 file system data set.
  • properties required ADLSGen2FileSystemProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ADLSGen2FileSystemDataSetMapping

• ADLSGen2FileSystemDataSetMapping object: An ADLS Gen2 file system data set mapping.
  • properties required ADLSGen2FileSystemDataSetMappingProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ADLSGen2FileSystemDataSetMappingProperties

• ADLSGen2FileSystemDataSetMappingProperties object: ADLS Gen 2 file system data set mapping property bag.
  • dataSetId required string: The id of the source data set.
  • dataSetMappingStatus string (values: Ok, Broken): Gets the status of the data set mapping.
  • fileSystem required string: The file system name.
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the data set mapping.
  • resourceGroup required string: Resource group of storage account.
  • storageAccountName required string: Storage account name of the source data set.
  • subscriptionId required string: Subscription id of storage account.

ADLSGen2FileSystemProperties

• ADLSGen2FileSystemProperties object: Properties of the ADLS Gen2 file system data set.
  • dataSetId string: Unique id for identifying a data set resource
  • fileSystem required string: The file system name.
  • resourceGroup required string: Resource group of storage account
  • storageAccountName required string: Storage account name of the source data set
  • subscriptionId required string: Subscription id of storage account

ADLSGen2FolderDataSet

• ADLSGen2FolderDataSet object: An ADLS Gen 2 folder data set.
  • properties required ADLSGen2FolderProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ADLSGen2FolderDataSetMapping

• ADLSGen2FolderDataSetMapping object: An ADLS Gen2 folder data set mapping.
  • properties required ADLSGen2FolderDataSetMappingProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ADLSGen2FolderDataSetMappingProperties

• ADLSGen2FolderDataSetMappingProperties object: ADLS Gen 2 folder data set mapping property bag.
  • dataSetId required string: The id of the source data set.
  • dataSetMappingStatus string (values: Ok, Broken): Gets the status of the data set mapping.
  • fileSystem required string: File system to which the folder belongs.
  • folderPath required string: Folder path within the file system.
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the data set mapping.
  • resourceGroup required string: Resource group of storage account.
  • storageAccountName required string: Storage account name of the source data set.
  • subscriptionId required string: Subscription id of storage account.

ADLSGen2FolderProperties

• ADLSGen2FolderProperties object: Properties of the ADLS Gen2 folder data set.
  • dataSetId string: Unique id for identifying a data set resource
  • fileSystem required string: File system to which the folder belongs.
  • folderPath required string: Folder path within the file system.
  • resourceGroup required string: Resource group of storage account
  • storageAccountName required string: Storage account name of the source data set
  • subscriptionId required string: Subscription id of storage account

Account

• Account object: An account data transfer object.
  • identity required Identity
  • properties AccountProperties
  • id string: The resource id of the azure resource
  • location string: Location of the azure resource.
  • name string: Name of the azure resource
  • tags object: Tags on the azure resource.
  • type string: Type of the azure resource

AccountList

• AccountList object: List response for get Accounts.
  • nextLink string: The Url of next result page.
  • value required array: Collection of items of type DataTransferObjects.
    • items Account

AccountProperties

• AccountProperties object: Account property bag.
  • createdAt string: Time at which the account was created.
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the Account
  • userEmail string: Email of the user who created the resource
  • userName string: Name of the user who created the resource

AccountUpdateParameters

• AccountUpdateParameters object: Update parameters for accounts
  • tags object: Tags on the azure resource.

BlobContainerDataSet

• BlobContainerDataSet object: An Azure storage blob container data set.
  • properties required BlobContainerProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

BlobContainerDataSetMapping

• BlobContainerDataSetMapping object: A Blob container data set mapping.
  • properties required BlobContainerMappingProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

BlobContainerMappingProperties

• BlobContainerMappingProperties object: Azure storage Blob container data set mapping property bag.
  • containerName required string: BLOB Container name.
  • dataSetId required string: The id of the source data set.
  • dataSetMappingStatus string (values: Ok, Broken): Gets the status of the data set mapping.
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the data set mapping.
  • resourceGroup required string: Resource group of storage account.
  • storageAccountName required string: Storage account name of the source data set.
  • subscriptionId required string: Subscription id of storage account.

BlobContainerProperties

• BlobContainerProperties object: Properties of the BLOB container data set.
  • containerName required string: BLOB Container name.
  • dataSetId string: Unique id for identifying a data set resource
  • resourceGroup required string: Resource group of storage account
  • storageAccountName required string: Storage account name of the source data set
  • subscriptionId required string: Subscription id of storage account

BlobDataSet

• BlobDataSet object: An Azure storage blob data set.
  • properties required BlobProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

BlobDataSetMapping

• BlobDataSetMapping object: A Blob data set mapping.
  • properties required BlobMappingProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

BlobFolderDataSet

• BlobFolderDataSet object: An Azure storage blob folder data set.
  • properties required BlobFolderProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

BlobFolderDataSetMapping

• BlobFolderDataSetMapping object: A Blob folder data set mapping.
  • properties required BlobFolderMappingProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

BlobFolderMappingProperties

• BlobFolderMappingProperties object: Azure storage Blob folder data set mapping property bag.
  • containerName required string: Container that has the file path.
  • dataSetId required string: The id of the source data set.
  • dataSetMappingStatus string (values: Ok, Broken): Gets the status of the data set mapping.
  • prefix required string: Prefix for blob folder
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the data set mapping.
  • resourceGroup required string: Resource group of storage account.
  • storageAccountName required string: Storage account name of the source data set.
  • subscriptionId required string: Subscription id of storage account.

BlobFolderProperties

• BlobFolderProperties object: Properties of the blob folder data set.
  • containerName required string: Container that has the file path.
  • dataSetId string: Unique id for identifying a data set resource
  • prefix required string: Prefix for blob folder
  • resourceGroup required string: Resource group of storage account
  • storageAccountName required string: Storage account name of the source data set
  • subscriptionId required string: Subscription id of storage account

BlobMappingProperties

• BlobMappingProperties object: Azure storage Blob data set mapping property bag.
  • containerName required string: Container that has the file path.
  • dataSetId required string: The id of the source data set.
  • dataSetMappingStatus string (values: Ok, Broken): Gets the status of the data set mapping.
  • filePath required string: File path within the source data set
  • outputType string (values: Csv, Parquet): File output type
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the data set mapping.
  • resourceGroup required string: Resource group of storage account.
  • storageAccountName required string: Storage account name of the source data set.
  • subscriptionId required string: Subscription id of storage account.

BlobProperties

• BlobProperties object: Properties of the blob data set.
  • containerName required string: Container that has the file path.
  • dataSetId string: Unique id for identifying a data set resource
  • filePath required string: File path within the source data set
  • resourceGroup required string: Resource group of storage account
  • storageAccountName required string: Storage account name of the source data set
  • subscriptionId required string: Subscription id of storage account

ConsumerInvitation

• ConsumerInvitation object: A consumer Invitation data transfer object.
  • properties required ConsumerInvitationProperties
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ConsumerInvitationList

• ConsumerInvitationList object: List response for get InvitationList
  • nextLink string: The Url of next result page.
  • value required array: Collection of items of type DataTransferObjects.
    • items ConsumerInvitation

ConsumerInvitationProperties

• ConsumerInvitationProperties object: Properties of consumer invitation
  • dataSetCount integer: Number of data sets in a share
  • description string: Description shared when the invitation was created
  • invitationId required string: Unique id of the invitation.
  • invitationStatus string (values: Pending, Accepted, Rejected, Withdrawn): The status of the invitation.
  • location string: invitation location
  • providerEmail string: Email of the provider who created the resource
  • providerName string: Name of the provider who created the resource
  • providerTenantName string: Tenant name of the provider who created the resource
  • respondedAt string: The time the recipient responded to the invitation.
  • sentAt string: Gets the time at which the invitation was sent.
  • shareName string: Gets the source share Name.
  • termsOfUse string: Terms of use shared when the invitation was created
  • userEmail string: Email of the user who created the resource
  • userName string: Name of the user who created the resource

ConsumerSourceDataSet

• ConsumerSourceDataSet object: A consumer side dataSet data transfer object.
  • properties ConsumerSourceDataSetProperties
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

ConsumerSourceDataSetList

• ConsumerSourceDataSetList object: A consumer side list of source dataSets
  • nextLink string: The Url of next result page.
  • value required array: Collection of items of type DataTransferObjects.
    • items ConsumerSourceDataSet

ConsumerSourceDataSetProperties

• ConsumerSourceDataSetProperties object: Properties of consumer source dataSet
  • dataSetId string: DataSet Id
  • dataSetLocation string: Location of the data set.
  • dataSetName string: DataSet name
  • dataSetPath string: DataSet path
  • dataSetType string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Type of data set

DataSet

• DataSet object: A DataSet data transfer object.
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

DataSetList

• DataSetList object: List response for get DataSets
  • nextLink string: The Url of next result page.
  • value required array: Collection of items of type DataTransferObjects.
    • items DataSet

DataSetMapping

• DataSetMapping object: A data set mapping data transfer object.
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

DataSetMappingList

• DataSetMappingList object: List response for get DataSetMappings
  • nextLink string: The Url of next result page.
  • value required array: Collection of items of type DataTransferObjects.
    • items DataSetMapping

DataShareError

• DataShareError object: The data share error model.
  • error required DataShareErrorInfo

DataShareErrorInfo

• DataShareErrorInfo object: The data share error body model.
  • code required string: Code of the error
  • details array: Nested details of the error model
    • items DataShareErrorInfo
  • message required string: Message of the error
  • target string: Target of the error

DefaultDto

• DefaultDto object: Base data transfer object implementation for default resources.
  • id string: The resource id of the azure resource
  • location string: Location of the azure resource.
  • name string: Name of the azure resource
  • tags object: Tags on the azure resource.
  • type string: Type of the azure resource

DimensionProperties

• DimensionProperties object: properties for dimension
  • displayName string: localized display name of the dimension to customer
  • name string: dimension name

Identity

• Identity object: Identity of resource
  • principalId string: service principal Id
  • tenantId string: Tenant Id
  • type string (values: SystemAssigned): Identity Type

Invitation

• Invitation object: A Invitation data transfer object.
  • properties InvitationProperties
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

InvitationList

• InvitationList object: List response for get InvitationList
  • nextLink string: The Url of next result page.
  • value required array: Collection of items of type DataTransferObjects.
    • items Invitation

InvitationProperties

• InvitationProperties object: Invitation property bag.
  • invitationId string: unique invitation id
  • invitationStatus string (values: Pending, Accepted, Rejected, Withdrawn): The status of the invitation.
  • respondedAt string: The time the recipient responded to the invitation.
  • sentAt string: Gets the time at which the invitation was sent.
  • 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.
  • userEmail string: Email of the user who created the resource
  • userName string: Name of the user who created the resource

KustoClusterDataSet

• KustoClusterDataSet object: A kusto cluster data set.
  • properties required KustoClusterDataSetProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

KustoClusterDataSetMapping

• KustoClusterDataSetMapping object: A Kusto cluster data set mapping
  • properties required KustoClusterDataSetMappingProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

KustoClusterDataSetMappingProperties

• KustoClusterDataSetMappingProperties object: Properties of the Kusto cluster data set mapping
  • dataSetId required string: The id of the source data set.
  • dataSetMappingStatus string (values: Ok, Broken): Gets the status of the data set mapping.
  • kustoClusterResourceId required string: Resource id of the sink kusto cluster.
  • location string: Location of the sink kusto cluster.
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the data set mapping.

KustoClusterDataSetProperties

• KustoClusterDataSetProperties object: Properties of the kusto cluster data set.
  • dataSetId string: Unique id for identifying a data set resource
  • kustoClusterResourceId required string: Resource id of the kusto cluster.
  • location string: Location of the kusto cluster.
  • provisioningState string (values: Succeeded, Creating, Deleting, Moving, Failed): Provisioning state of the kusto cluster data set.

KustoDatabaseDataSet

• KustoDatabaseDataSet object: A kusto database data set.
  • properties required KustoDatabaseDataSetProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, AdlsGen1Folder, AdlsGen1File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

KustoDatabaseDataSetMapping

• KustoDatabaseDataSetMapping object: A Kusto database data set mapping
  • properties required KustoDatabaseDataSetMappingProperties
  • kind required string (values: Blob, Container, BlobFolder, AdlsGen2FileSystem, AdlsGen2Folder, AdlsGen2File, KustoCluster, KustoDatabase, SqlDBTable, SqlDWTable): Kind of data set mapping.
  • id string: The resource id of the azure resource
  • name string: Name of the azure resource
  • type string: Type of the azure resource

KustoDatabaseDataSetMappingProperties

• KustoDatabaseDataSetMappingProperties object: Properties of the Kusto database data set mapping
  • dataSetId required string: The id of the source data set.
  • dataSetMappingStatus string (values: Ok, Broken): Gets the status of the data set mapping.
  • kustoClusterResourceI