azure-docs-sdk-java/docs-ref-autogen/com.azure.identity.ManagedI...

106 строки
13 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.identity.ManagedIdentityCredentialBuilder"
fullName: "com.azure.identity.ManagedIdentityCredentialBuilder"
name: "ManagedIdentityCredentialBuilder"
nameWithType: "ManagedIdentityCredentialBuilder"
summary: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.ManagedIdentityCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagedIdentityCredential\"></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 **ManagedIdentityCredentialBuilder**</br> extends <xref href=\"com.azure.identity.CredentialBuilderBase?alt=com.azure.identity.CredentialBuilderBase&text=CredentialBuilderBase\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.identity.ManagedIdentityCredentialBuilder?alt=com.azure.identity.ManagedIdentityCredentialBuilder&text=ManagedIdentityCredentialBuilder\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.identity.ManagedIdentityCredentialBuilder.ManagedIdentityCredentialBuilder()"
fullName: "com.azure.identity.ManagedIdentityCredentialBuilder.ManagedIdentityCredentialBuilder()"
name: "ManagedIdentityCredentialBuilder()"
nameWithType: "ManagedIdentityCredentialBuilder.ManagedIdentityCredentialBuilder()"
summary: "Constructs an instance of Managed<wbr>Identity<wbr>Credential<wbr>Builder."
syntax: "public ManagedIdentityCredentialBuilder()"
desc: "Constructs an instance of ManagedIdentityCredentialBuilder."
methods:
- uid: "com.azure.identity.ManagedIdentityCredentialBuilder.build()"
fullName: "com.azure.identity.ManagedIdentityCredentialBuilder.build()"
name: "build()"
nameWithType: "ManagedIdentityCredentialBuilder.build()"
summary: "Creates a new <xref uid=\"com.azure.identity.ManagedIdentityCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagedIdentityCredential\"></xref> with the current configurations."
syntax: "public ManagedIdentityCredential build()"
desc: "Creates a new <xref uid=\"com.azure.identity.ManagedIdentityCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagedIdentityCredential\"></xref> with the current configurations."
returns:
description: "a <xref uid=\"com.azure.identity.ManagedIdentityCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagedIdentityCredential\"></xref> with the current configurations."
type: "<xref href=\"com.azure.identity.ManagedIdentityCredential?alt=com.azure.identity.ManagedIdentityCredential&text=ManagedIdentityCredential\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.ManagedIdentityCredentialBuilder.clientId(java.lang.String)"
fullName: "com.azure.identity.ManagedIdentityCredentialBuilder.clientId(String clientId)"
name: "clientId(String clientId)"
nameWithType: "ManagedIdentityCredentialBuilder.clientId(String clientId)"
summary: "Specifies the client ID of a user-assigned or system-assigned managed identity."
parameters:
- description: "the client ID"
name: "clientId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedIdentityCredentialBuilder clientId(String clientId)"
desc: "Specifies the client ID of a user-assigned or system-assigned managed identity. Only one of clientId, resourceId, or objectId can be specified."
returns:
description: "the ManagedIdentityCredentialBuilder itself"
type: "<xref href=\"com.azure.identity.ManagedIdentityCredentialBuilder?alt=com.azure.identity.ManagedIdentityCredentialBuilder&text=ManagedIdentityCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.ManagedIdentityCredentialBuilder.objectId(java.lang.String)"
fullName: "com.azure.identity.ManagedIdentityCredentialBuilder.objectId(String objectId)"
name: "objectId(String objectId)"
nameWithType: "ManagedIdentityCredentialBuilder.objectId(String objectId)"
summary: "Specifies the object ID of a user-assigned or system-assigned managed identity."
parameters:
- description: "the object ID"
name: "objectId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedIdentityCredentialBuilder objectId(String objectId)"
desc: "Specifies the object ID of a user-assigned or system-assigned managed identity. Only one of clientId, resourceId, or objectId can be specified."
returns:
description: "the ManagedIdentityCredentialBuilder itself"
type: "<xref href=\"com.azure.identity.ManagedIdentityCredentialBuilder?alt=com.azure.identity.ManagedIdentityCredentialBuilder&text=ManagedIdentityCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.identity.ManagedIdentityCredentialBuilder.resourceId(java.lang.String)"
fullName: "com.azure.identity.ManagedIdentityCredentialBuilder.resourceId(String resourceId)"
name: "resourceId(String resourceId)"
nameWithType: "ManagedIdentityCredentialBuilder.resourceId(String resourceId)"
summary: "Specifies the resource ID of a user-assigned or system-assigned managed identity."
parameters:
- description: "the resource ID"
name: "resourceId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public ManagedIdentityCredentialBuilder resourceId(String resourceId)"
desc: "Specifies the resource ID of a user-assigned or system-assigned managed identity. Only one of clientId, resourceId, or objectId can be specified."
returns:
description: "the ManagedIdentityCredentialBuilder itself"
type: "<xref href=\"com.azure.identity.ManagedIdentityCredentialBuilder?alt=com.azure.identity.ManagedIdentityCredentialBuilder&text=ManagedIdentityCredentialBuilder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.ManagedIdentityCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagedIdentityCredential\"></xref>.\n\n[Azure Managed Identity][] is a feature in [Microsoft Entra ID][] that provides a way for applications running on Azure to authenticate themselves with Azure resources without needing to manage or store any secrets like passwords or keys. The <xref uid=\"com.azure.identity.ManagedIdentityCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagedIdentityCredential\"></xref> authenticates the configured managed identity (system or user assigned) of an Azure resource. So, if the application is running inside an Azure resource that supports Managed Identity through IDENTITY/MSI, IMDS endpoints, or both, then this credential will get your application authenticated, and offers a great secretless authentication experience. For more information refer to the [managed identity authentication documentation][].\n\n**Sample: Construct a simple ManagedIdentityCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.ManagedIdentityCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagedIdentityCredential\"></xref>, using the ManagedIdentityCredentialBuilder 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 managedIdentityCredential = new ManagedIdentityCredentialBuilder().build();\n```\n\n**Sample: Construct a User Assigned ManagedIdentityCredential**\n\nUser-Assigned Managed Identity (UAMI) in Azure is a feature that allows you to create an identity in [Microsoft Entra ID][] that is associated with one or more Azure resources. This identity can then be used to authenticate and authorize access to various Azure services and resources. The following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.ManagedIdentityCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ManagedIdentityCredential\"></xref> to target a user assigned managed identity, using the ManagedIdentityCredentialBuilder 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 managedIdentityCredentialUserAssigned = new ManagedIdentityCredentialBuilder().clientId(\n clientId) // specify client id of user-assigned managed identity.\n .build();\n```\n\n\n[Azure Managed Identity]: https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/\n[Microsoft Entra ID]: https://learn.microsoft.com/entra/fundamentals/\n[managed identity authentication documentation]: https://aka.ms/azsdk/java/identity/managedidentitycredential/docs"
metadata: {}
package: "com.azure.identity"
artifact: com.azure:azure-identity:1.14.1