ReservationOrderResource Class

Definition

Namespace:

Azure.ResourceManager.Reservations

Assembly:

Azure.ResourceManager.Reservations.dll

Package:

Azure.ResourceManager.Reservations v1.4.0

Source:

ReservationOrderResource.cs

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

type ReservationOrderResource = class
    inherit ArmResource

Public Class ReservationOrderResource
Inherits ArmResource

Inheritance

Object

ArmResource

ReservationOrderResource

Constructors

ReservationOrderResource()

Initializes a new instance of the ReservationOrderResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

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

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
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
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
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
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
GetAsync(String, CancellationToken)	Get the details of the ReservationOrder. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId} Operation Id: ReservationOrder_Get
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
GetReservationDetailAsync(Guid, String, CancellationToken)	Get specific Reservation details. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId} Operation Id: Reservation_Get
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 Reservations into a new Reservation. The two Reservations being merged must have same properties. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/merge Operation Id: Reservation_Merge
MergeReservationAsync(WaitUntil, MergeContent, CancellationToken)	Merge the specified Reservations into a new Reservation. The two Reservations being merged must have same properties. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/merge Operation Id: Reservation_Merge
Return(WaitUntil, ReservationRefundContent, CancellationToken)	Return a reservation and get refund information. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/return Operation Id: Return_Post
ReturnAsync(WaitUntil, ReservationRefundContent, CancellationToken)	Return a reservation and get refund information. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/return Operation Id: Return_Post
SplitReservation(WaitUntil, SplitContent, CancellationToken)	Split a Reservation into two Reservations with specified quantity distribution. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/split Operation Id: Reservation_Split
SplitReservationAsync(WaitUntil, SplitContent, CancellationToken)	Split a Reservation into two Reservations with specified quantity distribution. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/split Operation Id: Reservation_Split
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
UpdateAsync(WaitUntil, ReservationPurchaseContent, CancellationToken)	Purchase ReservationOrder and create resource under the specified URI. Request Path: /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId} Operation Id: ReservationOrder_Purchase

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Get role definition by name (GUID). Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} Operation Id: RoleDefinitions_Get Default Api Version: 2022-04-01 Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Get role definition by name (GUID). Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} Operation Id: RoleDefinitions_Get Default Api Version: 2022-04-01 Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment. Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} Operation Id: DenyAssignments_Get Default Api Version: 2022-04-01 Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment. Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} Operation Id: DenyAssignments_Get Default Api Version: 2022-04-01 Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Operation Id: RoleAssignments_Get Default Api Version: 2022-04-01 Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Operation Id: RoleAssignments_Get Default Api Version: 2022-04-01 Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName} Operation Id: RoleAssignmentSchedules_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName} Operation Id: RoleAssignmentSchedules_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName} Operation Id: RoleAssignmentScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName} Operation Id: RoleAssignmentScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName} Operation Id: RoleAssignmentScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName} Operation Id: RoleAssignmentScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName} Operation Id: RoleEligibilitySchedules_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName} Operation Id: RoleEligibilitySchedules_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName} Operation Id: RoleEligibilityScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName} Operation Id: RoleEligibilityScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName} Operation Id: RoleEligibilityScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName} Operation Id: RoleEligibilityScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName} Operation Id: RoleManagementPolicies_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName} Operation Id: RoleManagementPolicyAssignments_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName} Operation Id: RoleManagementPolicyAssignments_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName} Operation Id: RoleManagementPolicies_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.