Public/Get-DuneResourceProvider.ps1
|
<# .SYNOPSIS Retrieve resource providers. .DESCRIPTION Gets resource providers. Supports filtering by name, id, resource provider id, display name, default environment, allowed environments, type, and flags to include deleted objects. Returns `DuneResourceProvider` objects by default; use `-Raw` for raw API output. .PARAMETER Name Filter resource providers by name (supports wildcards). Position 0 in the default parameter set. .PARAMETER Id The GUID of a resource provider. Use the `Id` parameter set to retrieve a single provider. .PARAMETER ResourceProviderId Alternate id parameter accepted from pipeline by property name. .PARAMETER DisplayName Filter by display name (supports wildcards). .PARAMETER DefaultEnvironment Filter by the default environment (value from `Environments` enum). .PARAMETER AllowedEnvironments Filter providers by allowed environments list. .PARAMETER Type Filter providers by type (supports wildcards). .PARAMETER Raw If set, returns raw API objects instead of `DuneResourceProvider` objects. .PARAMETER IncludeDeleted Include deleted providers in results. .EXAMPLE PS> Get-DuneResourceProvider -Name "azure" Returns resource providers with names matching `azure`. .EXAMPLE PS> Get-DuneResourceProvider -Id 3d8f6b5a-... Returns the provider with the specified `Id`. .EXAMPLE PS> Get-DuneResourceProvider -DefaultEnvironment Prod Filter providers whose default environment is `Prod`. #> function Get-DuneResourceProvider { [CmdletBinding(DefaultParameterSetName = "Default")] param ( [Parameter(Position = 0)] [string]$Name, [Parameter(ParameterSetName = "Id")] [guid]$Id, [Parameter(ParameterSetName = "ResourceProviderId", ValueFromPipelineByPropertyName)] [guid]$ResourceProviderId, [Parameter()] [string]$DisplayName, [Parameter()] [Environments]$DefaultEnvironment, [Parameter()] [Environments[]]$AllowedEnvironments, [Parameter()] [string]$Type, [Parameter()] [switch]$Raw, [Parameter()] [switch]$IncludeDeleted ) begin { Write-Debug "$($MyInvocation.MyCommand)|begin" $ReturnObjects = @() $ProcessedUrls = @() $BaseUri = "resourceproviders" $Method = "GET" } process { Write-Debug "$($MyInvocation.MyCommand)|process|$($PSCmdlet.ParameterSetName)" # Build Uri $Uri = switch ($PSCmdlet.ParameterSetName) { 'Id' { $BaseUri, $Id -join '/' } 'ResourceProviderId' { $BaseUri, $ResourceProviderId -join '/' } Default { $BaseUri } } if ($Name) { $Uri = $Uri | Add-UriQueryParam "NameILike=$Name" -ConvertWildcards } if ($DisplayName) { $Uri = $Uri | Add-UriQueryParam "DisplayNameILike=$DisplayName" -ConvertWildcards } if ($Type) { $Uri = $Uri | Add-UriQueryParam "TypeILike=$Type" -ConvertWildcards } if ($PSBoundParameters.ContainsKey('DefaultEnvironment')) { $Uri = $Uri | Add-UriQueryParam "DefaultEnvironment=$($DefaultEnvironment.ToString)" -ConvertWildcards } if ($IncludeDeleted) { $Uri = $Uri | Add-UriQueryParam "IncludeDeleted=1" } # ApiCall Cache if ($ProcessedUrls -notcontains $Uri) { try { # ApiCall and Object conversion $Response = Invoke-DuneApiRequest -Uri $Uri -Method $Method $ProcessedUrls += $Uri $Results = if ($Response.Content) { $Response.Content | ConvertFrom-Json } if ($PSCmdlet.ParameterSetName -notin 'Id', 'ResourceProviderId') { $Results = $Results.Items } # list endpoint returns content in items property $ReturnObjects += $Results | ForEach-Object { if ($Raw) { $_ } else { ConvertTo-DuneClassObject -Class DuneResourceProvider -InputObject $_ } } } catch { throw $_ } } else { Write-Debug "$($MyInvocation.MyCommand)|process|ApiCall Cache hit: DuneApiRequest for $Uri already invoked" } } end { Write-Debug "$($MyInvocation.MyCommand)|end" # Filters if ($PSBoundParameters.ContainsKey('AllowedEnvironments')) { Write-Debug "$($MyInvocation.MyCommand)|process|filter AllowedEnvironments: $AllowedEnvironments" $ReturnObjects = Foreach ($Environment in $AllowedEnvironments) { $ReturnObjects | Where-Object AllowedEnvironments -Contains $Environment } } return $ReturnObjects | Sort-Object -Unique Id | Sort-Object Name } } |