@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api portal
@base https://management.azure.com
@version 2019-01-01-preview
@auth OAuth2
@common_fields {api-version: any # The API version to be used with the HTTP request.}
@endpoints 7
@toc providers(1), subscriptions(6)

@group providers
@endpoint GET /providers/Microsoft.Portal/operations
@desc The Microsoft Portal operations API.
@returns(200) Describe the result of a successful operation.

@endgroup

@group subscriptions
@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}
@desc Creates or updates a Dashboard.
@required {subscriptionId: any # The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000), resourceGroupName: any # The name of the resource group., dashboardName: any # The name of the dashboard., dashboard: map # The parameters required to create or update a dashboard.}
@returns(200) Resource already exists.
@returns(201) Created response definition. Resource has been created

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}
@desc Deletes the Dashboard.
@required {subscriptionId: any # The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000), resourceGroupName: any # The name of the resource group., dashboardName: any # The name of the dashboard.}
@returns(200) OK response definition.
@returns(204) OK resource was not found.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}
@desc Gets the Dashboard.
@required {subscriptionId: any # The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000), resourceGroupName: any # The name of the resource group., dashboardName: any # The name of the dashboard.}
@returns(200) OK response definition.
@errors {404: Not found. Dashboard with provided id doesn't exist.}

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}
@desc Updates an existing Dashboard.
@required {subscriptionId: any # The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000), resourceGroupName: any # The name of the resource group., dashboardName: any # The name of the dashboard., dashboard: map # The updatable fields of a Dashboard.}
@returns(200) OK response definition.
@errors {404: Not found. Dashboard with provided id doesn't exist.}

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards
@desc Gets all the Dashboards within a resource group.
@required {subscriptionId: any # The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000), resourceGroupName: any # The name of the resource group.}
@returns(200) OK - Returns an array of Dashboards.

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards
@desc Gets all the dashboards within a subscription.
@required {subscriptionId: any # The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)}
@returns(200) OK - Returns an array of dashboards.

@endgroup

@end
