Modules/BenchPress.Azure/Private/Disconnect-Account.ps1

# INLINE_SKIP
Import-Module Az
# end INLINE_SKIP

function Disconnect-Account {
  <#
    .SYNOPSIS
      Disconnect-Account uses environment variable values to disconnect from a specific Azure context. This is an internal function and should not be used outside of the BenchPress module.

    .DESCRIPTION
      Disconnect-Account is designed to automatically log out of the specific Azure context using environment variables to identify the context to disconnect.

      The expected environment variables are:

      AZ_APPLICATION_ID - The Service Principal ID
      AZ_TENANT_ID - The Tenant ID to login to
      AZ_SUBSCRIPTION_ID - The Subscription ID to login to

      If the current context does not match the Service Principal, Tenant, or Subscription then this function is a no-op.

    .EXAMPLE
      There is only one way to call Disconnect-Account:

      Disconnect-Account

    .INPUTS
      None

    .OUTPUTS
      None
  #>
  [OutputType([System.Void])]
  [CmdletBinding()]
  param ( )
  Begin {
    $applicationId = Get-EnvironmentVariable AZ_APPLICATION_ID
    $tenantId = Get-EnvironmentVariable AZ_TENANT_ID

    # If the current context doesn't match the target subscription, tentant, and client, then the testing account is not logged in. Do nothing.
    $currentConnection = Get-AzContext
  }
  Process {
    if ($null -eq $currentConnection `
        -or ($currentConnection).Account.Type -ne "ServicePrincipal" `
        -or ($currentConnection).Account.Id -ne $applicationId `
        -or ($currentConnection).Tenant.Id -ne $tenantId) {
      return
    }

    $currentConnection | Disconnect-AzAccount -Scope CurrentUser
  }
  End { }
}