@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Azure Data Catalog Resource Provider
@base https://management.azure.com
@version 2016-03-30
@auth OAuth2
@common_fields {api-version: any # Client Api Version.}
@endpoints 6
@toc providers(1), subscriptions(5)

@group providers
@endpoint GET /providers/Microsoft.DataCatalog/operations
@desc Lists all the available Azure Data Catalog service operations.
@returns(200) HTTP 200 (OK) if the operation was successful.

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataCatalog/catalogs
@desc List catalogs in Resource Group (GET Resources)
@required {subscriptionId: any # Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group within the user's subscription. The name is case insensitive.}
@returns(200) HTTP 200 (OK) if the operation was successful.

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataCatalog/catalogs/{catalogName}
@desc Create or Update Azure Data Catalog service (PUT Resource)
@required {subscriptionId: any # Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group within the user's subscription. The name is case insensitive., catalogName: any # The name of the data catalog in the specified subscription and resource group., properties: any # Properties supplied to the Create or Update a data catalog.}
@returns(200) HTTP 200 (OK) if the operation was successful.
@returns(201) HTTP 201 (Created) if the operation completed successfully.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataCatalog/catalogs/{catalogName}
@desc Get Azure Data Catalog service (GET Resources)
@required {subscriptionId: any # Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group within the user's subscription. The name is case insensitive., catalogName: any # The name of the data catalog in the specified subscription and resource group.}
@returns(200) HTTP 200 (OK) if the operation was successful.

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataCatalog/catalogs/{catalogName}
@desc Delete Azure Data Catalog Service (DELETE Resource)
@required {subscriptionId: any # Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group within the user's subscription. The name is case insensitive., catalogName: any # The name of the data catalog in the specified subscription and resource group.}
@returns(200) OK. An existing annotation was updated.
@returns(202) Accepted. Delete is asynchronous. In this case, the caller needs to read the Location header for an URL to poll. That URL will continue to return 202 until the operation is complete. When it stops returning 202, the response it gives back is the result of the DELETE operation.
@returns(204) No Content (didn't exist).

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataCatalog/catalogs/{catalogName}
@desc Update Azure Data Catalog Service (PATCH Resource)
@required {subscriptionId: any # Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call., resourceGroupName: any # The name of the resource group within the user's subscription. The name is case insensitive., catalogName: any # The name of the data catalog in the specified subscription and resource group., properties: any # Properties supplied to the Update a data catalog.}
@returns(200) HTTP 200 (OK) if the operation was successful.

@endgroup

@end
