Skip to content

Commit ab4c52c

Browse files
authored
add doc string for authority setting (Azure#23659)
* add doc string for authority setting * updates
1 parent 321ac4c commit ab4c52c

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

sdk/identity/azure-identity/azure/identity/_credentials/environment.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,18 @@ class EnvironmentCredential(object):
3838
- **AZURE_TENANT_ID**: ID of the service principal's tenant. Also called its 'directory' ID.
3939
- **AZURE_CLIENT_ID**: the service principal's client ID
4040
- **AZURE_CLIENT_SECRET**: one of the service principal's client secrets
41+
- **AZURE_AUTHORITY_HOST**: authority of an Azure Active Directory endpoint, for example
42+
"login.microsoftonline.com", the authority for Azure Public Cloud, which is the default
43+
when no value is given.
4144
4245
Service principal with certificate:
4346
- **AZURE_TENANT_ID**: ID of the service principal's tenant. Also called its 'directory' ID.
4447
- **AZURE_CLIENT_ID**: the service principal's client ID
4548
- **AZURE_CLIENT_CERTIFICATE_PATH**: path to a PEM or PKCS12 certificate file including the private key. The
4649
certificate must not be password-protected.
50+
- **AZURE_AUTHORITY_HOST**: authority of an Azure Active Directory endpoint, for example
51+
"login.microsoftonline.com", the authority for Azure Public Cloud, which is the default
52+
when no value is given.
4753
4854
User with username and password:
4955
- **AZURE_CLIENT_ID**: the application's client ID
@@ -52,6 +58,9 @@ class EnvironmentCredential(object):
5258
- **AZURE_TENANT_ID**: (optional) ID of the service principal's tenant. Also called its 'directory' ID.
5359
If not provided, defaults to the 'organizations' tenant, which supports only Azure Active Directory work or
5460
school accounts.
61+
- **AZURE_AUTHORITY_HOST**: authority of an Azure Active Directory endpoint, for example
62+
"login.microsoftonline.com", the authority for Azure Public Cloud, which is the default
63+
when no value is given.
5564
"""
5665

5766
def __init__(self, **kwargs):

sdk/identity/azure-identity/azure/identity/aio/_credentials/environment.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,18 @@ class EnvironmentCredential(AsyncContextManager):
3131
- **AZURE_TENANT_ID**: ID of the service principal's tenant. Also called its 'directory' ID.
3232
- **AZURE_CLIENT_ID**: the service principal's client ID
3333
- **AZURE_CLIENT_SECRET**: one of the service principal's client secrets
34+
- **AZURE_AUTHORITY_HOST**: authority of an Azure Active Directory endpoint, for example
35+
"login.microsoftonline.com", the authority for Azure Public Cloud, which is the default
36+
when no value is given.
3437
3538
Service principal with certificate:
3639
- **AZURE_TENANT_ID**: ID of the service principal's tenant. Also called its 'directory' ID.
3740
- **AZURE_CLIENT_ID**: the service principal's client ID
3841
- **AZURE_CLIENT_CERTIFICATE_PATH**: path to a PEM or PKCS12 certificate file including the private key. The
3942
certificate must not be password-protected.
43+
- **AZURE_AUTHORITY_HOST**: authority of an Azure Active Directory endpoint, for example
44+
"login.microsoftonline.com", the authority for Azure Public Cloud, which is the default
45+
when no value is given.
4046
"""
4147

4248
def __init__(self, **kwargs: "Any") -> None:

0 commit comments

Comments
 (0)