106 строки
12 KiB
YAML
106 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.identity.VisualStudioCodeCredentialBuilder"
|
|
fullName: "com.azure.identity.VisualStudioCodeCredentialBuilder"
|
|
name: "VisualStudioCodeCredentialBuilder"
|
|
nameWithType: "VisualStudioCodeCredentialBuilder"
|
|
summary: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.VisualStudioCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VisualStudioCodeCredential\"></xref>."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.identity.CredentialBuilderBase?alt=com.azure.identity.CredentialBuilderBase&text=CredentialBuilderBase\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)?alt=com.azure.identity.CredentialBuilderBase.addPolicy&text=addPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.clientOptions(com.azure.core.util.ClientOptions)?alt=com.azure.identity.CredentialBuilderBase.clientOptions&text=clientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.configuration(com.azure.core.util.Configuration)?alt=com.azure.identity.CredentialBuilderBase.configuration&text=configuration\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.enableAccountIdentifierLogging()?alt=com.azure.identity.CredentialBuilderBase.enableAccountIdentifierLogging&text=enableAccountIdentifierLogging\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpClient(com.azure.core.http.HttpClient)?alt=com.azure.identity.CredentialBuilderBase.httpClient&text=httpClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)?alt=com.azure.identity.CredentialBuilderBase.httpLogOptions&text=httpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.httpPipeline(com.azure.core.http.HttpPipeline)?alt=com.azure.identity.CredentialBuilderBase.httpPipeline&text=httpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.maxRetry(int)?alt=com.azure.identity.CredentialBuilderBase.maxRetry&text=maxRetry\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.pipeline(com.azure.core.http.HttpPipeline)?alt=com.azure.identity.CredentialBuilderBase.pipeline&text=pipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.proxyOptions(com.azure.core.http.ProxyOptions)?alt=com.azure.identity.CredentialBuilderBase.proxyOptions&text=proxyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryOptions(com.azure.core.http.policy.RetryOptions)?alt=com.azure.identity.CredentialBuilderBase.retryOptions&text=retryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryPolicy(com.azure.core.http.policy.RetryPolicy)?alt=com.azure.identity.CredentialBuilderBase.retryPolicy&text=retryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.CredentialBuilderBase.retryTimeout(java.util.function.Function<java.time.Duration,java.time.Duration>)?alt=com.azure.identity.CredentialBuilderBase.retryTimeout&text=retryTimeout\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **VisualStudioCodeCredentialBuilder**</br> extends <xref href=\"com.azure.identity.CredentialBuilderBase?alt=com.azure.identity.CredentialBuilderBase&text=CredentialBuilderBase\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.identity.VisualStudioCodeCredentialBuilder?alt=com.azure.identity.VisualStudioCodeCredentialBuilder&text=VisualStudioCodeCredentialBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.identity.VisualStudioCodeCredentialBuilder.VisualStudioCodeCredentialBuilder()"
|
|
fullName: "com.azure.identity.VisualStudioCodeCredentialBuilder.VisualStudioCodeCredentialBuilder()"
|
|
name: "VisualStudioCodeCredentialBuilder()"
|
|
nameWithType: "VisualStudioCodeCredentialBuilder.VisualStudioCodeCredentialBuilder()"
|
|
summary: "Constructs an instance of Visual<wbr>Studio<wbr>Code<wbr>Credential<wbr>Builder."
|
|
syntax: "public VisualStudioCodeCredentialBuilder()"
|
|
desc: "Constructs an instance of VisualStudioCodeCredentialBuilder."
|
|
methods:
|
|
- uid: "com.azure.identity.VisualStudioCodeCredentialBuilder.additionallyAllowedTenants(java.lang.String...)"
|
|
fullName: "com.azure.identity.VisualStudioCodeCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)"
|
|
name: "additionallyAllowedTenants(String[] additionallyAllowedTenants)"
|
|
nameWithType: "VisualStudioCodeCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)"
|
|
summary: "Specifies tenants in addition to the specified tenant<wbr>Id for which the credential may acquire tokens."
|
|
parameters:
|
|
- description: "the additionally allowed tenants."
|
|
name: "additionallyAllowedTenants"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]"
|
|
syntax: "public VisualStudioCodeCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)"
|
|
desc: "Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens. Add the wildcard value \"\\*\" to allow the credential to acquire tokens for any tenant the logged in account can access. If no value is specified for tenantId this option will have no effect, and the credential will acquire tokens for any requested tenant."
|
|
returns:
|
|
description: "An updated instance of this builder with the additional tenants configured."
|
|
type: "<xref href=\"com.azure.identity.VisualStudioCodeCredentialBuilder?alt=com.azure.identity.VisualStudioCodeCredentialBuilder&text=VisualStudioCodeCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.identity.VisualStudioCodeCredentialBuilder.additionallyAllowedTenants(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.identity.VisualStudioCodeCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)"
|
|
name: "additionallyAllowedTenants(List<String> additionallyAllowedTenants)"
|
|
nameWithType: "VisualStudioCodeCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)"
|
|
summary: "Specifies tenants in addition to the specified tenant<wbr>Id for which the credential may acquire tokens."
|
|
parameters:
|
|
- description: "the additionally allowed tenants."
|
|
name: "additionallyAllowedTenants"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public VisualStudioCodeCredentialBuilder additionallyAllowedTenants(List<String> additionallyAllowedTenants)"
|
|
desc: "Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens. Add the wildcard value \"\\*\" to allow the credential to acquire tokens for any tenant the logged in account can access. If no value is specified for tenantId this option will have no effect, and the credential will acquire tokens for any requested tenant."
|
|
returns:
|
|
description: "An updated instance of this builder with the additional tenants configured."
|
|
type: "<xref href=\"com.azure.identity.VisualStudioCodeCredentialBuilder?alt=com.azure.identity.VisualStudioCodeCredentialBuilder&text=VisualStudioCodeCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.identity.VisualStudioCodeCredentialBuilder.build()"
|
|
fullName: "com.azure.identity.VisualStudioCodeCredentialBuilder.build()"
|
|
name: "build()"
|
|
nameWithType: "VisualStudioCodeCredentialBuilder.build()"
|
|
summary: "Creates a new <xref uid=\"com.azure.identity.VisualStudioCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VisualStudioCodeCredential\"></xref> with the current configurations."
|
|
syntax: "public VisualStudioCodeCredential build()"
|
|
desc: "Creates a new <xref uid=\"com.azure.identity.VisualStudioCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VisualStudioCodeCredential\"></xref> with the current configurations."
|
|
returns:
|
|
description: "a <xref uid=\"com.azure.identity.VisualStudioCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VisualStudioCodeCredential\"></xref> with the current configurations."
|
|
type: "<xref href=\"com.azure.identity.VisualStudioCodeCredential?alt=com.azure.identity.VisualStudioCodeCredential&text=VisualStudioCodeCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.identity.VisualStudioCodeCredentialBuilder.tenantId(java.lang.String)"
|
|
fullName: "com.azure.identity.VisualStudioCodeCredentialBuilder.tenantId(String tenantId)"
|
|
name: "tenantId(String tenantId)"
|
|
nameWithType: "VisualStudioCodeCredentialBuilder.tenantId(String tenantId)"
|
|
summary: "Sets the tenant id of the user to authenticate through the <xref uid=\"com.azure.identity.VisualStudioCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VisualStudioCodeCredential\"></xref>."
|
|
parameters:
|
|
- description: "the tenant ID to set."
|
|
name: "tenantId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public VisualStudioCodeCredentialBuilder tenantId(String tenantId)"
|
|
desc: "Sets the tenant id of the user to authenticate through the <xref uid=\"com.azure.identity.VisualStudioCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VisualStudioCodeCredential\"></xref>. The default is the tenant the user originally authenticated to via the Visual Studio Code Azure Account plugin."
|
|
returns:
|
|
description: "An updated instance of this builder with the tenant id set as specified."
|
|
type: "<xref href=\"com.azure.identity.VisualStudioCodeCredentialBuilder?alt=com.azure.identity.VisualStudioCodeCredentialBuilder&text=VisualStudioCodeCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.VisualStudioCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VisualStudioCodeCredential\"></xref>.\n\nIt's a [known issue][] that this credential doesn't work with [Azure Account extension][] versions newer than **0.9.11**. A long-term fix to this problem is in progress. In the meantime, consider authenticating with <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureCliCredential\"></xref>.\n\n\n[known issue]: https://github.com/Azure/azure-sdk-for-java/issues/27364\n[Azure Account extension]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account"
|
|
metadata: {}
|
|
package: "com.azure.identity"
|
|
artifact: com.azure:azure-identity:1.14.1
|