117 строки
14 KiB
YAML
117 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.identity.SharedTokenCacheCredentialBuilder"
|
|
fullName: "com.azure.identity.SharedTokenCacheCredentialBuilder"
|
|
name: "SharedTokenCacheCredentialBuilder"
|
|
nameWithType: "SharedTokenCacheCredentialBuilder"
|
|
summary: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.SharedTokenCacheCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SharedTokenCacheCredential\"></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\" />"
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.identity.AadCredentialBuilderBase?alt=com.azure.identity.AadCredentialBuilderBase&text=AadCredentialBuilderBase\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.additionallyAllowedTenants(java.lang.String...)?alt=com.azure.identity.AadCredentialBuilderBase.additionallyAllowedTenants&text=additionallyAllowedTenants\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.additionallyAllowedTenants(java.util.List<java.lang.String>)?alt=com.azure.identity.AadCredentialBuilderBase.additionallyAllowedTenants&text=additionallyAllowedTenants\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.authorityHost(java.lang.String)?alt=com.azure.identity.AadCredentialBuilderBase.authorityHost&text=authorityHost\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.clientId(java.lang.String)?alt=com.azure.identity.AadCredentialBuilderBase.clientId&text=clientId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.disableInstanceDiscovery()?alt=com.azure.identity.AadCredentialBuilderBase.disableInstanceDiscovery&text=disableInstanceDiscovery\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.enableUnsafeSupportLogging()?alt=com.azure.identity.AadCredentialBuilderBase.enableUnsafeSupportLogging&text=enableUnsafeSupportLogging\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.executorService(java.util.concurrent.ExecutorService)?alt=com.azure.identity.AadCredentialBuilderBase.executorService&text=executorService\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.identity.AadCredentialBuilderBase.tenantId(java.lang.String)?alt=com.azure.identity.AadCredentialBuilderBase.tenantId&text=tenantId\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 **SharedTokenCacheCredentialBuilder**</br> extends <xref href=\"com.azure.identity.AadCredentialBuilderBase?alt=com.azure.identity.AadCredentialBuilderBase&text=AadCredentialBuilderBase\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.identity.SharedTokenCacheCredentialBuilder?alt=com.azure.identity.SharedTokenCacheCredentialBuilder&text=SharedTokenCacheCredentialBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.identity.SharedTokenCacheCredentialBuilder.SharedTokenCacheCredentialBuilder()"
|
|
fullName: "com.azure.identity.SharedTokenCacheCredentialBuilder.SharedTokenCacheCredentialBuilder()"
|
|
name: "SharedTokenCacheCredentialBuilder()"
|
|
nameWithType: "SharedTokenCacheCredentialBuilder.SharedTokenCacheCredentialBuilder()"
|
|
summary: "Constructs an instance of Shared<wbr>Token<wbr>Cache<wbr>Credential<wbr>Builder."
|
|
syntax: "public SharedTokenCacheCredentialBuilder()"
|
|
desc: "Constructs an instance of SharedTokenCacheCredentialBuilder."
|
|
methods:
|
|
- uid: "com.azure.identity.SharedTokenCacheCredentialBuilder.authenticationRecord(com.azure.identity.AuthenticationRecord)"
|
|
fullName: "com.azure.identity.SharedTokenCacheCredentialBuilder.authenticationRecord(AuthenticationRecord authenticationRecord)"
|
|
name: "authenticationRecord(AuthenticationRecord authenticationRecord)"
|
|
nameWithType: "SharedTokenCacheCredentialBuilder.authenticationRecord(AuthenticationRecord authenticationRecord)"
|
|
summary: "Sets the <xref uid=\"com.azure.identity.AuthenticationRecord\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthenticationRecord\"></xref> captured from a previous authentication."
|
|
parameters:
|
|
- description: "the authentication record to be configured."
|
|
name: "authenticationRecord"
|
|
type: "<xref href=\"com.azure.identity.AuthenticationRecord?alt=com.azure.identity.AuthenticationRecord&text=AuthenticationRecord\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SharedTokenCacheCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)"
|
|
desc: "Sets the <xref uid=\"com.azure.identity.AuthenticationRecord\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthenticationRecord\"></xref> captured from a previous authentication."
|
|
returns:
|
|
description: "An updated instance of this builder with the configured authentication record."
|
|
type: "<xref href=\"com.azure.identity.SharedTokenCacheCredentialBuilder?alt=com.azure.identity.SharedTokenCacheCredentialBuilder&text=SharedTokenCacheCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.identity.SharedTokenCacheCredentialBuilder.build()"
|
|
fullName: "com.azure.identity.SharedTokenCacheCredentialBuilder.build()"
|
|
name: "build()"
|
|
nameWithType: "SharedTokenCacheCredentialBuilder.build()"
|
|
summary: "Creates a new <xref uid=\"com.azure.identity.SharedTokenCacheCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SharedTokenCacheCredentialBuilder\"></xref> with the current configurations."
|
|
syntax: "public SharedTokenCacheCredential build()"
|
|
desc: "Creates a new <xref uid=\"com.azure.identity.SharedTokenCacheCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SharedTokenCacheCredentialBuilder\"></xref> with the current configurations."
|
|
returns:
|
|
description: "a <xref uid=\"com.azure.identity.SharedTokenCacheCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SharedTokenCacheCredentialBuilder\"></xref> with the current configurations."
|
|
type: "<xref href=\"com.azure.identity.SharedTokenCacheCredential?alt=com.azure.identity.SharedTokenCacheCredential&text=SharedTokenCacheCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.identity.SharedTokenCacheCredentialBuilder.tokenCachePersistenceOptions(com.azure.identity.TokenCachePersistenceOptions)"
|
|
fullName: "com.azure.identity.SharedTokenCacheCredentialBuilder.tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)"
|
|
name: "tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)"
|
|
nameWithType: "SharedTokenCacheCredentialBuilder.tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)"
|
|
summary: "Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default."
|
|
parameters:
|
|
- description: "the token cache configuration options"
|
|
name: "tokenCachePersistenceOptions"
|
|
type: "<xref href=\"com.azure.identity.TokenCachePersistenceOptions?alt=com.azure.identity.TokenCachePersistenceOptions&text=TokenCachePersistenceOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SharedTokenCacheCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)"
|
|
desc: "Configures the persistent shared token cache options and enables the persistent token cache which is disabled by default. If configured, the credential will store tokens in a cache persisted to the machine, protected to the current user, which can be shared by other credentials and processes."
|
|
returns:
|
|
description: "An updated instance of this builder with the token cache options configured."
|
|
type: "<xref href=\"com.azure.identity.SharedTokenCacheCredentialBuilder?alt=com.azure.identity.SharedTokenCacheCredentialBuilder&text=SharedTokenCacheCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.identity.SharedTokenCacheCredentialBuilder.username(java.lang.String)"
|
|
fullName: "com.azure.identity.SharedTokenCacheCredentialBuilder.username(String username)"
|
|
name: "username(String username)"
|
|
nameWithType: "SharedTokenCacheCredentialBuilder.username(String username)"
|
|
summary: "Sets the username for the account."
|
|
parameters:
|
|
- description: "The username for the account."
|
|
name: "username"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SharedTokenCacheCredentialBuilder username(String username)"
|
|
desc: "Sets the username for the account."
|
|
returns:
|
|
description: "The updated SharedTokenCacheCredentialBuilder object."
|
|
type: "<xref href=\"com.azure.identity.SharedTokenCacheCredentialBuilder?alt=com.azure.identity.SharedTokenCacheCredentialBuilder&text=SharedTokenCacheCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.SharedTokenCacheCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SharedTokenCacheCredential\"></xref>.\n\nThis credential is a legacy mechanism for authenticating clients using credentials provided to Visual Studio Code. This mechanism for Visual Studio authentication has been replaced by the <xref uid=\"com.azure.identity.VisualStudioCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"VisualStudioCodeCredential\"></xref>/>."
|
|
metadata: {}
|
|
package: "com.azure.identity"
|
|
artifact: com.azure:azure-identity:1.14.1
|