azure.mgmt.advisor.aio.operations.RecommendationsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.advisor.aio.operations.RecommendationsOperations
name: RecommendationsOperations
fullName: azure.mgmt.advisor.aio.operations.RecommendationsOperations
module: azure.mgmt.advisor.aio.operations
inheritances:
- builtins.object
summary: 'RecommendationsOperations async operations.


  You should not instantiate this class directly. Instead, you should create a Client
  instance that

  instantiates it for you and attaches it as an attribute.'
constructor:
  syntax: RecommendationsOperations(client, config, serializer, deserializer)
  parameters:
  - name: client
    description: Client for service requests.
    isRequired: true
  - name: config
    description: Configuration of service client.
    isRequired: true
  - name: serializer
    description: An object model serializer.
    isRequired: true
  - name: deserializer
    description: An object model deserializer.
    isRequired: true
variables:
- description: Alias to model classes used in this operation group.
  name: models
methods:
- uid: azure.mgmt.advisor.aio.operations.RecommendationsOperations.generate
  name: generate
  summary: '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.'
  signature: async generate(**kwargs) -> None
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None, or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.advisor.aio.operations.RecommendationsOperations.get
  name: get
  summary: Obtains details of a cached recommendation.
  signature: 'async get(resource_uri: str, recommendation_id: str, **kwargs) -> ResourceRecommendationBase'
  parameters:
  - name: resource_uri
    description: 'The fully qualified Azure Resource Manager identifier of the resource
      to

      which the recommendation applies.'
    isRequired: true
    types:
    - <xref:str>
  - name: recommendation_id
    description: The recommendation ID.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ResourceRecommendationBase, or the result of cls(response)
    types:
    - <xref:azure.mgmt.advisor.models.ResourceRecommendationBase>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.advisor.aio.operations.RecommendationsOperations.get_generate_status
  name: get_generate_status
  summary: '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.'
  signature: 'async get_generate_status(operation_id: str, **kwargs) -> None'
  parameters:
  - name: operation_id
    description: 'The operation ID, which can be found from the Location field in
      the

      generate recommendation response header.'
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: None, or the result of cls(response)
    types:
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.advisor.aio.operations.RecommendationsOperations.list
  name: list
  summary: 'Obtains cached recommendations for a subscription. The recommendations
    are generated or

    computed by invoking generateRecommendations.'
  signature: 'list(filter: str | None = None, top: int | None = None, skip_token:
    str | None = None, **kwargs) -> AsyncIterable[ResourceRecommendationBaseListResult]'
  parameters:
  - name: filter
    description: 'The filter to apply to the recommendations.:code:<xref:category>'']
      with operators [''eq'', ''and'', ''or''].:code:*<br>`Example::code:`<br>*-

      $filter=Category eq ''Cost'' and ResourceGroup eq ''MyResourceGroup''.'
    defaultValue: None
    types:
    - <xref:str>
  - name: top
    description: 'The number of recommendations per page if a paged version of this
      API is being

      used.'
    defaultValue: None
    types:
    - <xref:int>
  - name: skip_token
    description: The page-continuation token to use with a paged version of this API.
    defaultValue: None
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: An iterator like instance of either ResourceRecommendationBaseListResult
      or the result of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.advisor.models.ResourceRecommendationBaseListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.advisor.aio.operations.RecommendationsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.advisor.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\advisor\\models\\__init__.py'>