Package com.microsoft.azure.util

Class AzureCredentialsBinding

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.credentialsbinding.MultiBinding<C>>

org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>

com.microsoft.azure.util.AzureCredentialsBinding

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>>

public class AzureCredentialsBinding
extends org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>

Custom binding for AzureCredentials to support reading Azure service principal in both freestyle and pipeline using Credentials Binding plugin. There're two ways to construct this binding:

1. With defaults, which will read specified service principal into four predefined environment variables: AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_TENANT_ID. Sample pipeline code:

   
        withCredentials([azureServicePrincipal('credentials_id')]) {
            sh 'az login --service-principal -u $AZURE_CLIENT_ID -p $AZURE_CLIENT_SECRET -t $AZURE_TENANT_ID'
        }
    

2. With custom name, where you can control the names of the variables. Sample pipeline code:

   
        withCredentials([azureServicePrincipal(credentialsId: 'credentials_id',
                                               subscriptionIdVariable: 'SUBS_ID',
                                               clientIdVariable: 'CLIENT_ID',
                                               clientSecretVariable: 'CLIENT_SECRET',
                                               tenantIdVariable: 'TENANT_ID')]) {
            sh 'az login --service-principal -u $CLIENT_ID -p $CLIENT_SECRET -t $TENANT_ID'
        }
    

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AzureCredentialsBinding.DescriptorImpl

Nested classes/interfaces inherited from class org.jenkinsci.plugins.credentialsbinding.MultiBinding

org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment, org.jenkinsci.plugins.credentialsbinding.MultiBinding.NullUnbinder, org.jenkinsci.plugins.credentialsbinding.MultiBinding.Unbinder

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CLIENT_ID_VARIABLE
static String	DEFAULT_CLIENT_SECRET_VARIABLE
static String	DEFAULT_SUBSCRIPTION_ID_VARIABLE
static String	DEFAULT_TENANT_ID_VARIABLE

Constructor Summary

Constructors

Constructor	Description
AzureCredentialsBinding(String credentialsId)

Method Summary

Modifier and Type	Method	Description
org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment	bind(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)
String	getClientIdVariable()
String	getClientSecretVariable()
String	getSubscriptionIdVariable()
String	getTenantIdVariable()
void	setClientIdVariable(String clientIdVariable)
void	setClientSecretVariable(String clientSecretVariable)
void	setSubscriptionIdVariable(String subscriptionIdVariable)
void	setTenantIdVariable(String tenantIdVariable)
protected Class<AzureCredentials>	type()
Set<String>	variables(Run<?,?> build)

Methods inherited from class org.jenkinsci.plugins.credentialsbinding.MultiBinding

getCredentials, getCredentialsId, getDescriptor, variables

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SUBSCRIPTION_ID_VARIABLE

public static final String DEFAULT_SUBSCRIPTION_ID_VARIABLE

See Also:

Constant Field Values

DEFAULT_CLIENT_ID_VARIABLE

public static final String DEFAULT_CLIENT_ID_VARIABLE

See Also:

Constant Field Values

DEFAULT_CLIENT_SECRET_VARIABLE

public static final String DEFAULT_CLIENT_SECRET_VARIABLE

See Also:

Constant Field Values

DEFAULT_TENANT_ID_VARIABLE

public static final String DEFAULT_TENANT_ID_VARIABLE

See Also:

Constant Field Values

Constructor Detail

AzureCredentialsBinding

@DataBoundConstructor
public AzureCredentialsBinding(String credentialsId)

Method Detail

setSubscriptionIdVariable

@DataBoundSetter
public void setSubscriptionIdVariable(String subscriptionIdVariable)

setClientIdVariable

@DataBoundSetter
public void setClientIdVariable(String clientIdVariable)

setClientSecretVariable

@DataBoundSetter
public void setClientSecretVariable(String clientSecretVariable)

setTenantIdVariable

@DataBoundSetter
public void setTenantIdVariable(String tenantIdVariable)

getSubscriptionIdVariable

public String getSubscriptionIdVariable()

getClientIdVariable

public String getClientIdVariable()

getClientSecretVariable

public String getClientSecretVariable()

getTenantIdVariable

public String getTenantIdVariable()

type

protected Class<AzureCredentials> type()

Specified by:

type in class org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>

bind

public org.jenkinsci.plugins.credentialsbinding.MultiBinding.MultiEnvironment bind(@NonNull
                                                                                   Run<?,?> build,
                                                                                   FilePath workspace,
                                                                                   Launcher launcher,
                                                                                   TaskListener listener)
                                                                            throws IOException,
                                                                                   InterruptedException

Specified by:

bind in class org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>

Throws:

IOException

InterruptedException

variables

public Set<String> variables(Run<?,?> build)

Overrides:

variables in class org.jenkinsci.plugins.credentialsbinding.MultiBinding<AzureCredentials>