MockableConsumptionArmClient Class

Definition

A class to add extension methods to ArmClient.

public class MockableConsumptionArmClient : Azure.ResourceManager.ArmResource
type MockableConsumptionArmClient = class
    inherit ArmResource
Public Class MockableConsumptionArmClient
Inherits ArmResource
Inheritance
MockableConsumptionArmClient

Constructors

MockableConsumptionArmClient()

Initializes a new instance of the MockableConsumptionArmClient class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

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)
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetBillingAccountConsumptionResource(ResourceIdentifier)

Gets an object representing a BillingAccountConsumptionResource along with the instance operations that can be performed on it but with no data. You can use Azure.ResourceManager.Consumption.BillingAccountConsumptionResource.CreateResourceIdentifier(System.String) to create a BillingAccountConsumptionResourceResourceIdentifier from its components.

GetBillingCustomerConsumptionResource(ResourceIdentifier)

Gets an object representing a BillingCustomerConsumptionResource along with the instance operations that can be performed on it but with no data. You can use Azure.ResourceManager.Consumption.BillingCustomerConsumptionResource.CreateResourceIdentifier(System.String,System.String) to create a BillingCustomerConsumptionResourceResourceIdentifier from its components.

GetBillingProfileConsumptionResource(ResourceIdentifier)

Gets an object representing a BillingProfileConsumptionResource along with the instance operations that can be performed on it but with no data. You can use Azure.ResourceManager.Consumption.BillingProfileConsumptionResource.CreateResourceIdentifier(System.String,System.String) to create a BillingProfileConsumptionResourceResourceIdentifier from its components.

GetConsumptionBudget(ResourceIdentifier, String, CancellationToken)

Gets the budget for the scope by budget name.

  • Request Path: /{scope}/providers/Microsoft.Consumption/budgets/{budgetName}
  • Operation Id: Budgets_Get
GetConsumptionBudgetAsync(ResourceIdentifier, String, CancellationToken)

Gets the budget for the scope by budget name.

  • Request Path: /{scope}/providers/Microsoft.Consumption/budgets/{budgetName}
  • Operation Id: Budgets_Get
GetConsumptionBudgetResource(ResourceIdentifier)

Gets an object representing a ConsumptionBudgetResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String) to create a ConsumptionBudgetResourceResourceIdentifier from its components.

GetConsumptionBudgets(ResourceIdentifier)

Gets a collection of ConsumptionBudgetResources in the ArmClient.

GetConsumptionCharges(ResourceIdentifier, String, String, String, String, CancellationToken)

Lists the charges based for the defined scope.

  • Request Path: /{scope}/providers/Microsoft.Consumption/charges
  • Operation Id: Charges_List
GetConsumptionChargesAsync(ResourceIdentifier, String, String, String, String, CancellationToken)

Lists the charges based for the defined scope.

  • Request Path: /{scope}/providers/Microsoft.Consumption/charges
  • Operation Id: Charges_List
GetConsumptionMarketPlaces(ResourceIdentifier, String, Nullable<Int32>, String, CancellationToken)

Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

  • Request Path: /{scope}/providers/Microsoft.Consumption/marketplaces
  • Operation Id: Marketplaces_List
GetConsumptionMarketPlacesAsync(ResourceIdentifier, String, Nullable<Int32>, String, CancellationToken)

Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.

  • Request Path: /{scope}/providers/Microsoft.Consumption/marketplaces
  • Operation Id: Marketplaces_List
GetConsumptionReservationRecommendationDetails(ResourceIdentifier, ConsumptionReservationRecommendationScope, String, ConsumptionReservationRecommendationTerm, ConsumptionReservationRecommendationLookBackPeriod, String, CancellationToken)

Details of a reservation recommendation for what-if analysis of reserved instances.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails
  • Operation Id: ReservationRecommendationDetails_Get
GetConsumptionReservationRecommendationDetailsAsync(ResourceIdentifier, ConsumptionReservationRecommendationScope, String, ConsumptionReservationRecommendationTerm, ConsumptionReservationRecommendationLookBackPeriod, String, CancellationToken)

Details of a reservation recommendation for what-if analysis of reserved instances.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendationDetails
  • Operation Id: ReservationRecommendationDetails_Get
GetConsumptionReservationRecommendations(ResourceIdentifier, String, CancellationToken)

List of recommendations for purchasing reserved instances.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendations
  • Operation Id: ReservationRecommendations_List
GetConsumptionReservationRecommendationsAsync(ResourceIdentifier, String, CancellationToken)

List of recommendations for purchasing reserved instances.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationRecommendations
  • Operation Id: ReservationRecommendations_List
GetConsumptionReservationsDetails(ResourceIdentifier, String, String, String, String, String, CancellationToken)

Lists the reservations details for the defined scope and provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 502 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationDetails
  • Operation Id: ReservationsDetails_List
GetConsumptionReservationsDetailsAsync(ResourceIdentifier, String, String, String, String, String, CancellationToken)

Lists the reservations details for the defined scope and provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 502 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationDetails
  • Operation Id: ReservationsDetails_List
GetConsumptionReservationsSummaries(ResourceIdentifier, ArmResourceGetConsumptionReservationsSummariesOptions, CancellationToken)

Lists the reservations summaries for the defined scope daily or monthly grain.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationSummaries
  • Operation Id: ReservationsSummaries_List
GetConsumptionReservationsSummariesAsync(ResourceIdentifier, ArmResourceGetConsumptionReservationsSummariesOptions, CancellationToken)

Lists the reservations summaries for the defined scope daily or monthly grain.

  • Request Path: /{resourceScope}/providers/Microsoft.Consumption/reservationSummaries
  • Operation Id: ReservationsSummaries_List
GetConsumptionTags(ResourceIdentifier, CancellationToken)

Get all available tag keys for the defined scope

  • Request Path: /{scope}/providers/Microsoft.Consumption/tags
  • Operation Id: Tags_Get
GetConsumptionTagsAsync(ResourceIdentifier, CancellationToken)

Get all available tag keys for the defined scope

  • Request Path: /{scope}/providers/Microsoft.Consumption/tags
  • Operation Id: Tags_Get
GetConsumptionUsageDetails(ResourceIdentifier, String, String, String, Nullable<Int32>, Nullable<ConsumptionMetricType>, CancellationToken)

Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

  • Request Path: /{scope}/providers/Microsoft.Consumption/usageDetails
  • Operation Id: UsageDetails_List
GetConsumptionUsageDetailsAsync(ResourceIdentifier, String, String, String, Nullable<Int32>, Nullable<ConsumptionMetricType>, CancellationToken)

Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

  • Request Path: /{scope}/providers/Microsoft.Consumption/usageDetails
  • Operation Id: UsageDetails_List
GetManagementGroupBillingPeriodConsumptionResource(ResourceIdentifier)

Gets an object representing a ManagementGroupBillingPeriodConsumptionResource along with the instance operations that can be performed on it but with no data. You can use Azure.ResourceManager.Consumption.ManagementGroupBillingPeriodConsumptionResource.CreateResourceIdentifier(System.String,System.String) to create a ManagementGroupBillingPeriodConsumptionResourceResourceIdentifier from its components.

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)
GetReservationConsumptionResource(ResourceIdentifier)

Gets an object representing a ReservationConsumptionResource along with the instance operations that can be performed on it but with no data. You can use Azure.ResourceManager.Consumption.ReservationConsumptionResource.CreateResourceIdentifier(System.String,System.String) to create a ReservationConsumptionResourceResourceIdentifier from its components.

GetReservationOrderConsumptionResource(ResourceIdentifier)

Gets an object representing a ReservationOrderConsumptionResource along with the instance operations that can be performed on it but with no data. You can use Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource.CreateResourceIdentifier(System.String) to create a ReservationOrderConsumptionResourceResourceIdentifier from its components.

GetSubscriptionBillingPeriodConsumptionResource(ResourceIdentifier)

Gets an object representing a SubscriptionBillingPeriodConsumptionResource along with the instance operations that can be performed on it but with no data. You can use Azure.ResourceManager.Consumption.SubscriptionBillingPeriodConsumptionResource.CreateResourceIdentifier(System.String,System.String) to create a SubscriptionBillingPeriodConsumptionResourceResourceIdentifier from its components.

GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetTenantBillingPeriodConsumptionResource(ResourceIdentifier)

Gets an object representing a TenantBillingPeriodConsumptionResource along with the instance operations that can be performed on it but with no data. You can use Azure.ResourceManager.Consumption.TenantBillingPeriodConsumptionResource.CreateResourceIdentifier(System.String,System.String) to create a TenantBillingPeriodConsumptionResourceResourceIdentifier from its components.

TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)

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.

Applies to