CapacityReservationGroups.yml

### YamlMime:TSType
name: CapacityReservationGroups
uid: '@azure/arm-compute.CapacityReservationGroups'
package: '@azure/arm-compute'
summary: Interface representing a CapacityReservationGroups.
fullName: CapacityReservationGroups
remarks: ''
isDeprecated: false
type: interface
methods:
  - name: >-
      createOrUpdate(string, string, CapacityReservationGroup,
      CapacityReservationGroupsCreateOrUpdateOptionalParams)
    uid: '@azure/arm-compute.CapacityReservationGroups.createOrUpdate'
    package: '@azure/arm-compute'
    summary: >-
      The operation to create or update a capacity reservation group. When
      updating a capacity reservation

      group, only tags and sharing profile may be modified. Please refer to

      https://aka.ms/CapacityReservation for more details.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function createOrUpdate(resourceGroupName: string,
        capacityReservationGroupName: string, parameters:
        CapacityReservationGroup, options?:
        CapacityReservationGroupsCreateOrUpdateOptionalParams):
        Promise<CapacityReservationGroup>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: capacityReservationGroupName
          type: string
          description: The name of the capacity reservation group.
        - id: parameters
          type: <xref uid="@azure/arm-compute.CapacityReservationGroup" />
          description: Parameters supplied to the Create capacity reservation Group.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-compute.CapacityReservationGroupsCreateOrUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/arm-compute.CapacityReservationGroup"
          />&gt;
  - name: delete(string, string, CapacityReservationGroupsDeleteOptionalParams)
    uid: '@azure/arm-compute.CapacityReservationGroups.delete'
    package: '@azure/arm-compute'
    summary: >-
      The operation to delete a capacity reservation group. This operation is
      allowed only if all the

      associated resources are disassociated from the reservation group and all
      capacity reservations

      under the reservation group have also been deleted. Please refer to

      https://aka.ms/CapacityReservation for more details.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function delete(resourceGroupName: string, capacityReservationGroupName:
        string, options?: CapacityReservationGroupsDeleteOptionalParams):
        Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: capacityReservationGroupName
          type: string
          description: The name of the capacity reservation group.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-compute.CapacityReservationGroupsDeleteOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: get(string, string, CapacityReservationGroupsGetOptionalParams)
    uid: '@azure/arm-compute.CapacityReservationGroups.get'
    package: '@azure/arm-compute'
    summary: >-
      The operation that retrieves information about a capacity reservation
      group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, capacityReservationGroupName:
        string, options?: CapacityReservationGroupsGetOptionalParams):
        Promise<CapacityReservationGroup>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: capacityReservationGroupName
          type: string
          description: The name of the capacity reservation group.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-compute.CapacityReservationGroupsGetOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/arm-compute.CapacityReservationGroup"
          />&gt;
  - name: >-
      listByResourceGroup(string,
      CapacityReservationGroupsListByResourceGroupOptionalParams)
    uid: '@azure/arm-compute.CapacityReservationGroups.listByResourceGroup'
    package: '@azure/arm-compute'
    summary: >-
      Lists all of the capacity reservation groups in the specified resource
      group. Use the nextLink

      property in the response to get the next page of capacity reservation
      groups.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByResourceGroup(resourceGroupName: string, options?:
        CapacityReservationGroupsListByResourceGroupOptionalParams):
        PagedAsyncIterableIterator<CapacityReservationGroup,
        CapacityReservationGroup[], PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-compute.CapacityReservationGroupsListByResourceGroupOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-compute.CapacityReservationGroup" />, <xref
          uid="@azure/arm-compute.CapacityReservationGroup" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;
  - name: >-
      listBySubscription(CapacityReservationGroupsListBySubscriptionOptionalParams)
    uid: '@azure/arm-compute.CapacityReservationGroups.listBySubscription'
    package: '@azure/arm-compute'
    summary: >-
      Lists all of the capacity reservation groups in the subscription. Use the
      nextLink property in the

      response to get the next page of capacity reservation groups.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listBySubscription(options?:
        CapacityReservationGroupsListBySubscriptionOptionalParams):
        PagedAsyncIterableIterator<CapacityReservationGroup,
        CapacityReservationGroup[], PageSettings>
      parameters:
        - id: options
          type: >-
            <xref
            uid="@azure/arm-compute.CapacityReservationGroupsListBySubscriptionOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-compute.CapacityReservationGroup" />, <xref
          uid="@azure/arm-compute.CapacityReservationGroup" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;
  - name: >-
      update(string, string, CapacityReservationGroupUpdate,
      CapacityReservationGroupsUpdateOptionalParams)
    uid: '@azure/arm-compute.CapacityReservationGroups.update'
    package: '@azure/arm-compute'
    summary: >-
      The operation to update a capacity reservation group. When updating a
      capacity reservation group,

      only tags and sharing profile may be modified.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function update(resourceGroupName: string, capacityReservationGroupName:
        string, parameters: CapacityReservationGroupUpdate, options?:
        CapacityReservationGroupsUpdateOptionalParams):
        Promise<CapacityReservationGroup>
      parameters:
        - id: resourceGroupName
          type: string
          description: The name of the resource group.
        - id: capacityReservationGroupName
          type: string
          description: The name of the capacity reservation group.
        - id: parameters
          type: <xref uid="@azure/arm-compute.CapacityReservationGroupUpdate" />
          description: >-
            Parameters supplied to the Update capacity reservation Group
            operation.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-compute.CapacityReservationGroupsUpdateOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/arm-compute.CapacityReservationGroup"
          />&gt;