ADCCatalogs interface
Interface representing a ADCCatalogs.
Methods
| begin |
The Delete Azure Data Catalog Service operation deletes an existing data catalog. |
| begin |
The Delete Azure Data Catalog Service operation deletes an existing data catalog. |
| create |
The Create Azure Data Catalog service operation creates a new data catalog service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged. |
| get(string, string, ADCCatalogs |
The Get Azure Data Catalog Service operation retrieves a json representation of the data catalog. |
| listt |
The List catalogs in Resource Group operation lists all the Azure Data Catalogs available under the given resource group. |
| update(string, string, ADCCatalog, ADCCatalogs |
The Update Azure Data Catalog Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body. |
Method Details
beginDelete(string, string, ADCCatalogsDeleteOptionalParams)
The Delete Azure Data Catalog Service operation deletes an existing data catalog.
function beginDelete(resourceGroupName: string, catalogName: string, options?: ADCCatalogsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- catalogName
-
string
The name of the data catalog in the specified subscription and resource group.
- options
- ADCCatalogsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, ADCCatalogsDeleteOptionalParams)
The Delete Azure Data Catalog Service operation deletes an existing data catalog.
function beginDeleteAndWait(resourceGroupName: string, catalogName: string, options?: ADCCatalogsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- catalogName
-
string
The name of the data catalog in the specified subscription and resource group.
- options
- ADCCatalogsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
createOrUpdate(string, string, ADCCatalog, ADCCatalogsCreateOrUpdateOptionalParams)
The Create Azure Data Catalog service operation creates a new data catalog service with the specified parameters. If the specific service already exists, then any patchable properties will be updated and any immutable properties will remain unchanged.
function createOrUpdate(resourceGroupName: string, catalogName: string, properties: ADCCatalog, options?: ADCCatalogsCreateOrUpdateOptionalParams): Promise<ADCCatalog>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- catalogName
-
string
The name of the data catalog in the specified subscription and resource group.
- properties
- ADCCatalog
Properties supplied to the Create or Update a data catalog.
The options parameters.
Returns
Promise<ADCCatalog>
get(string, string, ADCCatalogsGetOptionalParams)
The Get Azure Data Catalog Service operation retrieves a json representation of the data catalog.
function get(resourceGroupName: string, catalogName: string, options?: ADCCatalogsGetOptionalParams): Promise<ADCCatalog>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- catalogName
-
string
The name of the data catalog in the specified subscription and resource group.
- options
- ADCCatalogsGetOptionalParams
The options parameters.
Returns
Promise<ADCCatalog>
listtByResourceGroup(string, ADCCatalogsListtByResourceGroupOptionalParams)
The List catalogs in Resource Group operation lists all the Azure Data Catalogs available under the given resource group.
function listtByResourceGroup(resourceGroupName: string, options?: ADCCatalogsListtByResourceGroupOptionalParams): Promise<ADCCatalogsListResult>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
The options parameters.
Returns
Promise<ADCCatalogsListResult>
update(string, string, ADCCatalog, ADCCatalogsUpdateOptionalParams)
The Update Azure Data Catalog Service operation can be used to update the existing deployment. The update call only supports the properties listed in the PATCH body.
function update(resourceGroupName: string, catalogName: string, properties: ADCCatalog, options?: ADCCatalogsUpdateOptionalParams): Promise<ADCCatalog>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription. The name is case insensitive.
- catalogName
-
string
The name of the data catalog in the specified subscription and resource group.
- properties
- ADCCatalog
Properties supplied to the Update a data catalog.
- options
- ADCCatalogsUpdateOptionalParams
The options parameters.
Returns
Promise<ADCCatalog>