com.microsoft.azure.util

Class AzureCredentials

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.microsoft.azure.util.AzureBaseCredentials

com.microsoft.azure.util.AzureCredentials

All Implemented Interfaces:

com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.Credentials, hudson.ExtensionPoint, hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable

public class AzureCredentials
extends AzureBaseCredentials

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AzureCredentials.DescriptorImpl
static class	AzureCredentials.ServicePrincipal
static class	AzureCredentials.ValidationException

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

com.cloudbees.plugins.credentials.common.StandardCredentials.NameProvider

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String subscriptionId, String clientId, String clientSecret)
AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String subscriptionId, String clientId, String clientSecret, String oauth2TokenEndpoint, String serviceManagementURL, String authenticationEndpoint, String resourceManagerEndpoint, String graphEndpoint) Deprecated. Leave for backward compatibility.

Method Summary

Modifier and Type	Method and Description
static com.azure.security.keyvault.secrets.SecretClient	createKeyVaultClient(com.azure.core.credential.TokenCredential credential, String keyVaultUrl)
com.microsoft.jenkins.azurecommons.core.credentials.TokenCredentialData	createToken()
String	getActiveDirectoryEndpoint()
String	getAuthenticationEndpoint() Deprecated. use getActiveDirectoryEndpoint().
String	getAzureEnvionmentName() Deprecated.
String	getAzureEnvironmentName()
String	getCertificateId()
String	getClientId()
String	getClientSecret()
static com.azure.core.credential.TokenCredential	getCredentialById(String credentialId)
String	getGraphEndpoint()
String	getManagementEndpoint()
String	getOauth2TokenEndpoint() Deprecated. use tenant related methods instead.
String	getPlainClientSecret()
String	getResourceManagerEndpoint()
String	getServiceManagementURL() Deprecated. use getManagementEndpoint().
static AzureCredentials.ServicePrincipal	getServicePrincipal(String credentialsId) Deprecated.
String	getSubscriptionId()
String	getTenant()
void	setActiveDirectoryEndpoint(String activeDirectoryEndpoint)
void	setAuthenticationEndpoint(String authenticationEndpoint) Deprecated. use setActiveDirectoryEndpoint(String).
void	setAzureEnvironmentName(String azureEnvironmentName)
void	setCertificateId(String certificateId)
void	setGraphEndpoint(String graphEndpoint)
void	setManagementEndpoint(String managementEndpoint)
void	setOauth2TokenEndpoint(String oauth2TokenEndpoint) Deprecated. use tenant related methods instead.
void	setResourceManagerEndpoint(String resourceManagerEndpoint)
void	setServiceManagementURL(String serviceManagementURL) Deprecated. use setManagementEndpoint(String).
void	setTenant(String tenant)

Methods inherited from class com.microsoft.azure.util.AzureBaseCredentials

serializeToTokenData

Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

equals, getDescription, getId, hashCode

Methods inherited from class com.cloudbees.plugins.credentials.BaseCredentials

getDescriptor, getScope

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

getDescriptor, getScope

Constructor Detail

AzureCredentials

@DataBoundConstructor
public AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope,
                                               String id,
                                               String description,
                                               String subscriptionId,
                                               String clientId,
                                               String clientSecret)

AzureCredentials

@Deprecated
public AzureCredentials(com.cloudbees.plugins.credentials.CredentialsScope scope,
                                     String id,
                                     String description,
                                     String subscriptionId,
                                     String clientId,
                                     String clientSecret,
                                     String oauth2TokenEndpoint,
                                     String serviceManagementURL,
                                     String authenticationEndpoint,
                                     String resourceManagerEndpoint,
                                     String graphEndpoint)

Deprecated. Leave for backward compatibility.

Method Detail

getServicePrincipal

@Deprecated
public static AzureCredentials.ServicePrincipal getServicePrincipal(String credentialsId)

Deprecated.

createKeyVaultClient

public static com.azure.security.keyvault.secrets.SecretClient createKeyVaultClient(com.azure.core.credential.TokenCredential credential,
                                                                                    String keyVaultUrl)

getCredentialById

public static com.azure.core.credential.TokenCredential getCredentialById(String credentialId)

getSubscriptionId

public String getSubscriptionId()

getClientId

public String getClientId()

getClientSecret

public String getClientSecret()

getPlainClientSecret

public String getPlainClientSecret()

setCertificateId

@DataBoundSetter
public void setCertificateId(String certificateId)

getCertificateId

public String getCertificateId()

getTenant

public String getTenant()

setTenant

@DataBoundSetter
public void setTenant(String tenant)

getOauth2TokenEndpoint

@Deprecated
public String getOauth2TokenEndpoint()

Deprecated. use tenant related methods instead.

For backward compatibility.

setOauth2TokenEndpoint

@DataBoundSetter
 @Deprecated
public void setOauth2TokenEndpoint(String oauth2TokenEndpoint)

Deprecated. use tenant related methods instead.

Set the Oauth2 token endpoint for backward compatibility only.

Parameters:

oauth2TokenEndpoint - the endpoint value in the form "https://login.windows.net/<TenantId>"

getAzureEnvionmentName

@Deprecated
public String getAzureEnvionmentName()

Deprecated.

typo.

getAzureEnvironmentName

public String getAzureEnvironmentName()

Specified by:

getAzureEnvironmentName in class AzureBaseCredentials

setAzureEnvironmentName

@DataBoundSetter
public void setAzureEnvironmentName(String azureEnvironmentName)

getServiceManagementURL

@Deprecated
public String getServiceManagementURL()

Deprecated. use getManagementEndpoint().

getManagementEndpoint

public String getManagementEndpoint()

Specified by:

getManagementEndpoint in class AzureBaseCredentials

setServiceManagementURL

@DataBoundSetter
 @Deprecated
public void setServiceManagementURL(String serviceManagementURL)

Deprecated. use setManagementEndpoint(String).

setManagementEndpoint

@DataBoundSetter
public void setManagementEndpoint(String managementEndpoint)

getAuthenticationEndpoint

@Deprecated
public String getAuthenticationEndpoint()

Deprecated. use getActiveDirectoryEndpoint().

getActiveDirectoryEndpoint

public String getActiveDirectoryEndpoint()

Specified by:

getActiveDirectoryEndpoint in class AzureBaseCredentials

setAuthenticationEndpoint

@DataBoundSetter
 @Deprecated
public void setAuthenticationEndpoint(String authenticationEndpoint)

Deprecated. use setActiveDirectoryEndpoint(String).

setActiveDirectoryEndpoint

@DataBoundSetter
public void setActiveDirectoryEndpoint(String activeDirectoryEndpoint)

getResourceManagerEndpoint

public String getResourceManagerEndpoint()

Specified by:

getResourceManagerEndpoint in class AzureBaseCredentials

setResourceManagerEndpoint

@DataBoundSetter
public void setResourceManagerEndpoint(String resourceManagerEndpoint)

getGraphEndpoint

public String getGraphEndpoint()

Specified by:

getGraphEndpoint in class AzureBaseCredentials

createToken

public com.microsoft.jenkins.azurecommons.core.credentials.TokenCredentialData createToken()

Overrides:

createToken in class AzureBaseCredentials

setGraphEndpoint

@DataBoundSetter
public void setGraphEndpoint(String graphEndpoint)