Edit

Invoke-AzReservationExchange

  • Reference
Module:
Az.Reservations

Returns one or more Reservations in exchange for one or more Reservation purchases.\n

Syntax

Invoke-AzReservationExchange
      [-SessionId <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Invoke-AzReservationExchange
      -Body <IExchangeRequest>
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

Returns one or more Reservations in exchange for one or more Reservation purchases.\n

Examples

Example 1: Proceed reservations exchange with session ID obtained from Invoke-AzReservationCalculateExchange

Invoke-AzReservationExchange -SessionId 8982593c-679e-4d4e-b971-c48b6d824cba

SessionId                            Status   
---------                            ------   
8982593c-679e-4d4e-b971-c48b6d824cba Succeeded

Proceed reservations exchange with session ID obtained from Invoke-AzReservationCalculateExchange. This is a long running POST operation which can take around 10ish mins.

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Body

Exchange request To construct, see NOTES section for BODY properties and create a hash table.

Type:IExchangeRequest
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SessionId

SessionId that was returned by CalculateExchange API.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IExchangeRequest

Outputs

IExchangeOperationResultResponse

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODY <IExchangeRequest>: Exchange request

  • [SessionId <String>]: SessionId that was returned by CalculateExchange API.