Skip to content

Commit 466c648

Browse files
Bernd VerstCopilot
andcommitted
Clarify Azure Managed credential ownership and authority configuration
Document caller-created credentials, anonymous authentication, and the sandbox managed identity exception. No authority-host SDK option is needed. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent eee0f41 commit 466c648

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

‎docs/getting-started.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,29 @@ request. For example, both `https://durabletask.azure.us/` and
5757
`https://durabletask.azure.us/.default`. Nonempty inputs that become empty after
5858
normalization, such as whitespace, `///`, or `/.default`, raise `ValueError`.
5959

60+
### Credential Ownership and Authority Host
61+
62+
`DurableTaskSchedulerClient`, `AsyncDurableTaskSchedulerClient`,
63+
`SandboxActivitiesClient`, and `DurableTaskSchedulerWorker` require a
64+
`token_credential` argument. They use the caller-created credential directly;
65+
they do not construct `DefaultAzureCredential` or another credential on the
66+
caller's behalf. Passing `None` disables SDK token authentication rather than
67+
creating a default credential. A caller-supplied channel remains responsible
68+
for its own authentication.
69+
70+
Credentials may come from Azure Identity or implement the Azure Core
71+
`TokenCredential` / `AsyncTokenCredential` protocol themselves. Token requests
72+
use `get_token(scope)`; the protocol has no supported per-request authority
73+
override. Configure `authority` when creating a compatible Azure Identity
74+
credential, as in the example above. Omitting it preserves the credential's
75+
default behavior, including `AZURE_AUTHORITY_HOST` where applicable.
76+
77+
The preview `SandboxWorker` is the only Azure Managed runtime path that creates
78+
an Azure Identity credential internally. It creates `ManagedIdentityCredential`
79+
using the injected `DTS_UMI_CLIENT_ID`. Managed identities use their hosting
80+
environment's identity endpoint and ignore the authority setting, so this path
81+
does not require an authority-host option either.
82+
6083
> [!NOTE]
6184
> The resource audience, service endpoint, and credential authority/cloud are
6285
> separate settings. Neither `resource_id` nor `REGION_NAME` changes the endpoint

0 commit comments

Comments
 (0)