Share via


ResourcesExtensions Class

Definition

A class to add extension methods to Azure.ResourceManager.Resources.

public static class ResourcesExtensions
type ResourcesExtensions = class
Public Module ResourcesExtensions
Inheritance
ResourcesExtensions

Methods

BicepDecompile(SubscriptionResource, DecompileOperationContent, CancellationToken)

Decompiles an ARM json template into a Bicep template

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Resources/decompileBicep
  • Operation Id: Decompile_Bicep
  • Default Api Version: 2023-11-01
BicepDecompileAsync(SubscriptionResource, DecompileOperationContent, CancellationToken)

Decompiles an ARM json template into a Bicep template

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Resources/decompileBicep
  • Operation Id: Decompile_Bicep
  • Default Api Version: 2023-11-01
CalculateDeploymentTemplateHash(TenantResource, BinaryData, CancellationToken)

Calculate the hash of the given template.

  • Request Path: /providers/Microsoft.Resources/calculateTemplateHash
  • Operation Id: Deployments_CalculateTemplateHash
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
CalculateDeploymentTemplateHashAsync(TenantResource, BinaryData, CancellationToken)

Calculate the hash of the given template.

  • Request Path: /providers/Microsoft.Resources/calculateTemplateHash
  • Operation Id: Deployments_CalculateTemplateHash
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmApplication(ResourceGroupResource, String, CancellationToken)

Gets the managed application.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
  • Operation Id: Applications_Get
  • Default Api Version: 2019-07-01
  • Resource: ArmApplicationResource
GetArmApplicationAsync(ResourceGroupResource, String, CancellationToken)

Gets the managed application.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applications/{applicationName}
  • Operation Id: Applications_Get
  • Default Api Version: 2019-07-01
  • Resource: ArmApplicationResource
GetArmApplicationDefinition(ResourceGroupResource, String, CancellationToken)

Gets the managed application definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}
  • Operation Id: ApplicationDefinitions_Get
  • Default Api Version: 2019-07-01
  • Resource: ArmApplicationDefinitionResource
GetArmApplicationDefinitionAsync(ResourceGroupResource, String, CancellationToken)

Gets the managed application definition.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/applicationDefinitions/{applicationDefinitionName}
  • Operation Id: ApplicationDefinitions_Get
  • Default Api Version: 2019-07-01
  • Resource: ArmApplicationDefinitionResource
GetArmApplicationDefinitionResource(ArmClient, ResourceIdentifier)

Gets an object representing an ArmApplicationDefinitionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create an ArmApplicationDefinitionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetArmApplicationDefinitionResource(ResourceIdentifier) instead.

GetArmApplicationDefinitions(ResourceGroupResource)

Gets a collection of ArmApplicationDefinitionResources in the ResourceGroupResource. MockingTo mock this method, please mock GetArmApplicationDefinitions() instead.

GetArmApplicationResource(ArmClient, ResourceIdentifier)

Gets an object representing an ArmApplicationResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create an ArmApplicationResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetArmApplicationResource(ResourceIdentifier) instead.

GetArmApplications(ResourceGroupResource)

Gets a collection of ArmApplicationResources in the ResourceGroupResource. MockingTo mock this method, please mock GetArmApplications() instead.

GetArmApplications(SubscriptionResource, CancellationToken)

Gets all the applications within a subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/applications
  • Operation Id: Applications_ListBySubscription
  • Default Api Version: 2019-07-01
  • Resource: ArmApplicationResource
GetArmApplicationsAsync(SubscriptionResource, CancellationToken)

Gets all the applications within a subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/applications
  • Operation Id: Applications_ListBySubscription
  • Default Api Version: 2019-07-01
  • Resource: ArmApplicationResource
GetArmDeployment(ManagementGroupResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeployment(ResourceGroupResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeployment(SubscriptionResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeployment(TenantResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeploymentAsync(ManagementGroupResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeploymentAsync(ResourceGroupResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeploymentAsync(SubscriptionResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeploymentAsync(TenantResource, String, CancellationToken)

Gets a deployment.

  • Request Path: /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
  • Operation Id: Deployments_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: ArmDeploymentResource
GetArmDeploymentResource(ArmClient, ResourceIdentifier)

Gets an object representing an ArmDeploymentResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String) to create an ArmDeploymentResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetArmDeploymentResource(ResourceIdentifier) instead.

GetArmDeployments(ManagementGroupResource)

Gets a collection of ArmDeploymentResources in the ManagementGroupResource. MockingTo mock this method, please mock GetArmDeployments() instead.

GetArmDeployments(ResourceGroupResource)

Gets a collection of ArmDeploymentResources in the ResourceGroupResource. MockingTo mock this method, please mock GetArmDeployments() instead.

GetArmDeployments(SubscriptionResource)

Gets a collection of ArmDeploymentResources in the SubscriptionResource. MockingTo mock this method, please mock GetArmDeployments() instead.

GetArmDeployments(TenantResource)

Gets a collection of ArmDeploymentResources in the TenantResource. MockingTo mock this method, please mock GetArmDeployments() instead.

GetArmDeploymentScript(ResourceGroupResource, String, CancellationToken)

Gets a deployment script with a given name.

  • Request Path: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
  • Operation Id: DeploymentScripts_Get
  • Default Api Version: 2020-10-01
  • Resource: ArmDeploymentScriptResource
GetArmDeploymentScriptAsync(ResourceGroupResource, String, CancellationToken)

Gets a deployment script with a given name.

  • Request Path: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentScripts/{scriptName}
  • Operation Id: DeploymentScripts_Get
  • Default Api Version: 2020-10-01
  • Resource: ArmDeploymentScriptResource
GetArmDeploymentScriptResource(ArmClient, ResourceIdentifier)

Gets an object representing an ArmDeploymentScriptResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create an ArmDeploymentScriptResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetArmDeploymentScriptResource(ResourceIdentifier) instead.

GetArmDeploymentScripts(ResourceGroupResource)

Gets a collection of ArmDeploymentScriptResources in the ResourceGroupResource. MockingTo mock this method, please mock GetArmDeploymentScripts() instead.

GetArmDeploymentScripts(SubscriptionResource, CancellationToken)

Lists all deployment scripts for a given subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts
  • Operation Id: DeploymentScripts_ListBySubscription
  • Default Api Version: 2020-10-01
  • Resource: ArmDeploymentScriptResource
GetArmDeploymentScriptsAsync(SubscriptionResource, CancellationToken)

Lists all deployment scripts for a given subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentScripts
  • Operation Id: DeploymentScripts_ListBySubscription
  • Default Api Version: 2020-10-01
  • Resource: ArmDeploymentScriptResource
GetDataBoundaries(ArmClient, ResourceIdentifier)

Gets a collection of DataBoundaryResources in the ArmClient. MockingTo mock this method, please mock GetDataBoundaries(ResourceIdentifier) instead.

GetDataBoundary(ArmClient, ResourceIdentifier, DataBoundaryName, CancellationToken)

Get data boundary at specified scope

  • Request Path: /{scope}/providers/Microsoft.Resources/dataBoundaries/{default}
  • Operation Id: DataBoundaries_GetScope
  • Default Api Version: 2024-08-01
  • Resource: DataBoundaryResource
GetDataBoundaryAsync(ArmClient, ResourceIdentifier, DataBoundaryName, CancellationToken)

Get data boundary at specified scope

  • Request Path: /{scope}/providers/Microsoft.Resources/dataBoundaries/{default}
  • Operation Id: DataBoundaries_GetScope
  • Default Api Version: 2024-08-01
  • Resource: DataBoundaryResource
GetDataBoundaryResource(ArmClient, ResourceIdentifier)

Gets an object representing a DataBoundaryResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, DataBoundaryName) to create a DataBoundaryResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetDataBoundaryResource(ResourceIdentifier) instead.

GetDeploymentStack(ManagementGroupResource, String, CancellationToken)

Gets a Deployment stack with a given name at specific scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
  • Operation Id: DeploymentStacks_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: DeploymentStackResource
GetDeploymentStack(ResourceGroupResource, String, CancellationToken)

Gets a Deployment stack with a given name at specific scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
  • Operation Id: DeploymentStacks_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: DeploymentStackResource
GetDeploymentStack(SubscriptionResource, String, CancellationToken)

Gets a Deployment stack with a given name at specific scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
  • Operation Id: DeploymentStacks_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: DeploymentStackResource
GetDeploymentStackAsync(ManagementGroupResource, String, CancellationToken)

Gets a Deployment stack with a given name at specific scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
  • Operation Id: DeploymentStacks_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: DeploymentStackResource
GetDeploymentStackAsync(ResourceGroupResource, String, CancellationToken)

Gets a Deployment stack with a given name at specific scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
  • Operation Id: DeploymentStacks_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: DeploymentStackResource
GetDeploymentStackAsync(SubscriptionResource, String, CancellationToken)

Gets a Deployment stack with a given name at specific scope.

  • Request Path: /{scope}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}
  • Operation Id: DeploymentStacks_GetAtScope
  • Default Api Version: 2024-03-01
  • Resource: DeploymentStackResource
GetDeploymentStackResource(ArmClient, ResourceIdentifier)

Gets an object representing a DeploymentStackResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String) to create a DeploymentStackResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetDeploymentStackResource(ResourceIdentifier) instead.

GetDeploymentStacks(ManagementGroupResource)

Gets a collection of DeploymentStackResources in the ManagementGroupResource. MockingTo mock this method, please mock GetDeploymentStacks() instead.

GetDeploymentStacks(ResourceGroupResource)

Gets a collection of DeploymentStackResources in the ResourceGroupResource. MockingTo mock this method, please mock GetDeploymentStacks() instead.

GetDeploymentStacks(SubscriptionResource)

Gets a collection of DeploymentStackResources in the SubscriptionResource. MockingTo mock this method, please mock GetDeploymentStacks() instead.

GetJitRequest(ResourceGroupResource, String, CancellationToken)

Gets the JIT request.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
  • Operation Id: JitRequests_Get
  • Default Api Version: 2019-07-01
  • Resource: JitRequestResource
GetJitRequestAsync(ResourceGroupResource, String, CancellationToken)

Gets the JIT request.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Solutions/jitRequests/{jitRequestName}
  • Operation Id: JitRequests_Get
  • Default Api Version: 2019-07-01
  • Resource: JitRequestResource
GetJitRequestDefinitions(SubscriptionResource, CancellationToken)

Retrieves all JIT requests within the subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/jitRequests
  • Operation Id: jitRequests_ListBySubscription
  • Default Api Version: 2019-07-01
  • Resource: JitRequestResource
GetJitRequestDefinitionsAsync(SubscriptionResource, CancellationToken)

Retrieves all JIT requests within the subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Solutions/jitRequests
  • Operation Id: jitRequests_ListBySubscription
  • Default Api Version: 2019-07-01
  • Resource: JitRequestResource
GetJitRequestResource(ArmClient, ResourceIdentifier)

Gets an object representing a JitRequestResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a JitRequestResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetJitRequestResource(ResourceIdentifier) instead.

GetJitRequests(ResourceGroupResource)

Gets a collection of JitRequestResources in the ResourceGroupResource. MockingTo mock this method, please mock GetJitRequests() instead.

GetScriptLogResource(ArmClient, ResourceIdentifier)

Gets an object representing a ScriptLogResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a ScriptLogResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetScriptLogResource(ResourceIdentifier) instead.

GetTemplateSpec(ResourceGroupResource, String, Nullable<TemplateSpecExpandKind>, CancellationToken)

Gets a Template Spec with a given name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
  • Operation Id: TemplateSpecs_Get
  • Default Api Version: 2021-05-01
  • Resource: TemplateSpecResource
GetTemplateSpecAsync(ResourceGroupResource, String, Nullable<TemplateSpecExpandKind>, CancellationToken)

Gets a Template Spec with a given name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}
  • Operation Id: TemplateSpecs_Get
  • Default Api Version: 2021-05-01
  • Resource: TemplateSpecResource
GetTemplateSpecResource(ArmClient, ResourceIdentifier)

Gets an object representing a TemplateSpecResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String) to create a TemplateSpecResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetTemplateSpecResource(ResourceIdentifier) instead.

GetTemplateSpecs(ResourceGroupResource)

Gets a collection of TemplateSpecResources in the ResourceGroupResource. MockingTo mock this method, please mock GetTemplateSpecs() instead.

GetTemplateSpecs(SubscriptionResource, Nullable<TemplateSpecExpandKind>, CancellationToken)

Lists all the Template Specs within the specified subscriptions.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Resources/templateSpecs
  • Operation Id: TemplateSpecs_ListBySubscription
  • Default Api Version: 2021-05-01
  • Resource: TemplateSpecResource
GetTemplateSpecsAsync(SubscriptionResource, Nullable<TemplateSpecExpandKind>, CancellationToken)

Lists all the Template Specs within the specified subscriptions.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Resources/templateSpecs
  • Operation Id: TemplateSpecs_ListBySubscription
  • Default Api Version: 2021-05-01
  • Resource: TemplateSpecResource
GetTemplateSpecVersionResource(ArmClient, ResourceIdentifier)

Gets an object representing a TemplateSpecVersionResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(String, String, String, String) to create a TemplateSpecVersionResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetTemplateSpecVersionResource(ResourceIdentifier) instead.

GetTenantDataBoundaries(TenantResource)

Gets a collection of TenantDataBoundaryResources in the TenantResource. MockingTo mock this method, please mock GetTenantDataBoundaries() instead.

GetTenantDataBoundary(TenantResource, DataBoundaryName, CancellationToken)

Get data boundary of tenant.

  • Request Path: /providers/Microsoft.Resources/dataBoundaries/{default}
  • Operation Id: DataBoundaries_GetTenant
  • Default Api Version: 2024-08-01
  • Resource: TenantDataBoundaryResource
GetTenantDataBoundaryAsync(TenantResource, DataBoundaryName, CancellationToken)

Get data boundary of tenant.

  • Request Path: /providers/Microsoft.Resources/dataBoundaries/{default}
  • Operation Id: DataBoundaries_GetTenant
  • Default Api Version: 2024-08-01
  • Resource: TenantDataBoundaryResource
GetTenantDataBoundaryResource(ArmClient, ResourceIdentifier)

Gets an object representing a TenantDataBoundaryResource along with the instance operations that can be performed on it but with no data. You can use CreateResourceIdentifier(DataBoundaryName) to create a TenantDataBoundaryResourceResourceIdentifier from its components. MockingTo mock this method, please mock GetTenantDataBoundaryResource(ResourceIdentifier) instead.

Applies to