azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.batch.a...

128 строки
9.4 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials"
fullName: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials"
name: "BatchApplicationTokenCredentials"
nameWithType: "BatchApplicationTokenCredentials"
summary: "Application token based credentials for use with a Batch Service Client."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.rest.credentials.TokenCredentials?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.microsoft.rest.credentials.TokenCredentials?alt=com.microsoft.rest.credentials.TokenCredentials&text=TokenCredentials\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.microsoft.rest.credentials.TokenCredentials.applyCredentialsFilter(okhttp3.OkHttpClient.Builder)?alt=com.microsoft.rest.credentials.TokenCredentials.applyCredentialsFilter&text=applyCredentialsFilter\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.rest.credentials.TokenCredentials.getScheme()?alt=com.microsoft.rest.credentials.TokenCredentials.getScheme&text=getScheme\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.rest.credentials.TokenCredentials.getToken(okhttp3.Request)?alt=com.microsoft.rest.credentials.TokenCredentials.getToken&text=getToken\" 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 **BatchApplicationTokenCredentials**</br> extends <xref href=\"com.microsoft.rest.credentials.TokenCredentials?alt=com.microsoft.rest.credentials.TokenCredentials&text=TokenCredentials\" data-throw-if-not-resolved=\"False\" /></br> implements <xref href=\"com.microsoft.azure.batch.auth.BatchCredentials?alt=com.microsoft.azure.batch.auth.BatchCredentials&text=BatchCredentials\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.BatchApplicationTokenCredentials(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.BatchApplicationTokenCredentials(String baseUrl, String clientId, String secret, String domain, String batchEndpoint, String authenticationEndpoint)"
name: "BatchApplicationTokenCredentials(String baseUrl, String clientId, String secret, String domain, String batchEndpoint, String authenticationEndpoint)"
nameWithType: "BatchApplicationTokenCredentials.BatchApplicationTokenCredentials(String baseUrl, String clientId, String secret, String domain, String batchEndpoint, String authenticationEndpoint)"
summary: "Initializes a new instance of the Batch<wbr>Application<wbr>Token<wbr>Credentials."
parameters:
- description: "the Batch service endpoint."
name: "baseUrl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the Active Directory application client id."
name: "clientId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the authentication secret for the application."
name: "secret"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the domain or tenant id containing this application."
name: "domain"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the Batch service endpoint to authenticate with."
name: "batchEndpoint"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the Active Directory endpoint to authenticate with."
name: "authenticationEndpoint"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BatchApplicationTokenCredentials(String baseUrl, String clientId, String secret, String domain, String batchEndpoint, String authenticationEndpoint)"
desc: "Initializes a new instance of the BatchApplicationTokenCredentials."
methods:
- uid: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.authenticationEndpoint()"
fullName: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.authenticationEndpoint()"
name: "authenticationEndpoint()"
nameWithType: "BatchApplicationTokenCredentials.authenticationEndpoint()"
summary: "Gets the Active Directory auth endpoint."
syntax: "public String authenticationEndpoint()"
desc: "Gets the Active Directory auth endpoint."
returns:
description: "the Active Directory auth endpoint."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.baseUrl()"
fullName: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.baseUrl()"
name: "baseUrl()"
nameWithType: "BatchApplicationTokenCredentials.baseUrl()"
summary: "Gets the Batch service endpoint"
syntax: "public String baseUrl()"
desc: "Gets the Batch service endpoint"
returns:
description: "The Batch service endpoint"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.batchEndpoint()"
fullName: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.batchEndpoint()"
name: "batchEndpoint()"
nameWithType: "BatchApplicationTokenCredentials.batchEndpoint()"
summary: "Gets the Batch service auth endpoint."
syntax: "public String batchEndpoint()"
desc: "Gets the Batch service auth endpoint."
returns:
description: "the Batch service auth endpoint."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.clientId()"
fullName: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.clientId()"
name: "clientId()"
nameWithType: "BatchApplicationTokenCredentials.clientId()"
summary: "Gets the Active Directory application client id."
syntax: "public String clientId()"
desc: "Gets the Active Directory application client id."
returns:
description: "the active directory application client id."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.domain()"
fullName: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.domain()"
name: "domain()"
nameWithType: "BatchApplicationTokenCredentials.domain()"
summary: "Gets the tenant or domain containing the application."
syntax: "public String domain()"
desc: "Gets the tenant or domain containing the application."
returns:
description: "the tenant or domain containing the application."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.getToken(okhttp3.Request)"
fullName: "com.microsoft.azure.batch.auth.BatchApplicationTokenCredentials.getToken(Request request)"
name: "getToken(Request request)"
nameWithType: "BatchApplicationTokenCredentials.getToken(Request request)"
overridden: "com.microsoft.rest.credentials.TokenCredentials.getToken(okhttp3.Request)"
parameters:
- name: "request"
type: "<xref href=\"okhttp3.Request?alt=okhttp3.Request&text=Request\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String getToken(Request request)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "Application token based credentials for use with a Batch Service Client."
implements:
- "<xref href=\"com.microsoft.azure.batch.auth.BatchCredentials?alt=com.microsoft.azure.batch.auth.BatchCredentials&text=BatchCredentials\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.azure.batch.auth"
artifact: com.microsoft.azure:azure-batch:11.2.0