DataTypes interface

Interface representing a DataTypes.

Methods

beginCreate(string, string, string, DataType, DataTypesCreateOptionalParams)

Create data type resource.

beginCreateAndWait(string, string, string, DataType, DataTypesCreateOptionalParams)

Create data type resource.

beginDelete(string, string, string, DataTypesDeleteOptionalParams)

Delete data type resource.

beginDeleteAndWait(string, string, string, DataTypesDeleteOptionalParams)

Delete data type resource.

beginDeleteData(string, string, string, Record<string, unknown>, DataTypesDeleteDataOptionalParams)

Delete data for data type.

beginDeleteDataAndWait(string, string, string, Record<string, unknown>, DataTypesDeleteDataOptionalParams)

Delete data for data type.

beginUpdate(string, string, string, DataTypeUpdate, DataTypesUpdateOptionalParams)

Update data type resource.

beginUpdateAndWait(string, string, string, DataTypeUpdate, DataTypesUpdateOptionalParams)

Update data type resource.

generateStorageContainerSasToken(string, string, string, ContainerSaS, DataTypesGenerateStorageContainerSasTokenOptionalParams)

Generate sas token for storage container.

get(string, string, string, DataTypesGetOptionalParams)

Retrieve data type resource.

listByDataProduct(string, string, DataTypesListByDataProductOptionalParams)

List data type by parent resource.

Method Details

beginCreate(string, string, string, DataType, DataTypesCreateOptionalParams)

Create data type resource.

function beginCreate(resourceGroupName: string, dataProductName: string, dataTypeName: string, resource: DataType, options?: DataTypesCreateOptionalParams): Promise<SimplePollerLike<OperationState<DataType>, DataType>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

resource
DataType

Resource create parameters.

options
DataTypesCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DataType>, DataType>>

beginCreateAndWait(string, string, string, DataType, DataTypesCreateOptionalParams)

Create data type resource.

function beginCreateAndWait(resourceGroupName: string, dataProductName: string, dataTypeName: string, resource: DataType, options?: DataTypesCreateOptionalParams): Promise<DataType>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

resource
DataType

Resource create parameters.

options
DataTypesCreateOptionalParams

The options parameters.

Returns

Promise<DataType>

beginDelete(string, string, string, DataTypesDeleteOptionalParams)

Delete data type resource.

function beginDelete(resourceGroupName: string, dataProductName: string, dataTypeName: string, options?: DataTypesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DataTypesDeleteHeaders>, DataTypesDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

options
DataTypesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DataTypesDeleteHeaders>, DataTypesDeleteHeaders>>

beginDeleteAndWait(string, string, string, DataTypesDeleteOptionalParams)

Delete data type resource.

function beginDeleteAndWait(resourceGroupName: string, dataProductName: string, dataTypeName: string, options?: DataTypesDeleteOptionalParams): Promise<DataTypesDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

options
DataTypesDeleteOptionalParams

The options parameters.

Returns

beginDeleteData(string, string, string, Record<string, unknown>, DataTypesDeleteDataOptionalParams)

Delete data for data type.

function beginDeleteData(resourceGroupName: string, dataProductName: string, dataTypeName: string, body: Record<string, unknown>, options?: DataTypesDeleteDataOptionalParams): Promise<SimplePollerLike<OperationState<DataTypesDeleteDataHeaders>, DataTypesDeleteDataHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

body

Record<string, unknown>

The content of the action request

options
DataTypesDeleteDataOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DataTypesDeleteDataHeaders>, DataTypesDeleteDataHeaders>>

beginDeleteDataAndWait(string, string, string, Record<string, unknown>, DataTypesDeleteDataOptionalParams)

Delete data for data type.

function beginDeleteDataAndWait(resourceGroupName: string, dataProductName: string, dataTypeName: string, body: Record<string, unknown>, options?: DataTypesDeleteDataOptionalParams): Promise<DataTypesDeleteDataHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

body

Record<string, unknown>

The content of the action request

options
DataTypesDeleteDataOptionalParams

The options parameters.

Returns

beginUpdate(string, string, string, DataTypeUpdate, DataTypesUpdateOptionalParams)

Update data type resource.

function beginUpdate(resourceGroupName: string, dataProductName: string, dataTypeName: string, properties: DataTypeUpdate, options?: DataTypesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DataType>, DataType>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

properties
DataTypeUpdate

The resource properties to be updated.

options
DataTypesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DataType>, DataType>>

beginUpdateAndWait(string, string, string, DataTypeUpdate, DataTypesUpdateOptionalParams)

Update data type resource.

function beginUpdateAndWait(resourceGroupName: string, dataProductName: string, dataTypeName: string, properties: DataTypeUpdate, options?: DataTypesUpdateOptionalParams): Promise<DataType>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

properties
DataTypeUpdate

The resource properties to be updated.

options
DataTypesUpdateOptionalParams

The options parameters.

Returns

Promise<DataType>

generateStorageContainerSasToken(string, string, string, ContainerSaS, DataTypesGenerateStorageContainerSasTokenOptionalParams)

Generate sas token for storage container.

function generateStorageContainerSasToken(resourceGroupName: string, dataProductName: string, dataTypeName: string, body: ContainerSaS, options?: DataTypesGenerateStorageContainerSasTokenOptionalParams): Promise<ContainerSasToken>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

body
ContainerSaS

The content of the action request

Returns

get(string, string, string, DataTypesGetOptionalParams)

Retrieve data type resource.

function get(resourceGroupName: string, dataProductName: string, dataTypeName: string, options?: DataTypesGetOptionalParams): Promise<DataType>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

dataTypeName

string

The data type name.

options
DataTypesGetOptionalParams

The options parameters.

Returns

Promise<DataType>

listByDataProduct(string, string, DataTypesListByDataProductOptionalParams)

List data type by parent resource.

function listByDataProduct(resourceGroupName: string, dataProductName: string, options?: DataTypesListByDataProductOptionalParams): PagedAsyncIterableIterator<DataType, DataType[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

dataProductName

string

The data product resource name

options
DataTypesListByDataProductOptionalParams

The options parameters.

Returns