Skip to content

Commit b70510b

Browse files
authored
Update enable-subscription-id-overriding.md with limitations (Azure#15796)
* Update enable-subscription-id-overriding.md * add limitation (multi user) * Update enable-subscription-id-overriding.md
1 parent 8831286 commit b70510b

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

documentation/development-docs/enable-subscription-id-overriding.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# How to: Enable Overriding Subscription ID in Your Module
22

33
- [Background](#background)
4+
- [Limitation](#limitation)
45
- [Steps](#steps)
56
- [Add `SupportsSubscriptionId` Attribute](#add-supportssubscriptionid-attribute)
67
- [Regenerate Help Documents](#regenerate-help-documents)
@@ -23,6 +24,14 @@ New-AzAksCluster ... -SubscriptionId "00000000-0000-0000-0000-000000000000"
2324

2425
The new design does not only simplify scripts, but also runs more efficiently, as it saves 1 cmdlet execution per subscription switching.
2526

27+
## Limitation
28+
29+
The feature was designed to balance between "supporting more login scenarios" and "being easy to use". Here are the limitations:
30+
31+
- **One subscription, multiple accounts**: when you login Azure PowerShell with multiple user accounts, and there is one subscription owned by more than one of them, it is obvious that `-SubscriptionId` is not enough to tell which context you wish to use, but we do not want to introduce more parameters, so this is not supported.
32+
- Work-around is to log in with only 1 user account.
33+
- **Management-plane only**: as subscription may not make as much sense in data-plane as in management-plane, this feature is suggested to be applied to management-plane cmdlets only.
34+
2635
## Steps
2736

2837
Here are the two simple steps to enable this for your module:

0 commit comments

Comments
 (0)