PowerShell Cmdlets to Breakdown Cloud Connections
    • Dark
      Light
    • PDF

    PowerShell Cmdlets to Breakdown Cloud Connections

    • Dark
      Light
    • PDF

    Article summary

    Some features available only in version 9.1 Beta
    This article describes some monitor features that are only available in ControlUp Real-Time DX version 9.1 beta.

    You can create multiple cloud connections for the same subscription. This enables you to assign specific resource groups to each connection to improve data collection granularity. Optimize performance by utilizing a data collector closer to your virtual endpoints.

    Version 9.1 includes the following PowerShell cmdlets to break down your cloud data connections to resource groups. You can then add multiple connections for the same subscription to your organizational tree, with no need to use the ControlUp Real-Time DX Console. You can configure each connection to collect data from specific resource groups, enabling you to assign a dedicated data collector and define specific sites for each connection.

    Azure Connections

    In version 9.1, the cloud connection breakdown feature is available for Azure connections only.

    In previous versions, cloud data collection queried the Azure API for subscriptions and to retrieve all resource groups, machines, and virtual disks. Now, you can improve data collection by using cmdlets to configure your ControlUp Monitors as data collectors for specific resource groups, based on parameters that you define. Sites are now assigned according to resource groups instead of subscriptions, providing you more granular control to assign monitors to specific resource groups.

    The ControlUp.PowerShell.User module contains the PowerShell cmdlets mentioned in this article.

    To break down your cloud data connections to resource groups with the Real-Time DX Console, see here.

    What's New?

    With these PowerShell cmdlets, you can:

    • Get a list of all the breakdown rules for a specific cloud connection
    • Update the breakdown rules of a specific cloud connection

    You configure cloud connections according to the following flow:

    1. Create cloud connection with a specified data collector.

    2. Configure cloud connection breakdown rules.

    Prerequisites

    • ControlUp Monitor version 9.1
    • The Manage All Cloud Connections permission must be granted in the console Security Policy.

    Get-CUCloudConnectionBreakdownRules

    Lists the configured breakdown rules of a specific connection. The list includes the details of the regions, resource groups, and any other breakdown rules that have been configured.

    Syntax

    Get-CUCloudConnectionBreakdownRules -ConnectionId <String>

    Example

    Get-CUCloudConnectionBreakdownRules -ConnectionId 71fa1a7c-cbb5-47e8-9775-ec49e9547c9c

    Parameters

    ParametersDescriptionRequired
    -ConnectionIdUnique ID for this cloud connection
    Yes

    Get-CUCloudConnectionBreakdownRules Results

    Returns a list of all configured breakdown rules of a specific connection, with the following properties:

    SelectedRegions: <String>
    ResourceGroupWildCard: <String> 
    IncludedRG: <String>
    ExcludedRG: <String>

    Update-CUCloudConnectionBreakdownRules

    Updates the breakdown rules of a specific connection, including selecting specific regions, applying a wildcard for resource group names, and specifying included or excluded resource groups. You must configure a wildcard pattern for resource groups in different regions, or you can manually select resource groups to add to the connection. First you select specific resource groups from an Azure subscription, and then you can assign a dedicated data collector from the site that you define that will only collect data from the included resource groups that you define.

    Syntax 

    Update-CUCloudConnectionBreakdownRules -ConnectionId <String> [-SelectedRegions <String[]>] [-ResourceGroupWildCard <String>] [-IncludedRG <String[]>] [-ExcludedRG <String[]>]

    Example

    Update-CUCloudConnectionBreakdownRules -ConnectionId 71fa1a7c-cbb5-47e8-9775-ec49e9547c9c -SelectedRegions "eastus" -ResourceGroupWildCard "rg-a*" -IncludedRG "cu-dev-ea (1)\eastus\rg-auto-streaming", "cu-dev-ea (1)\eastus\rg-avd-qa" -ExcludedRG "cu-dev-ea (1)\westeurope\aicontestresourcegroupeu", "cu-dev-ea (1)\westeurope\rg-security"

    Parameters

    ParametersDescriptionRequired
    -ConnectionIdUnique ID for this cloud connectionYes
    -SelectedRegionsSpecific regions assigned to the connectionNo
    -ResourceGroupWildCardWildcard pattern of the names of the resource groups assigned to the connectionNo
    -IncludedRGNames of the resource groups included in the connectionNo
    -ExcludedRGNames of the resource groups excluded from the connectionNo

    Update-CUCloudConnectionBreakdownRules Results

    Writes single result object to PowerShell with the following properties:

    • Error. In case of failure, the reason will be displayed.
    • Success. In case of success, all updated parameters will be displayed, for example:Update-CUCloudConnectionBreakdownRules

    Was this article helpful?