{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-advisor","description":"AdvisorManagementClient","version":"2017-04-19","base_url":"https://management.azure.com","endpoints":15,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AdvisorManagementClient\n@base https://management.azure.com\n@version 2017-04-19\n@auth OAuth2\n@common_fields {api-version: any # The version of the API to be used with the client request.}\n@endpoints 15\n@toc providers(3), subscriptions(8), {resourceUri}(4)\n\n@group providers\n@endpoint GET /providers/Microsoft.Advisor/metadata/{name}\n@desc Gets the metadata entity.\n@required {name: any # Name of metadata entity.}\n@returns(200) OK. Successfully retrieved metadata entities\n@errors {404: Client sent unknown metadata name}\n\n@endpoint GET /providers/Microsoft.Advisor/metadata\n@desc Gets the list of metadata entities.\n@returns(200) OK. Successfully retrieved metadata entities\n\n@endgroup\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations\n@desc Retrieve Azure Advisor configurations.\n@required {subscriptionId: any # The Azure subscription ID.}\n@returns(200) OK. Successfully retrieved zero or more configurations.\n\n@endpoint PUT /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/configurations\n@desc Create/Overwrite Azure Advisor configuration.\n@required {configContract: map # The Azure Advisor configuration data structure., subscriptionId: any # The Azure subscription ID.}\n@returns(204) No Content. Successfully created/overwrote configuration.\n@errors {400: Bad Request. Client sent invalid configuration scope, properties or values.}\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations\n@desc Retrieve Azure Advisor configurations.\n@required {subscriptionId: any # The Azure subscription ID., resourceGroup: any # The name of the Azure resource group.}\n@returns(200) OK. Successfully retrieved zero or more configurations.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Advisor/configurations\n@desc Create/Overwrite Azure Advisor configuration.\n@required {configContract: map # The Azure Advisor configuration data structure., subscriptionId: any # The Azure subscription ID., resourceGroup: any # The name of the Azure resource group.}\n@returns(204) No Content. Successfully created/overwrote configuration.\n@errors {400: Bad Request. Client sent invalid configuration scope, properties or values.}\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations\n@desc Initiates the recommendation generation or computation process for a subscription. This operation is asynchronous. The generated recommendations are stored in a cache in the Advisor service.\n@required {subscriptionId: any # The Azure subscription ID.}\n@returns(202) Accepted. Recommendation generation has been accepted.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/generateRecommendations/{operationId}\n@desc Retrieves the status of the recommendation computation or generation process. Invoke this API after calling the generation recommendation. The URI of this API is returned in the Location field of the response header.\n@required {subscriptionId: any # The Azure subscription ID., operationId: any # The operation ID, which can be found from the Location field in the generate recommendation response header.}\n@returns(202) Accepted. Recommendation generation is in progress.\n@returns(204) NoContent. Recommendation generation has been completed.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/recommendations\n@desc Obtains cached recommendations for a subscription. The recommendations are generated or computed by invoking generateRecommendations.\n@required {subscriptionId: any # The Azure subscription ID.}\n@optional {$filter: any # The filter to apply to the recommendations.Filter can be applied to properties ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with operators ['eq', 'and', 'or'].Example:- $filter=Category eq 'Cost' and ResourceGroup eq 'MyResourceGroup', $top: any # The number of recommendations per page if a paged version of this API is being used., $skipToken: any # The page-continuation token to use with a paged version of this API.}\n@returns(200) OK. Successfully obtained cached recommendations.\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/Microsoft.Advisor/operations\n@desc Lists all the available Advisor REST API operations.\n@returns(200) OK. Successfully retrieved operation list.\n\n@endgroup\n\n@group {resourceUri}\n@endpoint GET /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}\n@desc Obtains details of a cached recommendation.\n@required {resourceUri: any # The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies., recommendationId: any # The recommendation ID.}\n@returns(200) OK. Successfully got recommendation detail.\n\n@endpoint GET /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}\n@desc Obtains the details of a suppression.\n@required {resourceUri: any # The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies., recommendationId: any # The recommendation ID., name: any # The name of the suppression.}\n@returns(200) OK. Successfully got suppression detail.\n\n@endpoint PUT /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}\n@desc Enables the snoozed or dismissed attribute of a recommendation. The snoozed or dismissed attribute is referred to as a suppression. Use this API to create or update the snoozed or dismissed status of a recommendation.\n@required {resourceUri: any # The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies., recommendationId: any # The recommendation ID., name: any # The name of the suppression., suppressionContract: map # The snoozed or dismissed attribute; for example, the snooze duration.}\n@returns(200) OK. Successfully created suppression.\n\n@endpoint DELETE /{resourceUri}/providers/Microsoft.Advisor/recommendations/{recommendationId}/suppressions/{name}\n@desc Enables the activation of a snoozed or dismissed recommendation. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.\n@required {resourceUri: any # The fully qualified Azure Resource Manager identifier of the resource to which the recommendation applies., recommendationId: any # The recommendation ID., name: any # The name of the suppression.}\n@returns(204) NoContent. The recommendation has been activated.\n\n@endgroup\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Advisor/suppressions\n@desc Retrieves the list of snoozed or dismissed suppressions for a subscription. The snoozed or dismissed attribute of a recommendation is referred to as a suppression.\n@required {subscriptionId: any # The Azure subscription ID.}\n@optional {$top: any # The number of suppressions per page if a paged version of this API is being used., $skipToken: any # The page-continuation token to use with a paged version of this API.}\n@returns(200) OK. Successfully got all suppressions in a subscription.\n\n@endgroup\n\n@end\n"}