ReservationOrderResource Class

Definition

Namespace:: Azure.ResourceManager.Reservations

Assembly:: Azure.ResourceManager.Reservations.dll

Package:: Azure.ResourceManager.Reservations v1.4.2

Package:: Azure.ResourceManager.Reservations v1.4.0-beta.1

Source:: ReservationOrderResource.cs

Source:: ReservationOrderResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A Class representing a ReservationOrder along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ReservationOrderResource from an instance of ArmClient using the GetReservationOrderResource method. Otherwise you can get one from its parent resource TenantResource using the GetReservationOrder method.

public class ReservationOrderResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Reservations.ReservationOrderData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Reservations.ReservationOrderData>

public class ReservationOrderResource : Azure.ResourceManager.ArmResource

type ReservationOrderResource = class
    inherit ArmResource
    interface IJsonModel<ReservationOrderData>
    interface IPersistableModel<ReservationOrderData>

type ReservationOrderResource = class
    inherit ArmResource

Public Class ReservationOrderResource
Inherits ArmResource
Implements IJsonModel(Of ReservationOrderData), IPersistableModel(Of ReservationOrderData)

Public Class ReservationOrderResource
Inherits ArmResource

Inheritance: Object

ArmResource
ReservationOrderResource

Implements: IJsonModel<ReservationOrderData> IPersistableModel<ReservationOrderData> IPersistableModel<T>

Constructors

Name	Description
ReservationOrderResource()	Initializes a new instance of the ReservationOrderResource class for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Data	Gets the data representing this Feature.
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
HasData	Gets whether or not the current instance has data.
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

Name	Description
CalculateRefund(ReservationCalculateRefundContent, CancellationToken)	Calculate price for returning `Reservations` if there are no policy errors. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/calculateRefund Operation Id: CalculateRefund_Post Default Api Version: 2022-11-01
CalculateRefundAsync(ReservationCalculateRefundContent, CancellationToken)	Calculate price for returning `Reservations` if there are no policy errors. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/calculateRefund Operation Id: CalculateRefund_Post Default Api Version: 2022-11-01
CanUseTagResource(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
ChangeDirectory(ChangeDirectoryContent, CancellationToken)	Change directory (tenant) of `ReservationOrder` and all `Reservation` under it to specified tenant id Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/changeDirectory Operation Id: ReservationOrder_ChangeDirectory Default Api Version: 2022-11-01 Resource: ReservationOrderResource
ChangeDirectoryAsync(ChangeDirectoryContent, CancellationToken)	Change directory (tenant) of `ReservationOrder` and all `Reservation` under it to specified tenant id Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/changeDirectory Operation Id: ReservationOrder_ChangeDirectory Default Api Version: 2022-11-01 Resource: ReservationOrderResource
CreateResourceIdentifier(Guid)	Generate the resource identifier of a ReservationOrderResource instance.
Get(String, CancellationToken)	Get the details of the `ReservationOrder`. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId} Operation Id: ReservationOrder_Get Default Api Version: 2022-11-01 Resource: ReservationOrderResource
GetAsync(String, CancellationToken)	Get the details of the `ReservationOrder`. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId} Operation Id: ReservationOrder_Get Default Api Version: 2022-11-01 Resource: ReservationOrderResource
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetReservationDetail(Guid, String, CancellationToken)	Get specific `Reservation` details. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} Operation Id: Reservation_Get Default Api Version: 2022-11-01 Resource: ReservationDetailResource
GetReservationDetailAsync(Guid, String, CancellationToken)	Get specific `Reservation` details. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} Operation Id: Reservation_Get Default Api Version: 2022-11-01 Resource: ReservationDetailResource
GetReservationDetails()	Gets a collection of ReservationDetailResources in the ReservationOrder.
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
MergeReservation(WaitUntil, MergeContent, CancellationToken)	Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/merge Operation Id: Reservation_Merge Default Api Version: 2022-11-01 Resource: ReservationDetailResource
MergeReservationAsync(WaitUntil, MergeContent, CancellationToken)	Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/merge Operation Id: Reservation_Merge Default Api Version: 2022-11-01 Resource: ReservationDetailResource
Return(WaitUntil, ReservationRefundContent, CancellationToken)	Return a reservation and get refund information. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/return Operation Id: Return_Post Default Api Version: 2022-11-01
ReturnAsync(WaitUntil, ReservationRefundContent, CancellationToken)	Return a reservation and get refund information. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/return Operation Id: Return_Post Default Api Version: 2022-11-01
SplitReservation(WaitUntil, SplitContent, CancellationToken)	Split a `Reservation` into two `Reservation`s with specified quantity distribution. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/split Operation Id: Reservation_Split Default Api Version: 2022-11-01 Resource: ReservationDetailResource
SplitReservationAsync(WaitUntil, SplitContent, CancellationToken)	Split a `Reservation` into two `Reservation`s with specified quantity distribution. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/split Operation Id: Reservation_Split Default Api Version: 2022-11-01 Resource: ReservationDetailResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, ReservationPurchaseContent, CancellationToken)	Purchase `ReservationOrder` and create resource under the specified URI. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId} Operation Id: ReservationOrder_Purchase Default Api Version: 2022-11-01 Resource: ReservationOrderResource
UpdateAsync(WaitUntil, ReservationPurchaseContent, CancellationToken)	Purchase `ReservationOrder` and create resource under the specified URI. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId} Operation Id: ReservationOrder_Purchase Default Api Version: 2022-11-01 Resource: ReservationOrderResource

Explicit Interface Implementations

Name	Description
IJsonModel<ReservationOrderData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ReservationOrderData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ReservationOrderData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ReservationOrderData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ReservationOrderData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentCollection objects within the specified scope.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to

Feedback

Was this page helpful?