Skip to content

Add support for excluding new auth types from DefaultAzureCredential #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
japarson merged 3 commits into from
May 16, 2024
Merged

Add support for excluding new auth types from DefaultAzureCredential #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
90d79a7
Bump ps module and add new inputs
japarson May 16, 2024
0036900
Add docs about new exclude auth inputs
japarson May 16, 2024
fd51bae
Add new inputs to auth section advice
japarson May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,9 @@ azure-password: ${{ secrets.AZURE_PASSWORD }}
# Exclude the "EnvironmentCredential" type from being considered when authenticating with "DefaultAzureCredential". The default value is false.
exclude-environment-credential: false

# Exclude the "WorkloadIdentity" type from being considered when authenticating with "DefaultAzureCredential". The default value is false.
exclude-workload-identity-credential: false

# Exclude the "ManagedIdentity" type from being considered when authenticating with "DefaultAzureCredential". The default value is false.
exclude-managed-identity-credential: false

Expand All @@ -108,6 +111,9 @@ exclude-azure-cli-credential: false
# Exclude the "AzurePowerShellCredential" type from being considered when authenticating with "DefaultAzureCredential". The default value is false.
exclude-azure-powershell-credential: false

# Exclude the "AzureDeveloperCliCredential" type from being considered when authenticating with "DefaultAzureCredential". The default value is false.
exclude-azure-developer-cli-credential: false

# Exclude the "InteractiveBrowserCredential" type from being considered when authenticating with "DefaultAzureCredential". The default value is true.
exclude-interactive-browser-credential: true
```
Expand Down Expand Up @@ -256,12 +262,14 @@ Each authentication method can be [disabled individually](https://github.com/Azu
For example, when authenticating with [EnvironmentCredential](https://learn.microsoft.com/dotnet/api/azure.identity.environmentcredential?view=azure-dotnet) specifically, disable the other credentials with the following inputs:
```yaml
exclude-environment-credential: false
exclude-workload-identity-credential: true
exclude-managed-identity-credential: true
exclude-shared-token-cache-credential: true
exclude-visual-studio-credential: true
exclude-visual-studio-code-credential: true
exclude-azure-cli-credential: true
exclude-azure-powershell-credential: true
exclude-azure-developer-cli-credential: true
exclude-interactive-browser-credential: true
```

Expand Down
18 changes: 17 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,9 @@ inputs:
exclude-environment-credential:
description: Exclude the "EnvironmentCredential" type from being considered when authenticating with "DefaultAzureCredential".
required: false
exclude-workload-identity-credential:
description: Exclude the "WorkloadIdentityCredential" type from being considered when authenticating with "DefaultAzureCredential".
required: false
exclude-managed-identity-credential:
description: Exclude the "ManagedIdentity" type from being considered when authenticating with "DefaultAzureCredential".
required: false
Expand All @@ -151,6 +154,9 @@ inputs:
exclude-azure-powershell-credential:
description: Exclude the "AzurePowerShellCredential" type from being considered when authenticating with "DefaultAzureCredential".
required: false
exclude-azure-developer-cli-credential:
description: Exclude the "AzureDeveloperCliCredential" type from being considered when authenticating with "DefaultAzureCredential".
required: false
exclude-interactive-browser-credential:
description: Exclude the "InteractiveBrowserCredential" type from being considered when authenticating with "DefaultAzureCredential".
required: false
Expand Down Expand Up @@ -180,7 +186,7 @@ runs:
AZURE_USERNAME: ${{ inputs.azure-username }}
AZURE_PASSWORD: ${{ inputs.azure-password }}
run: |
Install-Module -Name TrustedSigning -RequiredVersion 0.3.15 -Force -Repository PSGallery
Install-Module -Name TrustedSigning -RequiredVersion 0.3.18 -Force -Repository PSGallery

$params = @{}

Expand Down Expand Up @@ -315,6 +321,11 @@ runs:
$params["ExcludeEnvironmentCredential"] = [System.Convert]::ToBoolean($excludeEnvironmentCredential)
}

$excludeWorkloadIdentityCredential = "${{ inputs.exclude-workload-identity-credential }}"
if (-Not [string]::IsNullOrWhiteSpace($excludeWorkloadIdentityCredential)) {
$params["ExcludeWorkloadIdentityCredential"] = [System.Convert]::ToBoolean($excludeWorkloadIdentityCredential)
}

$excludeManagedIdentityCredential = "${{ inputs.exclude-managed-identity-credential }}"
if (-Not [string]::IsNullOrWhiteSpace($excludeManagedIdentityCredential)) {
$params["ExcludeManagedIdentityCredential"] = [System.Convert]::ToBoolean($excludeManagedIdentityCredential)
Expand Down Expand Up @@ -345,6 +356,11 @@ runs:
$params["ExcludeAzurePowerShellCredential"] = [System.Convert]::ToBoolean($excludeAzurePowerShellCredential)
}

$excludeAzureDeveloperCliCredential = "${{ inputs.exclude-azure-developer-cli-credential }}"
if (-Not [string]::IsNullOrWhiteSpace($excludeAzureDeveloperCliCredential)) {
$params["ExcludeAzureDeveloperCliCredential"] = [System.Convert]::ToBoolean($excludeAzureDeveloperCliCredential)
}

$excludeInteractiveBrowserCredential = "${{ inputs.exclude-interactive-browser-credential }}"
if (-Not [string]::IsNullOrWhiteSpace($excludeInteractiveBrowserCredential)) {
$params["ExcludeInteractiveBrowserCredential"] = [System.Convert]::ToBoolean($excludeInteractiveBrowserCredential)
Expand Down