Skip to content

Commit 763c173

Browse files
authored
Fix AccessTokenInfo links on credential API ref pages (#39983)
1 parent 272d558 commit 763c173

24 files changed

+24
-24
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
104104
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
105105
:paramtype options: ~azure.core.credentials.TokenRequestOptions
106106
107-
:rtype: AccessTokenInfo
107+
:rtype: ~azure.core.credentials.AccessTokenInfo
108108
:return: An AccessTokenInfo instance containing information about the token.
109109
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The exception has a
110110
`message` attribute listing each authentication attempt and its error message.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
105105
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
106106
:paramtype options: ~azure.core.credentials.TokenRequestOptions
107107
108-
:rtype: AccessTokenInfo
108+
:rtype: ~azure.core.credentials.AccessTokenInfo
109109
:return: An AccessTokenInfo instance containing information about the token.
110110
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The error's ``message``
111111
attribute gives a reason. Any error response from Microsoft Entra ID is available as the error's

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
142142
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
143143
:paramtype options: ~azure.core.credentials.TokenRequestOptions
144144
145-
:rtype: AccessTokenInfo
145+
:rtype: ~azure.core.credentials.AccessTokenInfo
146146
:return: An AccessTokenInfo instance containing information about the token.
147147
148148
:raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
133133
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
134134
:paramtype options: ~azure.core.credentials.TokenRequestOptions
135135
136-
:rtype: AccessTokenInfo
136+
:rtype: ~azure.core.credentials.AccessTokenInfo
137137
:return: An AccessTokenInfo instance containing information about the token.
138138
139139
:raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke the Azure CLI.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
141141
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
142142
:paramtype options: ~azure.core.credentials.TokenRequestOptions
143143
144-
:rtype: AccessTokenInfo
144+
:rtype: ~azure.core.credentials.AccessTokenInfo
145145
:return: An AccessTokenInfo instance containing information about the token.
146146
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The error's ``message``
147147
attribute gives a reason.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
146146
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
147147
:paramtype options: ~azure.core.credentials.TokenRequestOptions
148148
149-
:rtype: AccessTokenInfo
149+
:rtype: ~azure.core.credentials.AccessTokenInfo
150150
:return: An AccessTokenInfo instance containing information about the token.
151151
152152
:raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke Azure PowerShell, or

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
166166
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
167167
:paramtype options: ~azure.core.credentials.TokenRequestOptions
168168
169-
:rtype: AccessTokenInfo
169+
:rtype: ~azure.core.credentials.AccessTokenInfo
170170
:return: An AccessTokenInfo instance containing information about the token.
171171
172172
:raises ~azure.core.exceptions.ClientAuthenticationError: no credential in the chain provided a token.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
239239
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
240240
:paramtype options: ~azure.core.credentials.TokenRequestOptions
241241
242-
:rtype: AccessTokenInfo
242+
:rtype: ~azure.core.credentials.AccessTokenInfo
243243
:return: An AccessTokenInfo instance containing information about the token.
244244
245245
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The exception has a

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
171171
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
172172
:paramtype options: ~azure.core.credentials.TokenRequestOptions
173173
174-
:rtype: AccessTokenInfo
174+
:rtype: ~azure.core.credentials.AccessTokenInfo
175175
:return: An AccessTokenInfo instance containing information about the token.
176176
177177
:raises ~azure.identity.CredentialUnavailableError: environment variable configuration is incomplete.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
171171
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
172172
:paramtype options: ~azure.core.credentials.TokenRequestOptions
173173
174-
:rtype: AccessTokenInfo
174+
:rtype: ~azure.core.credentials.AccessTokenInfo
175175
:return: An AccessTokenInfo instance containing information about the token.
176176
:raises ~azure.identity.CredentialUnavailableError: managed identity isn't available in the hosting environment.
177177
"""

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
100100
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
101101
:paramtype options: ~azure.core.credentials.TokenRequestOptions
102102
103-
:rtype: AccessTokenInfo
103+
:rtype: ~azure.core.credentials.AccessTokenInfo
104104
:return: An AccessTokenInfo instance containing information about the token.
105105
:raises ~azure.identity.CredentialUnavailableError: the cache is unavailable or contains insufficient user
106106
information.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
183183
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
184184
:paramtype options: ~azure.core.credentials.TokenRequestOptions
185185
186-
:rtype: AccessTokenInfo
186+
:rtype: ~azure.core.credentials.AccessTokenInfo
187187
:return: An AccessTokenInfo instance containing information about the token.
188188
:raises ~azure.identity.CredentialUnavailableError: the credential cannot retrieve user details from Visual
189189
Studio Code.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
104104
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
105105
:paramtype options: ~azure.core.credentials.TokenRequestOptions
106106
107-
:rtype: AccessTokenInfo
107+
:rtype: ~azure.core.credentials.AccessTokenInfo
108108
:return: An AccessTokenInfo instance containing information about the token.
109109
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The exception has a
110110
`message` attribute listing each authentication attempt and its error message.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
111111
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
112112
:paramtype options: ~azure.core.credentials.TokenRequestOptions
113113
114-
:rtype: AccessTokenInfo
114+
:rtype: ~azure.core.credentials.AccessTokenInfo
115115
:return: An AccessTokenInfo instance containing information about the token.
116116
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The error's ``message``
117117
attribute gives a reason. Any error response from Microsoft Entra ID is available as the error's

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
132132
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
133133
:paramtype options: ~azure.core.credentials.TokenRequestOptions
134134
135-
:rtype: AccessTokenInfo
135+
:rtype: ~azure.core.credentials.AccessTokenInfo
136136
:return: An AccessTokenInfo instance containing information about the token.
137137
138138
:raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
127127
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
128128
:paramtype options: ~azure.core.credentials.TokenRequestOptions
129129
130-
:rtype: AccessTokenInfo
130+
:rtype: ~azure.core.credentials.AccessTokenInfo
131131
:return: An AccessTokenInfo instance containing information about the token.
132132
133133
:raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke the Azure CLI.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
114114
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
115115
:paramtype options: ~azure.core.credentials.TokenRequestOptions
116116
117-
:rtype: AccessTokenInfo
117+
:rtype: ~azure.core.credentials.AccessTokenInfo
118118
:return: An AccessTokenInfo instance containing information about the token.
119119
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The error's ``message``
120120
attribute gives a reason.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
104104
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
105105
:paramtype options: ~azure.core.credentials.TokenRequestOptions
106106
107-
:rtype: AccessTokenInfo
107+
:rtype: ~azure.core.credentials.AccessTokenInfo
108108
:return: An AccessTokenInfo instance containing information about the token.
109109
110110
:raises ~azure.identity.CredentialUnavailableError: the credential was unable to invoke Azure PowerShell, or

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
139139
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
140140
:paramtype options: ~azure.core.credentials.TokenRequestOptions
141141
142-
:rtype: AccessTokenInfo
142+
:rtype: ~azure.core.credentials.AccessTokenInfo
143143
:return: An AccessTokenInfo instance containing information about the token.
144144
145145
:raises ~azure.core.exceptions.ClientAuthenticationError: no credential in the chain provided a token.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
221221
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
222222
:paramtype options: ~azure.core.credentials.TokenRequestOptions
223223
224-
:rtype: AccessTokenInfo
224+
:rtype: ~azure.core.credentials.AccessTokenInfo
225225
:return: An AccessTokenInfo instance containing information about the token.
226226
227227
:raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The exception has a

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
138138
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
139139
:paramtype options: ~azure.core.credentials.TokenRequestOptions
140140
141-
:rtype: AccessTokenInfo
141+
:rtype: ~azure.core.credentials.AccessTokenInfo
142142
:return: An AccessTokenInfo instance containing information about the token.
143143
144144
:raises ~azure.identity.CredentialUnavailableError: environment variable configuration is incomplete.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
156156
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
157157
:paramtype options: ~azure.core.credentials.TokenRequestOptions
158158
159-
:rtype: AccessTokenInfo
159+
:rtype: ~azure.core.credentials.AccessTokenInfo
160160
:return: An AccessTokenInfo instance containing information about the token.
161161
:raises ~azure.identity.CredentialUnavailableError: managed identity isn't available in the hosting environment.
162162
"""

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
9797
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
9898
:paramtype options: ~azure.core.credentials.TokenRequestOptions
9999
100-
:rtype: AccessTokenInfo
100+
:rtype: ~azure.core.credentials.AccessTokenInfo
101101
:return: An AccessTokenInfo instance containing information about the token.
102102
:raises ~azure.identity.CredentialUnavailableError: the cache is unavailable or contains insufficient user
103103
information

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
9494
:keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
9595
:paramtype options: ~azure.core.credentials.TokenRequestOptions
9696
97-
:rtype: AccessTokenInfo
97+
:rtype: ~azure.core.credentials.AccessTokenInfo
9898
:return: An AccessTokenInfo instance containing information about the token.
9999
:raises ~azure.identity.CredentialUnavailableError: the credential cannot retrieve user details from Visual
100100
Studio Code.

0 commit comments

Comments
 (0)