Skip to content

Commit 57c8173

Browse files
1 parent 9090791 commit 57c8173

8 files changed

+53
-28
lines changed

python/docs-ref-autogen/msal/msal.application.ClientApplication.yml

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -231,14 +231,15 @@ constructor:
231231
- name: azure_region
232232
description: "(optional)\nInstructs MSAL to use the Entra regional token service.\
233233
\ This legacy feature is only available to\nfirst-party applications. Only `acquire_token_for_client()`\
234-
\ is supported.\n\nSupports 3 values:\n\n `azure_region=None` - meaning no\
235-
\ region is used. This is the default value.\n `azure_region=\"some_region\"\
236-
` - meaning the specified region is used.\n `azure_region=True` - meaning\
237-
\ MSAL will try to auto-detect the region. This is not recommended.\n\n\n> [!NOTE]\n\
238-
> Region auto-discovery has been tested on VMs and on Azure Functions. It is\
239-
\ unreliable.\n>\n> Applications using this option should configure a short\
240-
\ timeout.\n>\n> \n>\n> For more details and for the values of the region string\n\
241-
>\n> \n>\n> see [https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting](https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting)\n\
234+
\ is supported.\n\nSupports 4 values:\n\n1. `azure_region=None` - This default\
235+
\ value means no region is configured. MSAL will use the region defined in env\
236+
\ var `MSAL_FORCE_REGION`. \n\n2. `azure_region=\"some_region\"` - meaning the\
237+
\ specified region is used. \n\n3. `azure_region=True` - meaning MSAL will try\
238+
\ to auto-detect the region. This is not recommended. \n\n4. `azure_region=False`\
239+
\ - meaning MSAL will use no region. \n\n\n> [!NOTE]\n> Region auto-discovery\
240+
\ has been tested on VMs and on Azure Functions. It is unreliable.\n>\n> Applications\
241+
\ using this option should configure a short timeout.\n>\n> \n>\n> For more\
242+
\ details and for the values of the region string\n>\n> \n>\n> see [https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting](https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting)\n\
242243
>\n\nNew in version 1.12.0."
243244
defaultValue: None
244245
types:
@@ -958,6 +959,9 @@ attributes:
958959
- uid: msal.application.ClientApplication.ATTEMPT_REGION_DISCOVERY
959960
name: ATTEMPT_REGION_DISCOVERY
960961
signature: ATTEMPT_REGION_DISCOVERY = True
962+
- uid: msal.application.ClientApplication.DISABLE_MSAL_FORCE_REGION
963+
name: DISABLE_MSAL_FORCE_REGION
964+
signature: DISABLE_MSAL_FORCE_REGION = False
961965
- uid: msal.application.ClientApplication.GET_ACCOUNTS_ID
962966
name: GET_ACCOUNTS_ID
963967
signature: GET_ACCOUNTS_ID = '902'

python/docs-ref-autogen/msal/msal.application.ConfidentialClientApplication.yml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -231,14 +231,15 @@ constructor:
231231
- name: azure_region
232232
description: "(optional)\nInstructs MSAL to use the Entra regional token service.\
233233
\ This legacy feature is only available to\nfirst-party applications. Only `acquire_token_for_client()`\
234-
\ is supported.\n\nSupports 3 values:\n\n `azure_region=None` - meaning no\
235-
\ region is used. This is the default value.\n `azure_region=\"some_region\"\
236-
` - meaning the specified region is used.\n `azure_region=True` - meaning\
237-
\ MSAL will try to auto-detect the region. This is not recommended.\n\n\n> [!NOTE]\n\
238-
> Region auto-discovery has been tested on VMs and on Azure Functions. It is\
239-
\ unreliable.\n>\n> Applications using this option should configure a short\
240-
\ timeout.\n>\n> \n>\n> For more details and for the values of the region string\n\
241-
>\n> \n>\n> see [https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting](https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting)\n\
234+
\ is supported.\n\nSupports 4 values:\n\n1. `azure_region=None` - This default\
235+
\ value means no region is configured. MSAL will use the region defined in env\
236+
\ var `MSAL_FORCE_REGION`. \n\n2. `azure_region=\"some_region\"` - meaning the\
237+
\ specified region is used. \n\n3. `azure_region=True` - meaning MSAL will try\
238+
\ to auto-detect the region. This is not recommended. \n\n4. `azure_region=False`\
239+
\ - meaning MSAL will use no region. \n\n\n> [!NOTE]\n> Region auto-discovery\
240+
\ has been tested on VMs and on Azure Functions. It is unreliable.\n>\n> Applications\
241+
\ using this option should configure a short timeout.\n>\n> \n>\n> For more\
242+
\ details and for the values of the region string\n>\n> \n>\n> see [https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting](https://learn.microsoft.com/entra/msal/dotnet/resources/region-discovery-troubleshooting)\n\
242243
>\n\nNew in version 1.12.0."
243244
defaultValue: None
244245
types:

python/docs-ref-autogen/msal/msal.application.PublicClientApplication.yml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ summary: "Same as <xref:ClientApplication.__init__>,\nexcept that `client_creden
4040
\ when broker is opted in, installed, initialized,\n>\n> but subsequent token request(s)\
4141
\ failed.\n>"
4242
constructor:
43-
syntax: PublicClientApplication(client_id, client_credential=None, **kwargs)
43+
syntax: PublicClientApplication(client_id, client_credential=None, *, enable_broker_on_windows=None,
44+
enable_broker_on_mac=None, **kwargs)
4445
parameters:
4546
- name: enable_broker_on_windows
4647
description: 'This setting is only effective if your app is running on Windows
@@ -67,6 +68,11 @@ constructor:
6768
isRequired: true
6869
- name: client_credential
6970
defaultValue: None
71+
keywordOnlyParameters:
72+
- name: enable_broker_on_windows
73+
isRequired: true
74+
- name: enable_broker_on_mac
75+
isRequired: true
7076
methods:
7177
- uid: msal.application.PublicClientApplication.acquire_token_by_device_flow
7278
name: acquire_token_by_device_flow

python/docs-ref-autogen/msal/msal.managed_identity.ManagedIdentityClient.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ summary: "This API encapsulates multiple managed identity back-ends:\nVM, App Se
2222
Recipe 2: Write once, run everywhere.\nIf you use different managed identity on\
2323
\ different deployment,\nyou may use an environment variable (such as MY_MANAGED_IDENTITY_CONFIG)\n\
2424
to store a json blob like\n`{\"ManagedIdentityIdType\": \"ClientId\", \"Id\": \"\
25-
foo\"}` or\n`{\"ManagedIdentityIdType\": \"SystemAssignedManagedIdentity\", \"Id\"\
26-
: null})`.\nThe following app can load managed identity configuration dynamically:\n\
27-
\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
28-
: [], \"backrefs\": [], \"xml:space\": \"preserve\", \"language\": \"default\",\
29-
\ \"force\": false, \"linenos\": false} -->\n\n````default\n\n import json, os,\
30-
\ msal, requests\n config = os.getenv(\"MY_MANAGED_IDENTITY_CONFIG\")\n assert\
31-
\ config, \"An ENV VAR with value should exist\"\n client = msal.ManagedIdentityClient(\n\
32-
\ json.loads(config),\n http_client=requests.Session(),\n )\n\
33-
\ token = client.acquire_token_for_client(\"resource\")\n ````"
25+
foo\"}` or\n`{\"ManagedIdentityIdType\": \"SystemAssigned\", \"Id\": null}`.\nThe\
26+
\ following app can load managed identity configuration dynamically:\n\n<!-- literal_block\
27+
\ {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\": [], \"backrefs\":\
28+
\ [], \"xml:space\": \"preserve\", \"language\": \"default\", \"force\": false,\
29+
\ \"linenos\": false} -->\n\n````default\n\n import json, os, msal, requests\n\
30+
\ config = os.getenv(\"MY_MANAGED_IDENTITY_CONFIG\")\n assert config, \"An ENV\
31+
\ VAR with value should exist\"\n client = msal.ManagedIdentityClient(\n \
32+
\ json.loads(config),\n http_client=requests.Session(),\n )\n token\
33+
\ = client.acquire_token_for_client(\"resource\")\n ````"
3434
constructor:
3535
syntax: 'ManagedIdentityClient(managed_identity: dict | ManagedIdentity | SystemAssignedManagedIdentity
3636
| UserAssignedManagedIdentity, *, http_client, token_cache=None, http_cache=None)'
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### YamlMime:PythonModule
2+
uid: msal.sku
3+
name: sku
4+
fullName: msal.sku
5+
summary: This module is from where we recieve the client sku name and version.

python/docs-ref-autogen/msal/msal.token_cache.TokenCache.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,17 @@ methods:
2626
- uid: msal.token_cache.TokenCache.find
2727
name: find
2828
summary: Equivalent to list(search(...)).
29-
signature: find(credential_type, target=None, query=None)
29+
signature: find(credential_type, target=None, query=None, *, now=None)
3030
parameters:
3131
- name: credential_type
3232
isRequired: true
3333
- name: target
3434
defaultValue: None
3535
- name: query
3636
defaultValue: None
37+
keywordOnlyParameters:
38+
- name: now
39+
isRequired: true
3740
- uid: msal.token_cache.TokenCache.modify
3841
name: modify
3942
signature: modify(credential_type, old_entry, new_key_value_pairs=None)
@@ -76,14 +79,17 @@ methods:
7679
It is O(1) for AT hits, and O(n) for other types.
7780
7881
Note that it holds a lock during the entire search.'
79-
signature: search(credential_type, target=None, query=None)
82+
signature: search(credential_type, target=None, query=None, *, now=None)
8083
parameters:
8184
- name: credential_type
8285
isRequired: true
8386
- name: target
8487
defaultValue: None
8588
- name: query
8689
defaultValue: None
90+
keywordOnlyParameters:
91+
- name: now
92+
isRequired: true
8793
- uid: msal.token_cache.TokenCache.update_rt
8894
name: update_rt
8995
signature: update_rt(rt_item, new_rt)

python/docs-ref-autogen/msal/msal.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ modules:
77
- msal.application
88
- msal.auth_scheme
99
- msal.managed_identity
10+
- msal.sku
1011
- msal.token_cache

python/docs-ref-autogen/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
- name: UserAssignedManagedIdentity
3434
uid: msal.managed_identity.UserAssignedManagedIdentity
3535
name: managed_identity
36+
- name: sku
37+
uid: msal.sku
3638
- items:
3739
- name: Overview
3840
uid: msal.token_cache

0 commit comments

Comments
 (0)