Package org.azd.serviceendpoint

Class ServiceEndpointApi

java.lang.Object

org.azd.utils.AzDAsyncApi<ServiceEndpointApi>

org.azd.serviceendpoint.ServiceEndpointApi

All Implemented Interfaces:

ServiceEndpointDetails

public class ServiceEndpointApi
extends AzDAsyncApi<ServiceEndpointApi>
implements ServiceEndpointDetails

Service Endpoint Api to manage service endpoint service

Constructor Summary

Constructors

Constructor	Description
ServiceEndpointApi(Connection connection)	Pass the connection object to work with Service endpoint Api

Method Summary

Modifier and Type	Method	Description
ServiceEndpoint	createAzureRMServiceEndpoint(String endpointName, String servicePrincipalId, String servicePrincipalKey, String tenantId, String subscriptionId, String subscriptionName)	A helper method to create Azure RM service endpoint
ServiceEndpoint	createServiceEndpoint(String endpointName, String endpointType, Map requestBody)	Creates a new service endpoint
Void	deleteServiceEndpoint(String endpointId, String[] projectIds)	Delete a service endpoint
Void	deleteServiceEndpoint(String endpointId, String[] projectIds, boolean deep)	Delete a service endpoint
ServiceEndpoint	getServiceEndpoint(String endpointId)	Get the service endpoint details.
ServiceEndpoint	getServiceEndpoint(String endpointId, ServiceEndpointActionFilter actionFilter)	Get the service endpoint details.
ServiceEndpoints	getServiceEndpoints()	Get the service endpoints.
ServiceEndpoints	getServiceEndpointsByNames(String[] endpointNames)	Get the service endpoints by name.
ServiceEndpoints	getServiceEndpointsByNames(String[] endpointNames, String[] authSchemes, boolean includeDetails, boolean includeFailed, String owner, String type)	Get the service endpoints by name.
Void	shareServiceEndpoint(String endpointId, String projectName, String connectionName)	Share service endpoint across projects
ServiceEndpoint	updateServiceEndpoint(String endpointId, Map requestBody)	Update the service endpoint

Methods inherited from class org.azd.utils.AzDAsyncApi

createAsync

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceEndpointApi

public ServiceEndpointApi(Connection connection)

Pass the connection object to work with Service endpoint Api

Parameters:

connection - Connection object

Method Details

createServiceEndpoint

public ServiceEndpoint createServiceEndpoint(String endpointName,
 String endpointType,
 Map requestBody)
                                      throws AzDException

Creates a new service endpoint

Specified by:

createServiceEndpoint in interface ServiceEndpointDetails

Parameters:

endpointName - Friendly name of the endpoint

endpointType - Type of the endpoint

requestBody - Request body to create a service endpoint. Reference https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/create?view=azure-devops-rest-6.1#create-service-endpoint

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

createAzureRMServiceEndpoint

public ServiceEndpoint createAzureRMServiceEndpoint(String endpointName,
 String servicePrincipalId,
 String servicePrincipalKey,
 String tenantId,
 String subscriptionId,
 String subscriptionName)
                                             throws AzDException

A helper method to create Azure RM service endpoint

Specified by:

createAzureRMServiceEndpoint in interface ServiceEndpointDetails

Parameters:

endpointName - Friendly name of the endpoint

servicePrincipalId - service principal Id

servicePrincipalKey - service principal key

tenantId - Tenant Id

subscriptionId - subscription Id

subscriptionName - subscription name

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

getServiceEndpoint

public ServiceEndpoint getServiceEndpoint(String endpointId)
                                   throws AzDException

Get the service endpoint details.

Specified by:

getServiceEndpoint in interface ServiceEndpointDetails

Parameters:

endpointId - Id of the service endpoint.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

getServiceEndpoint

public ServiceEndpoint getServiceEndpoint(String endpointId,
 ServiceEndpointActionFilter actionFilter)
                                   throws AzDException

Get the service endpoint details.

Specified by:

getServiceEndpoint in interface ServiceEndpointDetails

Parameters:

endpointId - Id of the service endpoint.

actionFilter - Action filter for the service connection. It specifies the action which can be performed on the service connection.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

getServiceEndpoints

public ServiceEndpoints getServiceEndpoints()
                                     throws AzDException

Get the service endpoints.

Specified by:

getServiceEndpoints in interface ServiceEndpointDetails

Returns:

ServiceEndpoints ServiceEndpoints

Throws:

AzDException - Default Api Exception handler.

deleteServiceEndpoint

public Void deleteServiceEndpoint(String endpointId,
 String[] projectIds)
                           throws AzDException

Delete a service endpoint

Specified by:

deleteServiceEndpoint in interface ServiceEndpointDetails

Parameters:

endpointId - Endpoint Id of endpoint to delete

projectIds - project Ids from which endpoint needs to be deleted

Throws:

AzDException - Default Api Exception handler.

deleteServiceEndpoint

public Void deleteServiceEndpoint(String endpointId,
 String[] projectIds,
 boolean deep)
                           throws AzDException

Delete a service endpoint

Specified by:

deleteServiceEndpoint in interface ServiceEndpointDetails

Parameters:

endpointId - Endpoint Id of endpoint to delete

projectIds - project Ids from which endpoint needs to be deleted

deep - delete the spn created by endpoint

Throws:

AzDException - Default Api Exception handler.

getServiceEndpointsByNames

public ServiceEndpoints getServiceEndpointsByNames(String[] endpointNames)
                                            throws AzDException

Get the service endpoints by name.

Specified by:

getServiceEndpointsByNames in interface ServiceEndpointDetails

Parameters:

endpointNames - Names of the service endpoints.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

getServiceEndpointsByNames

public ServiceEndpoints getServiceEndpointsByNames(String[] endpointNames,
 String[] authSchemes,
 boolean includeDetails,
 boolean includeFailed,
 String owner,
 String type)
                                            throws AzDException

Get the service endpoints by name.

Specified by:

getServiceEndpointsByNames in interface ServiceEndpointDetails

Parameters:

endpointNames - Names of the service endpoints.

authSchemes - Authorization schemes used for service endpoints.

includeDetails - Flag to include more details for service endpoints. This is for internal use only and the flag will be treated as false for all other requests

includeFailed - Failed flag for service endpoints.

owner - Owner for service endpoints.

type - Type of the service endpoints.

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.

shareServiceEndpoint

public Void shareServiceEndpoint(String endpointId,
 String projectName,
 String connectionName)
                          throws AzDException

Share service endpoint across projects

Specified by:

shareServiceEndpoint in interface ServiceEndpointDetails

Parameters:

endpointId - Endpoint Id of the endpoint to share

projectName - Provide the project name to which the service endpoint connection to be shared

connectionName - Name of the connection

Throws:

AzDException - Default Api Exception handler.

updateServiceEndpoint

public ServiceEndpoint updateServiceEndpoint(String endpointId,
 Map requestBody)
                                      throws AzDException

Update the service endpoint

Specified by:

updateServiceEndpoint in interface ServiceEndpointDetails

Parameters:

endpointId - Endpoint Id of the endpoint to update

requestBody - Request body to update the service endpoint Reference: https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/update-service-endpoint?view=azure-devops-rest-6.1#update-service-endpoint

Returns:

ServiceEndpoint ServiceEndpoint

Throws:

AzDException - Default Api Exception handler.