DataProducts interface
Interface representing a DataProducts.
Methods
Method Details
addUserRole(string, string, RoleAssignmentCommonProperties, DataProductsAddUserRoleOptionalParams)
Assign role to the data product.
function addUserRole(resourceGroupName: string, dataProductName: string, body: RoleAssignmentCommonProperties, options?: DataProductsAddUserRoleOptionalParams): Promise<RoleAssignmentDetail>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- dataProductName
-
string
The data product resource name
The content of the action request
The options parameters.
Returns
Promise<RoleAssignmentDetail>
beginCreate(string, string, DataProduct, DataProductsCreateOptionalParams)
Create data product resource.
function beginCreate(resourceGroupName: string, dataProductName: string, resource: DataProduct, options?: DataProductsCreateOptionalParams): Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>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.
- options
- DataProductsCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DataProduct>, DataProduct>>
beginCreateAndWait(string, string, DataProduct, DataProductsCreateOptionalParams)
Create data product resource.
function beginCreateAndWait(resourceGroupName: string, dataProductName: string, resource: DataProduct, options?: DataProductsCreateOptionalParams): Promise<DataProduct>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.
- options
- DataProductsCreateOptionalParams
The options parameters.
Returns
Promise<DataProduct>
beginDelete(string, string, DataProductsDeleteOptionalParams)
Delete data product resource.
function beginDelete(resourceGroupName: string, dataProductName: string, options?: DataProductsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DataProductsDeleteHeaders>, DataProductsDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- dataProductName
-
string
The data product resource name
- options
- DataProductsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DataProductsDeleteHeaders>, DataProductsDeleteHeaders>>
beginDeleteAndWait(string, string, DataProductsDeleteOptionalParams)
Delete data product resource.
function beginDeleteAndWait(resourceGroupName: string, dataProductName: string, options?: DataProductsDeleteOptionalParams): Promise<DataProductsDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- dataProductName
-
string
The data product resource name
- options
- DataProductsDeleteOptionalParams
The options parameters.
Returns
Promise<DataProductsDeleteHeaders>
beginUpdate(string, string, DataProductUpdate, DataProductsUpdateOptionalParams)
Update data product resource.
function beginUpdate(resourceGroupName: string, dataProductName: string, properties: DataProductUpdate, options?: DataProductsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DataProduct>, DataProduct>>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.
- options
- DataProductsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DataProduct>, DataProduct>>
beginUpdateAndWait(string, string, DataProductUpdate, DataProductsUpdateOptionalParams)
Update data product resource.
function beginUpdateAndWait(resourceGroupName: string, dataProductName: string, properties: DataProductUpdate, options?: DataProductsUpdateOptionalParams): Promise<DataProduct>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.
- options
- DataProductsUpdateOptionalParams
The options parameters.
Returns
Promise<DataProduct>
generateStorageAccountSasToken(string, string, AccountSas, DataProductsGenerateStorageAccountSasTokenOptionalParams)
Generate sas token for storage account.
function generateStorageAccountSasToken(resourceGroupName: string, dataProductName: string, body: AccountSas, options?: DataProductsGenerateStorageAccountSasTokenOptionalParams): Promise<AccountSasToken>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
The options parameters.
Returns
Promise<AccountSasToken>
get(string, string, DataProductsGetOptionalParams)
Retrieve data product resource.
function get(resourceGroupName: string, dataProductName: string, options?: DataProductsGetOptionalParams): Promise<DataProduct>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- dataProductName
-
string
The data product resource name
- options
- DataProductsGetOptionalParams
The options parameters.
Returns
Promise<DataProduct>
listByResourceGroup(string, DataProductsListByResourceGroupOptionalParams)
List data products by resource group.
function listByResourceGroup(resourceGroupName: string, options?: DataProductsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DataProduct, DataProduct[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(DataProductsListBySubscriptionOptionalParams)
List data products by subscription.
function listBySubscription(options?: DataProductsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DataProduct, DataProduct[], PageSettings>Parameters
The options parameters.
Returns
listRolesAssignments(string, string, Record<string, unknown>, DataProductsListRolesAssignmentsOptionalParams)
List user roles associated with the data product.
function listRolesAssignments(resourceGroupName: string, dataProductName: string, body: Record<string, unknown>, options?: DataProductsListRolesAssignmentsOptionalParams): Promise<ListRoleAssignments>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
The options parameters.
Returns
Promise<ListRoleAssignments>
removeUserRole(string, string, RoleAssignmentDetail, DataProductsRemoveUserRoleOptionalParams)
Remove role from the data product.
function removeUserRole(resourceGroupName: string, dataProductName: string, body: RoleAssignmentDetail, options?: DataProductsRemoveUserRoleOptionalParams): Promise<void>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
The options parameters.
Returns
Promise<void>
rotateKey(string, string, KeyVaultInfo, DataProductsRotateKeyOptionalParams)
Initiate key rotation on Data Product.
function rotateKey(resourceGroupName: string, dataProductName: string, body: KeyVaultInfo, options?: DataProductsRotateKeyOptionalParams): Promise<void>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
The options parameters.
Returns
Promise<void>