52 строки
6.5 KiB
YAML
52 строки
6.5 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.identity.EnvironmentCredential"
|
|
fullName: "com.azure.identity.EnvironmentCredential"
|
|
name: "EnvironmentCredential"
|
|
nameWithType: "EnvironmentCredential"
|
|
summary: "The EnvironmentCredential is appropriate for scenarios where the application is looking to read credential information from environment variables."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- 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 **EnvironmentCredential**</br> implements <xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
methods:
|
|
- uid: "com.azure.identity.EnvironmentCredential.getToken(com.azure.core.credential.TokenRequestContext)"
|
|
fullName: "com.azure.identity.EnvironmentCredential.getToken(TokenRequestContext request)"
|
|
name: "getToken(TokenRequestContext request)"
|
|
nameWithType: "EnvironmentCredential.getToken(TokenRequestContext request)"
|
|
parameters:
|
|
- name: "request"
|
|
type: "<xref href=\"com.azure.core.credential.TokenRequestContext?alt=com.azure.core.credential.TokenRequestContext&text=TokenRequestContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<AccessToken> getToken(TokenRequestContext request)"
|
|
returns:
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.credential.AccessToken?alt=com.azure.core.credential.AccessToken&text=AccessToken\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.identity.EnvironmentCredential.getTokenSync(com.azure.core.credential.TokenRequestContext)"
|
|
fullName: "com.azure.identity.EnvironmentCredential.getTokenSync(TokenRequestContext request)"
|
|
name: "getTokenSync(TokenRequestContext request)"
|
|
nameWithType: "EnvironmentCredential.getTokenSync(TokenRequestContext request)"
|
|
parameters:
|
|
- name: "request"
|
|
type: "<xref href=\"com.azure.core.credential.TokenRequestContext?alt=com.azure.core.credential.TokenRequestContext&text=TokenRequestContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AccessToken getTokenSync(TokenRequestContext request)"
|
|
returns:
|
|
type: "<xref href=\"com.azure.core.credential.AccessToken?alt=com.azure.core.credential.AccessToken&text=AccessToken\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The EnvironmentCredential is appropriate for scenarios where the application is looking to read credential information from environment variables. The credential supports service principal and user credential based authentication and requires a set of environment variables to be configured for each scenario.\n\nThe required environment variables for service principal authentication using client secret are as follows:\n\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_CLIENT_ID\"></xref>\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_CLIENT_SECRET\"></xref>\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_TENANT_ID\"></xref>\n\nThe required environment variables for service principal authentication using client certificate are as follows:\n\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_CLIENT_ID\"></xref>\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_CLIENT_CERTIFICATE_PATH\"></xref>\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_CLIENT_CERTIFICATE_PASSWORD\"></xref>\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_TENANT_ID\"></xref>\n\nThe required environment variables for username password authentication are as follows:\n\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_CLIENT_ID\"></xref>\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_USERNAME\"></xref>\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_PASSWORD\"></xref>\n * <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AZURE_TENANT_ID\"></xref>\n\nThe credential looks for authentication scenarios in the order above, so ensure that only targeted authentication scenario's environment variables are configured.\n\n**Sample: Construct EnvironmentCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.EnvironmentCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.EnvironmentCredential\"></xref>, using the <xref uid=\"com.azure.identity.EnvironmentCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.EnvironmentCredentialBuilder\"></xref> to configure it. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.\n\n```java\nTokenCredential environmentCredential = new EnvironmentCredentialBuilder().build();\n```"
|
|
implements:
|
|
- "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.azure.identity"
|
|
artifact: com.azure:azure-identity:1.14.1
|