azure.mgmt.billing.aio.operations.ProductsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.billing.aio.operations.ProductsOperations
name: ProductsOperations
fullName: azure.mgmt.billing.aio.operations.ProductsOperations
module: azure.mgmt.billing.aio.operations
inheritances:
- builtins.object
summary: 'ProductsOperations 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: ProductsOperations(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.billing.aio.operations.ProductsOperations.get
  name: get
  summary: 'Gets a product by ID. The operation is supported only for billing accounts
    with agreement type

    Microsoft Customer Agreement.'
  signature: 'async get(billing_account_name: str, product_name: str, **kwargs) ->
    Product'
  parameters:
  - name: billing_account_name
    description: The ID that uniquely identifies a billing account.
    isRequired: true
    types:
    - <xref:str>
  - name: product_name
    description: The ID that uniquely identifies a product.
    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: Product, or the result of cls(response)
    types:
    - <xref:azure.mgmt.billing.models.Product>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.billing.aio.operations.ProductsOperations.list_by_billing_account
  name: list_by_billing_account
  summary: 'Lists the products for a billing account. These don''t include products
    billed based on usage.

    The operation is supported for billing accounts with agreement type Microsoft
    Customer

    Agreement or Microsoft Partner Agreement.'
  signature: 'list_by_billing_account(billing_account_name: str, filter: str | None
    = None, **kwargs) -> AsyncIterable[ProductsListResult]'
  parameters:
  - name: billing_account_name
    description: The ID that uniquely identifies a billing account.
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: 'May be used to filter by product type. The filter supports ''eq'',
      ''lt'', ''gt'',

      ''le'', ''ge'', and ''and''. It does not currently support ''ne'', ''or'', or
      ''not''. Tag filter is a key

      value pair string where key and value are separated by a colon (:).'
    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 ProductsListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.billing.models.ProductsListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.billing.aio.operations.ProductsOperations.list_by_billing_profile
  name: list_by_billing_profile
  summary: 'Lists the products for a billing profile. These don''t include products
    billed based on usage.

    The operation is supported for billing accounts with agreement type Microsoft
    Customer

    Agreement or Microsoft Partner Agreement.'
  signature: 'list_by_billing_profile(billing_account_name: str, billing_profile_name:
    str, filter: str | None = None, **kwargs) -> AsyncIterable[ProductsListResult]'
  parameters:
  - name: billing_account_name
    description: The ID that uniquely identifies a billing account.
    isRequired: true
    types:
    - <xref:str>
  - name: billing_profile_name
    description: The ID that uniquely identifies a billing profile.
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: 'May be used to filter by product type. The filter supports ''eq'',
      ''lt'', ''gt'',

      ''le'', ''ge'', and ''and''. It does not currently support ''ne'', ''or'', or
      ''not''. Tag filter is a key

      value pair string where key and value are separated by a colon (:).'
    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 ProductsListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.billing.models.ProductsListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.billing.aio.operations.ProductsOperations.list_by_customer
  name: list_by_customer
  summary: 'Lists the products for a customer. These don''t include products billed
    based on usage.The

    operation is supported only for billing accounts with agreement type Microsoft
    Partner

    Agreement.'
  signature: 'list_by_customer(billing_account_name: str, customer_name: str, **kwargs)
    -> AsyncIterable[ProductsListResult]'
  parameters:
  - name: billing_account_name
    description: The ID that uniquely identifies a billing account.
    isRequired: true
    types:
    - <xref:str>
  - name: customer_name
    description: The ID that uniquely identifies a customer.
    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: An iterator like instance of either ProductsListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.billing.models.ProductsListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.billing.aio.operations.ProductsOperations.list_by_invoice_section
  name: list_by_invoice_section
  summary: 'Lists the products for an invoice section. These don''t include products
    billed based on usage.

    The operation is supported only for billing accounts with agreement type Microsoft
    Customer

    Agreement.'
  signature: 'list_by_invoice_section(billing_account_name: str, billing_profile_name:
    str, invoice_section_name: str, filter: str | None = None, **kwargs) -> AsyncIterable[ProductsListResult]'
  parameters:
  - name: billing_account_name
    description: The ID that uniquely identifies a billing account.
    isRequired: true
    types:
    - <xref:str>
  - name: billing_profile_name
    description: The ID that uniquely identifies a billing profile.
    isRequired: true
    types:
    - <xref:str>
  - name: invoice_section_name
    description: The ID that uniquely identifies an invoice section.
    isRequired: true
    types:
    - <xref:str>
  - name: filter
    description: 'May be used to filter by product type. The filter supports ''eq'',
      ''lt'', ''gt'',

      ''le'', ''ge'', and ''and''. It does not currently support ''ne'', ''or'', or
      ''not''. Tag filter is a key

      value pair string where key and value are separated by a colon (:).'
    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 ProductsListResult or the result
      of cls(response)
    types:
    - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.billing.models.ProductsListResult>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.billing.aio.operations.ProductsOperations.move
  name: move
  summary: 'Moves a product''s charges to a new invoice section. The new invoice section
    must belong to the

    same billing profile as the existing invoice section. This operation is supported
    only for

    products that are purchased with a recurring charge and for billing accounts with
    agreement

    type Microsoft Customer Agreement.'
  signature: 'async move(billing_account_name: str, product_name: str, parameters:
    TransferProductRequestProperties, **kwargs) -> Product | None'
  parameters:
  - name: billing_account_name
    description: The ID that uniquely identifies a billing account.
    isRequired: true
    types:
    - <xref:str>
  - name: product_name
    description: The ID that uniquely identifies a product.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: Request parameters that are provided to the move product operation.
    isRequired: true
    types:
    - <xref:azure.mgmt.billing.models.TransferProductRequestProperties>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Product, or the result of cls(response)
    types:
    - <xref:azure.mgmt.billing.models.Product>
    - <xref:None>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.billing.aio.operations.ProductsOperations.update
  name: update
  summary: 'Updates the properties of a Product. Currently, auto renew can be updated.
    The operation is

    supported only for billing accounts with agreement type Microsoft Customer Agreement.'
  signature: 'async update(billing_account_name: str, product_name: str, parameters:
    Product, **kwargs) -> Product'
  parameters:
  - name: billing_account_name
    description: The ID that uniquely identifies a billing account.
    isRequired: true
    types:
    - <xref:str>
  - name: product_name
    description: The ID that uniquely identifies a product.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: Request parameters that are provided to the update product operation.
    isRequired: true
    types:
    - <xref:azure.mgmt.billing.models.Product>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: Product, or the result of cls(response)
    types:
    - <xref:azure.mgmt.billing.models.Product>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.billing.aio.operations.ProductsOperations.validate_move
  name: validate_move
  summary: 'Validates if a product''s charges can be moved to a new invoice section.
    This operation is

    supported only for products that are purchased with a recurring charge and for
    billing accounts

    with agreement type Microsoft Customer Agreement.'
  signature: 'async validate_move(billing_account_name: str, product_name: str, parameters:
    TransferProductRequestProperties, **kwargs) -> ValidateProductTransferEligibilityResult'
  parameters:
  - name: billing_account_name
    description: The ID that uniquely identifies a billing account.
    isRequired: true
    types:
    - <xref:str>
  - name: product_name
    description: The ID that uniquely identifies a product.
    isRequired: true
    types:
    - <xref:str>
  - name: parameters
    description: 'Request parameters that are provided to the validate move eligibility

      operation.'
    isRequired: true
    types:
    - <xref:azure.mgmt.billing.models.TransferProductRequestProperties>
  keywordOnlyParameters:
  - name: cls
    description: A custom type or function that will be passed the direct response
    types:
    - <xref:callable>
  return:
    description: ValidateProductTransferEligibilityResult, or the result of cls(response)
    types:
    - <xref:azure.mgmt.billing.models.ValidateProductTransferEligibilityResult>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.billing.aio.operations.ProductsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.billing.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\billing\\models\\__init__.py'>