Skip to content

Connect-AppVentiXAzure

SYNOPSIS

Signs in to Azure with an Entra ID account.

SYNTAX

__AllParameterSets

Connect-AppVentiXAzure [[-ConfigShare] <string>] [-ForceLogin] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

The Connect-AppVentiXAzure function signs in with an interactive Entra ID device-code sign-in. The sign-in is used for: - an Azure Blob Configuration Store, the equivalent of 'Set-AppVentiXConfigShare -Credential' for an SMB store; - the Microsoft Graph lookup of Entra ID groups (-EntraIDGroup), also with an SMB store.

The resulting token is cached DPAPI-encrypted per user, so subsequent sessions pick it up silently and only need to sign in again once it can no longer be refreshed.

Reads and writes against an Azure Blob store only use the cached token and fail with a pointer back to this function when none is available. A command that uses an Entra ID group prompts for the sign-in itself when needed. Run this once per machine/user (or again with -ForceLogin to switch accounts).

This function was named Connect-AppVentiXAzureBlobStore, that name is still available as an alias.

EXAMPLES

EXAMPLE 1

Connect-AppVentiXAzure

Signs in to Azure, for the configured Configuration Store and Entra ID group lookups.

EXAMPLE 2

Connect-AppVentiXAzure -ConfigShare "azure://appventix/publishing"

Signs in to the Azure Blob Configuration Store "azure://appventix/publishing".

EXAMPLE 3

Connect-AppVentiXAzure -ForceLogin

Signs in again, for example with a different account.

PARAMETERS

-ConfigShare

Specifies the path to the Configuration Store. Only used to report what the sign-in is for. Defaults to the currently configured store.

Type: System.String
DefaultValue: $Script:AppVentiX.ConfigShare
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ForceLogin

Ignores any cached token and forces a fresh interactive sign-in.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Boolean