Skip to content

Commit

Permalink
Update documentation for setting audience when environment is set (#455)
Browse files Browse the repository at this point in the history
* Add details about setting "audience" parameter when "environment" is not public cloud

* Remove extra added space
  • Loading branch information
jcantosz authored Jun 4, 2024
1 parent 5b1f5e2 commit 151fd00
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Azure Login Action supports different ways of authentication with Azure.
|tenant-id|false|UUID||the login tenant id|
|creds|false|string||a json string for login with an Azure service principal|
|enable-AzPSSession|false|boolean|false|if Azure PowerShell login is enabled|
|environment|false|string|azurecloud|the Azure Cloud environment|
|environment|false|string|azurecloud|the Azure Cloud environment. For cloud environments other than the public cloud, the `audience` will also need to be updated.|
|allow-no-subscriptions|false|boolean|false|if login without subscription is allowed|
|audience|false|string|api://AzureADTokenExchange|the audience to get the JWT ID token from GitHub OIDC provider|
|auth-type|false|string|SERVICE_PRINCIPAL|the auth type|
Expand Down Expand Up @@ -126,6 +126,8 @@ By default, Azure Login Action connects to the Azure Public Cloud (`AzureCloud`)

To login to one of the Azure Government clouds or Azure Stack, set `environment` to one of the supported values `AzureUSGovernment` or `AzureChinaCloud` or `AzureGermanCloud` or `AzureStack`.

The default [`audience`](#audience) for each of these clouds is different and will also need to be set if using anything other than the public environment.

Refer to [Login to Azure US Government cloud](#login-to-azure-us-government-cloud) for its usage.

### `allow-no-subscriptions`
Expand Down

0 comments on commit 151fd00

Please sign in to comment.