RubrikSecurityCloud

1.16.20260309

Toolkit/Public/Get-RscMssqlLinkedAvailabilityGroup.ps1

#Requires -Version 3
function Get-RscMssqlLinkedAvailabilityGroup {
    <#
    .SYNOPSIS
    Retrieves SQL Server linked availability groups managed by Rubrik Security Cloud.

    .DESCRIPTION
    Returns SQL Server Always On availability groups that are linked (virtual groups)
    in Rubrik. You can filter by name, SLA Domain, cluster, or organization.
    Use -AsQuery to return the query object without executing it.

    .LINK
    Schema reference:
    https://rubrikinc.github.io/rubrik-api-documentation/schema/reference

    .PARAMETER AsQuery
    Return the query object instead of running the query.
    Preliminary read-only queries may still run to gather IDs or
    other data needed to build the main query.

    .EXAMPLE
    # Get all linked availability groups
    Get-RscMssqlLinkedAvailabilityGroup

    .EXAMPLE
    # Get linked availability groups on a specific cluster
    Get-RscCluster -Name "cluster-east" | Get-RscMssqlLinkedAvailabilityGroup
    #>

    [CmdletBinding(
        DefaultParameterSetName = "Name"
    )]
    Param(
        [Parameter(
            Position = 0,
            Mandatory = $false,
            ParameterSetName = "Name"
        )]
        [String]$Name,
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Name"
        )]
        [switch]$Relic,
        [Parameter(
            Mandatory = $false,
            ParameterSetName = "Name"
        )]
        [switch]$Replica,
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $true,
            ParameterSetName = "Name"
        )]
        [RubrikSecurityCloud.Types.GlobalSlaReply]$Sla,
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $true,
            ParameterSetName = "Name"
        )]
        [RubrikSecurityCloud.Types.Cluster]$Cluster,
        [Parameter(
            Mandatory = $false,
            ValueFromPipeline = $true,
            ParameterSetName = "Name"
        )]
        [RubrikSecurityCloud.Types.Org]$Org,
        
        # Returns API query object
        [Parameter()]
        [switch]$AsQuery
    )
    
    Process {

        $query = New-RscQuery -Gql mssqlAvailabilityGroupVirtualGroups
        $query.var.filters = @()

        if ($Name) {
            $nameFilter = New-Object -TypeName RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterInput
            $nameFilter.Field = [RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterField]::NAME
            $nameFilter.texts = $Name
            $query.var.filters += $nameFilter
        }

        if ($Sla) {
            $slaFilter = New-Object -TypeName RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterInput
            $slaFilter.Field = [RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterField]::EFFECTIVE_SLA_WITH_RETENTION_SLA
            $slaFilter.Texts = $Sla.id
            $query.var.filters += $slaFilter
        }

        if ($Cluster) {
            $clusterFilter = New-Object -TypeName RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterInput
            $clusterFilter.Field = [RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterField]::CLUSTER_UUID
            $clusterFilter.Texts = $Cluster.id
            $query.var.filters += $clusterFilter
        }

        if ($Org) {
            $orgFilter = New-Object -TypeName RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterInput
            $orgFilter.Field = [RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterField]::ORG_ID
            $orgFilter.Texts = $Org.id
            $query.var.filters += $orgFilter
        }

        if ($PSBoundParameters.ContainsKey('relic')) {
            $relicFilter = New-Object -TypeName RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterInput
            $relicFilter.Field = [RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterField]::IS_RELIC
            $relicFilter.Texts = $Relic
            $query.var.filters += $relicFilter
        }

        if ($PSBoundParameters.ContainsKey('replica')) {
            $replicaFilter = New-Object -TypeName RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterInput
            $replicaFilter.Field = [RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroupFilterField]::IS_REPLICATED
            $replicaFilter.Texts = $replica
            $query.var.filters += $replicaFilter
        }

        $query.Field.nodes = @(
            # Doesn't work. Get-RscType: Cannot dynamically create an instance of type 'System.String'. Reason: Uninitialized Strings cannot be created.
            # Get-RscType -Name MssqlAvailabilityGroupVirtualGroup -InitialProperties name,linkedFids
            New-Object -TypeName RubrikSecurityCloud.Types.MssqlAvailabilityGroupVirtualGroup
        )
        $query.Field.nodes[0].Name = "FETCH"
        $query.Field.Nodes[0].LinkedFids = @(1)
        $query.Field.nodes[0].Groups = Get-RscType -Name MssqlAvailabilityGroup -InitialProperties name,id


        if ($AsQuery.IsPresent) {
            return $query
        }
        else {
            $result = Invoke-Rsc -Query $query
            $result.nodes
        }

    } 
}