ReservationsExtensions.GetReservationDetails Method

Definition

Namespace:

Azure.ResourceManager.Reservations

Assembly:

Azure.ResourceManager.Reservations.dll

Package:

Azure.ResourceManager.Reservations v1.4.0

Overloads

GetReservationDetails(TenantResource, TenantResourceGetReservationDetailsOptions, CancellationToken)	List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant. Request Path: /providers/Microsoft.Capacity/reservations Operation Id: Reservation_ListAll
GetReservationDetails(TenantResource, String, String, String, Nullable<Single>, String, Nullable<Single>, CancellationToken)	List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant. Request Path: /providers/Microsoft.Capacity/reservations Operation Id: Reservation_ListAll

GetReservationDetails(TenantResource, TenantResourceGetReservationDetailsOptions, CancellationToken)

Source:

ReservationsExtensions.cs

List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.

• Request Path: /providers/Microsoft.Capacity/reservations
• Operation Id: Reservation_ListAll

public static Azure.Pageable<Azure.ResourceManager.Reservations.ReservationDetailResource> GetReservationDetails (this Azure.ResourceManager.Resources.TenantResource tenantResource, Azure.ResourceManager.Reservations.Models.TenantResourceGetReservationDetailsOptions options, System.Threading.CancellationToken cancellationToken = default);

static member GetReservationDetails : Azure.ResourceManager.Resources.TenantResource * Azure.ResourceManager.Reservations.Models.TenantResourceGetReservationDetailsOptions * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Reservations.ReservationDetailResource>

<Extension()>
Public Function GetReservationDetails (tenantResource As TenantResource, options As TenantResourceGetReservationDetailsOptions, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ReservationDetailResource)

Parameters

tenantResource

TenantResource

The TenantResource instance the method will execute against.

options

TenantResourceGetReservationDetailsOptions

A property bag which contains all the parameters of this method except the LRO qualifier and request context parameter.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<ReservationDetailResource>

A collection of ReservationDetailResource that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

tenantResource is null.

GetReservationDetails(TenantResource, String, String, String, Nullable<Single>, String, Nullable<Single>, CancellationToken)

Source:

ReservationsExtensions.cs

List the reservations and the roll up counts of reservations group by provisioning states that the user has access to in the current tenant.

• Request Path: /providers/Microsoft.Capacity/reservations
• Operation Id: Reservation_ListAll

public static Azure.Pageable<Azure.ResourceManager.Reservations.ReservationDetailResource> GetReservationDetails (this Azure.ResourceManager.Resources.TenantResource tenantResource, string filter = default, string orderby = default, string refreshSummary = default, float? skiptoken = default, string selectedState = default, float? take = default, System.Threading.CancellationToken cancellationToken = default);

static member GetReservationDetails : Azure.ResourceManager.Resources.TenantResource * string * string * string * Nullable<single> * string * Nullable<single> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Reservations.ReservationDetailResource>

<Extension()>
Public Function GetReservationDetails (tenantResource As TenantResource, Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional refreshSummary As String = Nothing, Optional skiptoken As Nullable(Of Single) = Nothing, Optional selectedState As String = Nothing, Optional take As Nullable(Of Single) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ReservationDetailResource)

Parameters

tenantResource

TenantResource

The TenantResource instance the method will execute against.

filter

String

May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'. Reservation properties include sku/name, properties/{appliedScopeType, archived, displayName, displayProvisioningState, effectiveDateTime, expiryDate, provisioningState, quantity, renew, reservedResourceType, term, userFriendlyAppliedScopeType, userFriendlyRenewState}.

orderby

String

May be used to sort order by reservation properties.

refreshSummary

String

To indicate whether to refresh the roll up counts of the reservations group by provisioning states.

skiptoken

Nullable<Single>

The number of reservations to skip from the list before returning results.

selectedState

String

The selected provisioning state.

take

Nullable<Single>

To number of reservations to return.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Pageable<ReservationDetailResource>

A collection of ReservationDetailResource that may take multiple service requests to iterate over.