Share via

MockableCostManagementArmClient Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.CostManagement.Mocking
Assembly:
Azure.ResourceManager.CostManagement.dll
Package:
Azure.ResourceManager.CostManagement v1.0.1
Source:
MockableCostManagementArmClient.cs

A class to add extension methods to ArmClient.

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

Constructors

MockableCostManagementArmClient()

Initializes a new instance of the MockableCostManagementArmClient 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)
CheckCostManagementNameAvailabilityByScopeScheduledAction(ResourceIdentifier, CostManagementNameAvailabilityContent, CancellationToken)

Checks availability and correctness of the name for a scheduled action within the given scope.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/checkNameAvailability
  • Operation Id: ScheduledActions_CheckNameAvailabilityByScope
CheckCostManagementNameAvailabilityByScopeScheduledActionAsync(ResourceIdentifier, CostManagementNameAvailabilityContent, CancellationToken)

Checks availability and correctness of the name for a scheduled action within the given scope.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/checkNameAvailability
  • Operation Id: ScheduledActions_CheckNameAvailabilityByScope
GetAllCostManagementViews(ResourceIdentifier)

Gets a collection of CostManagementViewsResources in the ArmClient.
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetBenefitRecommendations(ResourceIdentifier, String, String, String, CancellationToken)

List of recommendations for purchasing savings plan.

  • Request Path: /{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations
  • Operation Id: BenefitRecommendations_List
GetBenefitRecommendationsAsync(ResourceIdentifier, String, String, String, CancellationToken)

List of recommendations for purchasing savings plan.

  • Request Path: /{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations
  • Operation Id: BenefitRecommendations_List
GetCostManagementAlert(ResourceIdentifier, String, CancellationToken)

Gets the alert for the scope by alert ID.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/alerts/{alertId}
  • Operation Id: Alerts_Get
GetCostManagementAlertAsync(ResourceIdentifier, String, CancellationToken)

Gets the alert for the scope by alert ID.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/alerts/{alertId}
  • Operation Id: Alerts_Get
GetCostManagementAlertResource(ResourceIdentifier)

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

Gets a collection of CostManagementAlertResources in the ArmClient.
GetCostManagementExport(ResourceIdentifier, String, String, CancellationToken)

The operation to get the export for the defined scope by export name.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
  • Operation Id: Exports_Get
GetCostManagementExportAsync(ResourceIdentifier, String, String, CancellationToken)

The operation to get the export for the defined scope by export name.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/exports/{exportName}
  • Operation Id: Exports_Get
GetCostManagementExportResource(ResourceIdentifier)

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

Gets a collection of CostManagementExportResources in the ArmClient.
GetCostManagementViews(ResourceIdentifier, String, CancellationToken)

Gets the view for the defined scope by view name.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/views/{viewName}
  • Operation Id: Views_GetByScope
GetCostManagementViewsAsync(ResourceIdentifier, String, CancellationToken)

Gets the view for the defined scope by view name.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/views/{viewName}
  • Operation Id: Views_GetByScope
GetCostManagementViewsResource(ResourceIdentifier)

Gets an object representing a CostManagementViewsResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String) to create a CostManagementViewsResourceResourceIdentifier from its components.
GetDimensions(ResourceIdentifier, String, String, String, Nullable<Int32>, CancellationToken)

Lists the dimensions by the defined scope.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/dimensions
  • Operation Id: Dimensions_List
GetDimensionsAsync(ResourceIdentifier, String, String, String, Nullable<Int32>, CancellationToken)

Lists the dimensions by the defined scope.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/dimensions
  • Operation Id: Dimensions_List
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)
GetScheduledAction(ResourceIdentifier, String, CancellationToken)

Get the shared scheduled action from the given scope by name.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
  • Operation Id: ScheduledActions_GetByScope
GetScheduledActionAsync(ResourceIdentifier, String, CancellationToken)

Get the shared scheduled action from the given scope by name.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}
  • Operation Id: ScheduledActions_GetByScope
GetScheduledActionResource(ResourceIdentifier)

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

Gets a collection of ScheduledActionResources in the ArmClient.
GetTagResource()

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

(Inherited from ArmResource)
GetTenantScheduledActionResource(ResourceIdentifier)

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

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

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

(Inherited from ArmResource)
UsageForecast(ResourceIdentifier, ForecastDefinition, String, CancellationToken)

Lists the forecast charges for scope defined.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/forecast
  • Operation Id: Forecast_Usage
UsageForecastAsync(ResourceIdentifier, ForecastDefinition, String, CancellationToken)

Lists the forecast charges for scope defined.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/forecast
  • Operation Id: Forecast_Usage
UsageQuery(ResourceIdentifier, QueryDefinition, CancellationToken)

Query the usage data for scope defined.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/query
  • Operation Id: Query_Usage
UsageQueryAsync(ResourceIdentifier, QueryDefinition, CancellationToken)

Query the usage data for scope defined.

  • Request Path: /{scope}/providers/Microsoft.CostManagement/query
  • Operation Id: Query_Usage

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