Package version:

Interface DataProducts

Interface representing a DataProducts.

interface DataProducts {
    addUserRole(resourceGroupName, dataProductName, body, options?): Promise<RoleAssignmentDetail>;
    beginCreate(resourceGroupName, dataProductName, resource, options?): Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>;
    beginCreateAndWait(resourceGroupName, dataProductName, resource, options?): Promise<DataProduct>;
    beginDelete(resourceGroupName, dataProductName, options?): Promise<SimplePollerLike<OperationState<DataProductsDeleteHeaders>, DataProductsDeleteHeaders>>;
    beginDeleteAndWait(resourceGroupName, dataProductName, options?): Promise<DataProductsDeleteHeaders>;
    beginUpdate(resourceGroupName, dataProductName, properties, options?): Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>;
    beginUpdateAndWait(resourceGroupName, dataProductName, properties, options?): Promise<DataProduct>;
    generateStorageAccountSasToken(resourceGroupName, dataProductName, body, options?): Promise<AccountSasToken>;
    get(resourceGroupName, dataProductName, options?): Promise<DataProduct>;
    listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<DataProduct>;
    listBySubscription(options?): PagedAsyncIterableIterator<DataProduct>;
    listRolesAssignments(resourceGroupName, dataProductName, body, options?): Promise<ListRoleAssignments>;
    removeUserRole(resourceGroupName, dataProductName, body, options?): Promise<void>;
    rotateKey(resourceGroupName, dataProductName, body, options?): Promise<void>;
}

Index

Methods

addUserRole beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait generateStorageAccountSasToken get listByResourceGroup listBySubscription listRolesAssignments removeUserRole rotateKey

Methods

addUserRole

addUserRole(resourceGroupName, dataProductName, body, options?): Promise<RoleAssignmentDetail>
Assign role to the data product.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- body: RoleAssignmentCommonProperties
  The content of the action request
- Optional options: DataProductsAddUserRoleOptionalParams
  The options parameters.
Returns Promise<RoleAssignmentDetail>
- Defined in operationsInterfaces/dataProducts.ts:164

beginCreate

beginCreate(resourceGroupName, dataProductName, resource, options?): Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>
Create data product resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- resource: DataProduct
  Resource create parameters.
- Optional options: DataProductsCreateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>
- Defined in operationsInterfaces/dataProducts.ts:75

beginCreateAndWait

beginCreateAndWait(resourceGroupName, dataProductName, resource, options?): Promise<DataProduct>
Create data product resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- resource: DataProduct
  Resource create parameters.
- Optional options: DataProductsCreateOptionalParams
  The options parameters.
Returns Promise<DataProduct>
- Defined in operationsInterfaces/dataProducts.ts:93

beginDelete

beginDelete(resourceGroupName, dataProductName, options?): Promise<SimplePollerLike<OperationState<DataProductsDeleteHeaders>, DataProductsDeleteHeaders>>
Delete data product resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- Optional options: DataProductsDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<DataProductsDeleteHeaders>, DataProductsDeleteHeaders>>
- Defined in operationsInterfaces/dataProducts.ts:136

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, dataProductName, options?): Promise<DataProductsDeleteHeaders>
Delete data product resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- Optional options: DataProductsDeleteOptionalParams
  The options parameters.
Returns Promise<DataProductsDeleteHeaders>
- Defined in operationsInterfaces/dataProducts.ts:152

beginUpdate

beginUpdate(resourceGroupName, dataProductName, properties, options?): Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>
Update data product resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- properties: DataProductUpdate
  The resource properties to be updated.
- Optional options: DataProductsUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>
- Defined in operationsInterfaces/dataProducts.ts:106

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, dataProductName, properties, options?): Promise<DataProduct>
Update data product resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- properties: DataProductUpdate
  The resource properties to be updated.
- Optional options: DataProductsUpdateOptionalParams
  The options parameters.
Returns Promise<DataProduct>
- Defined in operationsInterfaces/dataProducts.ts:124

generateStorageAccountSasToken

generateStorageAccountSasToken(resourceGroupName, dataProductName, body, options?): Promise<AccountSasToken>
Generate sas token for storage account.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- body: AccountSas
  The content of the action request
- Optional options: DataProductsGenerateStorageAccountSasTokenOptionalParams
  The options parameters.
Returns Promise<AccountSasToken>
- Defined in operationsInterfaces/dataProducts.ts:177

get

get(resourceGroupName, dataProductName, options?): Promise<DataProduct>
Retrieve data product resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- Optional options: DataProductsGetOptionalParams
  The options parameters.
Returns Promise<DataProduct>
- Defined in operationsInterfaces/dataProducts.ts:63

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<DataProduct>
List data products by resource group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- Optional options: DataProductsListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<DataProduct>
- Defined in operationsInterfaces/dataProducts.ts:53

listBySubscription

listBySubscription(options?): PagedAsyncIterableIterator<DataProduct>
List data products by subscription.
Parameters
- Optional options: DataProductsListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<DataProduct>
- Defined in operationsInterfaces/dataProducts.ts:45

listRolesAssignments

listRolesAssignments(resourceGroupName, dataProductName, body, options?): Promise<ListRoleAssignments>
List user roles associated with the data product.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- body: Record<string, unknown>
  The content of the action request
- Optional options: DataProductsListRolesAssignmentsOptionalParams
  The options parameters.
Returns Promise<ListRoleAssignments>
- Defined in operationsInterfaces/dataProducts.ts:190

removeUserRole

removeUserRole(resourceGroupName, dataProductName, body, options?): Promise<void>
Remove role from the data product.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- body: RoleAssignmentDetail
  The content of the action request
- Optional options: DataProductsRemoveUserRoleOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/dataProducts.ts:203

rotateKey

rotateKey(resourceGroupName, dataProductName, body, options?): Promise<void>
Initiate key rotation on Data Product.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- body: KeyVaultInfo
  The content of the action request
- Optional options: DataProductsRotateKeyOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/dataProducts.ts:216

Interface DataProducts

Index

Methods

Methods

addUserRole

Parameters

resourceGroupName: string

dataProductName: string

body: RoleAssignmentCommonProperties

Optional options: DataProductsAddUserRoleOptionalParams

Returns Promise<RoleAssignmentDetail>

beginCreate

Parameters

resourceGroupName: string

dataProductName: string

resource: DataProduct

Optional options: DataProductsCreateOptionalParams

Returns Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>

beginCreateAndWait

Parameters

resourceGroupName: string

dataProductName: string

resource: DataProduct

Optional options: DataProductsCreateOptionalParams

Returns Promise<DataProduct>

beginDelete

Parameters

resourceGroupName: string

dataProductName: string

Optional options: DataProductsDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<DataProductsDeleteHeaders>, DataProductsDeleteHeaders>>

beginDeleteAndWait

Parameters

resourceGroupName: string

dataProductName: string

Optional options: DataProductsDeleteOptionalParams

Returns Promise<DataProductsDeleteHeaders>

beginUpdate

Parameters

resourceGroupName: string

dataProductName: string

properties: DataProductUpdate

Optional options: DataProductsUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>

beginUpdateAndWait

Parameters

resourceGroupName: string

dataProductName: string

properties: DataProductUpdate

Optional options: DataProductsUpdateOptionalParams

Returns Promise<DataProduct>

generateStorageAccountSasToken

Parameters

resourceGroupName: string

dataProductName: string

body: AccountSas

Optional options: DataProductsGenerateStorageAccountSasTokenOptionalParams

Returns Promise<AccountSasToken>

get

Parameters

resourceGroupName: string

dataProductName: string

Optional options: DataProductsGetOptionalParams

Returns Promise<DataProduct>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: DataProductsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<DataProduct>

listBySubscription

Parameters

Optional options: DataProductsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<DataProduct>

listRolesAssignments

Parameters

resourceGroupName: string

dataProductName: string

body: Record<string, unknown>

Optional options: DataProductsListRolesAssignmentsOptionalParams

Returns Promise<ListRoleAssignments>

`Optional` options: DataProductsAddUserRoleOptionalParams

`Optional` options: DataProductsCreateOptionalParams

`Optional` options: DataProductsCreateOptionalParams

`Optional` options: DataProductsDeleteOptionalParams

`Optional` options: DataProductsDeleteOptionalParams

`Optional` options: DataProductsUpdateOptionalParams

`Optional` options: DataProductsUpdateOptionalParams

`Optional` options: DataProductsGenerateStorageAccountSasTokenOptionalParams

`Optional` options: DataProductsGetOptionalParams

`Optional` options: DataProductsListByResourceGroupOptionalParams

`Optional` options: DataProductsListBySubscriptionOptionalParams

`Optional` options: DataProductsListRolesAssignmentsOptionalParams

`Optional` options: DataProductsRemoveUserRoleOptionalParams

`Optional` options: DataProductsRotateKeyOptionalParams