Package version:

Interface DataTypes

Interface representing a DataTypes.

interface DataTypes {
    beginCreate(resourceGroupName, dataProductName, dataTypeName, resource, options?): Promise<SimplePollerLike<OperationState<DataType>, DataType>>;
    beginCreateAndWait(resourceGroupName, dataProductName, dataTypeName, resource, options?): Promise<DataType>;
    beginDelete(resourceGroupName, dataProductName, dataTypeName, options?): Promise<SimplePollerLike<OperationState<DataTypesDeleteHeaders>, DataTypesDeleteHeaders>>;
    beginDeleteAndWait(resourceGroupName, dataProductName, dataTypeName, options?): Promise<DataTypesDeleteHeaders>;
    beginDeleteData(resourceGroupName, dataProductName, dataTypeName, body, options?): Promise<SimplePollerLike<OperationState<DataTypesDeleteDataHeaders>, DataTypesDeleteDataHeaders>>;
    beginDeleteDataAndWait(resourceGroupName, dataProductName, dataTypeName, body, options?): Promise<DataTypesDeleteDataHeaders>;
    beginUpdate(resourceGroupName, dataProductName, dataTypeName, properties, options?): Promise<SimplePollerLike<OperationState<DataType>, DataType>>;
    beginUpdateAndWait(resourceGroupName, dataProductName, dataTypeName, properties, options?): Promise<DataType>;
    generateStorageContainerSasToken(resourceGroupName, dataProductName, dataTypeName, body, options?): Promise<ContainerSasToken>;
    get(resourceGroupName, dataProductName, dataTypeName, options?): Promise<DataType>;
    listByDataProduct(resourceGroupName, dataProductName, options?): PagedAsyncIterableIterator<DataType>;
}

Index

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginDeleteData beginDeleteDataAndWait beginUpdate beginUpdateAndWait generateStorageContainerSasToken get listByDataProduct

Methods

beginCreate

beginCreate(resourceGroupName, dataProductName, dataTypeName, resource, options?): Promise<SimplePollerLike<OperationState<DataType>, DataType>>
Create data type resource.
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.
- Optional options: DataTypesCreateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<DataType>, DataType>>
- Defined in operationsInterfaces/dataTypes.ts:65

beginCreateAndWait

beginCreateAndWait(resourceGroupName, dataProductName, dataTypeName, resource, options?): Promise<DataType>
Create data type resource.
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.
- Optional options: DataTypesCreateOptionalParams
  The options parameters.
Returns Promise<DataType>
- Defined in operationsInterfaces/dataTypes.ts:85

beginDelete

beginDelete(resourceGroupName, dataProductName, dataTypeName, options?): Promise<SimplePollerLike<OperationState<DataTypesDeleteHeaders>, DataTypesDeleteHeaders>>
Delete data type resource.
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.
- Optional options: DataTypesDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<DataTypesDeleteHeaders>, DataTypesDeleteHeaders>>
- Defined in operationsInterfaces/dataTypes.ts:134

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, dataProductName, dataTypeName, options?): Promise<DataTypesDeleteHeaders>
Delete data type resource.
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.
- Optional options: DataTypesDeleteOptionalParams
  The options parameters.
Returns Promise<DataTypesDeleteHeaders>
- Defined in operationsInterfaces/dataTypes.ts:152

beginDeleteData

beginDeleteData(resourceGroupName, dataProductName, dataTypeName, body, options?): Promise<SimplePollerLike<OperationState<DataTypesDeleteDataHeaders>, DataTypesDeleteDataHeaders>>
Delete data for data type.
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
- Optional options: DataTypesDeleteDataOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<DataTypesDeleteDataHeaders>, DataTypesDeleteDataHeaders>>
- Defined in operationsInterfaces/dataTypes.ts:166

beginDeleteDataAndWait

beginDeleteDataAndWait(resourceGroupName, dataProductName, dataTypeName, body, options?): Promise<DataTypesDeleteDataHeaders>
Delete data for data type.
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
- Optional options: DataTypesDeleteDataOptionalParams
  The options parameters.
Returns Promise<DataTypesDeleteDataHeaders>
- Defined in operationsInterfaces/dataTypes.ts:186

beginUpdate

beginUpdate(resourceGroupName, dataProductName, dataTypeName, properties, options?): Promise<SimplePollerLike<OperationState<DataType>, DataType>>
Update data type resource.
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.
- Optional options: DataTypesUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<DataType>, DataType>>
- Defined in operationsInterfaces/dataTypes.ts:100

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, dataProductName, dataTypeName, properties, options?): Promise<DataType>
Update data type resource.
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.
- Optional options: DataTypesUpdateOptionalParams
  The options parameters.
Returns Promise<DataType>
- Defined in operationsInterfaces/dataTypes.ts:120

generateStorageContainerSasToken

generateStorageContainerSasToken(resourceGroupName, dataProductName, dataTypeName, body, options?): Promise<ContainerSasToken>
Generate sas token for storage container.
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
- Optional options: DataTypesGenerateStorageContainerSasTokenOptionalParams
  The options parameters.
Returns Promise<ContainerSasToken>
- Defined in operationsInterfaces/dataTypes.ts:201

get

get(resourceGroupName, dataProductName, dataTypeName, options?): Promise<DataType>
Retrieve data type resource.
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.
- Optional options: DataTypesGetOptionalParams
  The options parameters.
Returns Promise<DataType>
- Defined in operationsInterfaces/dataTypes.ts:51

listByDataProduct

listByDataProduct(resourceGroupName, dataProductName, options?): PagedAsyncIterableIterator<DataType>
List data type by parent resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- dataProductName: string
  The data product resource name
- Optional options: DataTypesListByDataProductOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<DataType>
- Defined in operationsInterfaces/dataTypes.ts:39

Interface DataTypes

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

resource: DataType

Optional options: DataTypesCreateOptionalParams

Returns Promise<SimplePollerLike<OperationState<DataType>, DataType>>

beginCreateAndWait

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

resource: DataType

Optional options: DataTypesCreateOptionalParams

Returns Promise<DataType>

beginDelete

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

Optional options: DataTypesDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<DataTypesDeleteHeaders>, DataTypesDeleteHeaders>>

beginDeleteAndWait

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

Optional options: DataTypesDeleteOptionalParams

Returns Promise<DataTypesDeleteHeaders>

beginDeleteData

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

body: Record<string, unknown>

Optional options: DataTypesDeleteDataOptionalParams

Returns Promise<SimplePollerLike<OperationState<DataTypesDeleteDataHeaders>, DataTypesDeleteDataHeaders>>

beginDeleteDataAndWait

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

body: Record<string, unknown>

Optional options: DataTypesDeleteDataOptionalParams

Returns Promise<DataTypesDeleteDataHeaders>

beginUpdate

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

properties: DataTypeUpdate

Optional options: DataTypesUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<DataType>, DataType>>

beginUpdateAndWait

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

properties: DataTypeUpdate

Optional options: DataTypesUpdateOptionalParams

Returns Promise<DataType>

generateStorageContainerSasToken

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

body: ContainerSaS

Optional options: DataTypesGenerateStorageContainerSasTokenOptionalParams

Returns Promise<ContainerSasToken>

get

Parameters

resourceGroupName: string

dataProductName: string

dataTypeName: string

Optional options: DataTypesGetOptionalParams

`Optional` options: DataTypesCreateOptionalParams

`Optional` options: DataTypesCreateOptionalParams

`Optional` options: DataTypesDeleteOptionalParams

`Optional` options: DataTypesDeleteOptionalParams

`Optional` options: DataTypesDeleteDataOptionalParams

`Optional` options: DataTypesDeleteDataOptionalParams

`Optional` options: DataTypesUpdateOptionalParams

`Optional` options: DataTypesUpdateOptionalParams

`Optional` options: DataTypesGenerateStorageContainerSasTokenOptionalParams

`Optional` options: DataTypesGetOptionalParams

`Optional` options: DataTypesListByDataProductOptionalParams