Documentation
¶
Index ¶
- Variables
- type AadLoginPromptOption
- type AadOauthTokenRequest
- type AadOauthTokenResult
- type AccessTokenRequestType
- type AuthConfiguration
- type AuthenticationSchemeReference
- type AuthorizationHeader
- type AzureKeyVaultPermission
- type AzureMLWorkspace
- type AzureManagementGroup
- type AzureManagementGroupQueryResult
- type AzurePermission
- type AzureResourcePermission
- type AzureRoleAssignmentPermission
- type AzureSpnOperationStatus
- type AzureSubscription
- type AzureSubscriptionQueryResult
- type Client
- type ClientCertificate
- type ClientImpl
- func (client *ClientImpl) CreateServiceEndpoint(ctx context.Context, args CreateServiceEndpointArgs) (*ServiceEndpoint, error)
- func (client *ClientImpl) DeleteServiceEndpoint(ctx context.Context, args DeleteServiceEndpointArgs) error
- func (client *ClientImpl) ExecuteServiceEndpointRequest(ctx context.Context, args ExecuteServiceEndpointRequestArgs) (*ServiceEndpointRequestResult, error)
- func (client *ClientImpl) GetServiceEndpointDetails(ctx context.Context, args GetServiceEndpointDetailsArgs) (*ServiceEndpoint, error)
- func (client *ClientImpl) GetServiceEndpointExecutionRecords(ctx context.Context, args GetServiceEndpointExecutionRecordsArgs) (*GetServiceEndpointExecutionRecordsResponseValue, error)
- func (client *ClientImpl) GetServiceEndpointTypes(ctx context.Context, args GetServiceEndpointTypesArgs) (*[]ServiceEndpointType, error)
- func (client *ClientImpl) GetServiceEndpoints(ctx context.Context, args GetServiceEndpointsArgs) (*[]ServiceEndpoint, error)
- func (client *ClientImpl) GetServiceEndpointsByNames(ctx context.Context, args GetServiceEndpointsByNamesArgs) (*[]ServiceEndpoint, error)
- func (client *ClientImpl) UpdateServiceEndpoint(ctx context.Context, args UpdateServiceEndpointArgs) (*ServiceEndpoint, error)
- func (client *ClientImpl) UpdateServiceEndpoints(ctx context.Context, args UpdateServiceEndpointsArgs) (*[]ServiceEndpoint, error)
- type CreateServiceEndpointArgs
- type DataSource
- type DataSourceBinding
- type DataSourceDetails
- type DeleteServiceEndpointArgs
- type DependencyBinding
- type DependencyData
- type DependsOn
- type EndpointAuthorization
- type EndpointOperationStatus
- type EndpointUrl
- type ExecuteServiceEndpointRequestArgs
- type GetServiceEndpointDetailsArgs
- type GetServiceEndpointExecutionRecordsArgs
- type GetServiceEndpointExecutionRecordsResponseValue
- type GetServiceEndpointTypesArgs
- type GetServiceEndpointsArgs
- type GetServiceEndpointsByNamesArgs
- type HelpLink
- type OAuth2TokenResult
- type OAuthConfiguration
- type OAuthConfigurationActionFilter
- type OAuthConfigurationParams
- type OAuthEndpointStatus
- type Parameter
- type ProjectReference
- type ResultTransformationDetails
- type ServiceEndpoint
- type ServiceEndpointActionFilter
- type ServiceEndpointAuthenticationScheme
- type ServiceEndpointDetails
- type ServiceEndpointExecutionData
- type ServiceEndpointExecutionOwner
- type ServiceEndpointExecutionRecord
- type ServiceEndpointExecutionRecordsInput
- type ServiceEndpointExecutionResult
- type ServiceEndpointOAuthConfigurationReference
- type ServiceEndpointRequest
- type ServiceEndpointRequestResult
- type ServiceEndpointType
- type UpdateServiceEndpointArgs
- type UpdateServiceEndpointsArgs
Constants ¶
This section is empty.
Variables ¶
var AadLoginPromptOptionValues = aadLoginPromptOptionValuesType{
NoOption: "noOption",
Login: "login",
SelectAccount: "selectAccount",
FreshLogin: "freshLogin",
FreshLoginWithMfa: "freshLoginWithMfa",
}
var AccessTokenRequestTypeValues = accessTokenRequestTypeValuesType{
None: "none",
Oauth: "oauth",
Direct: "direct",
}
var OAuthConfigurationActionFilterValues = oAuthConfigurationActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var ResourceAreaId, _ = uuid.Parse("1814ab31-2f4f-4a9f-8761-f4d77dc5a5d7")
var ServiceEndpointActionFilterValues = serviceEndpointActionFilterValuesType{
None: "none",
Manage: "manage",
Use: "use",
}
var ServiceEndpointExecutionResultValues = serviceEndpointExecutionResultValuesType{
Succeeded: "succeeded",
SucceededWithIssues: "succeededWithIssues",
Failed: "failed",
Canceled: "canceled",
Skipped: "skipped",
Abandoned: "abandoned",
}
Functions ¶
This section is empty.
Types ¶
type AadLoginPromptOption ¶
type AadLoginPromptOption string
type AadOauthTokenRequest ¶
type AadOauthTokenResult ¶
type AccessTokenRequestType ¶
type AccessTokenRequestType string
type AuthConfiguration ¶
type AuthConfiguration struct {
// Gets or sets the ClientId
ClientId *string `json:"clientId,omitempty"`
// Gets or sets the ClientSecret
ClientSecret *string `json:"clientSecret,omitempty"`
// Gets or sets the identity who created the config.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
// Gets or sets the time when config was created.
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
// Gets or sets the type of the endpoint.
EndpointType *string `json:"endpointType,omitempty"`
// Gets or sets the unique identifier of this field
Id *uuid.UUID `json:"id,omitempty"`
// Gets or sets the identity who modified the config.
ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"`
// Gets or sets the time when variable group was modified
ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"`
// Gets or sets the name
Name *string `json:"name,omitempty"`
// Gets or sets the Url
Url *string `json:"url,omitempty"`
// Gets or sets parameters contained in configuration object.
Parameters *map[string]Parameter `json:"parameters,omitempty"`
}
type AuthenticationSchemeReference ¶
type AuthenticationSchemeReference struct {
// Gets or sets the key and value of the fields used for authentication.
Inputs *map[string]string `json:"inputs,omitempty"`
// Gets or sets the type of authentication scheme of an endpoint.
Type *string `json:"type,omitempty"`
}
Specifies the authentication scheme to be used for authentication.
type AuthorizationHeader ¶
type AuthorizationHeader struct {
// Gets or sets the name of authorization header.
Name *string `json:"name,omitempty"`
// Gets or sets the value of authorization header.
Value *string `json:"value,omitempty"`
}
Represents the header of the REST request.
type AzureKeyVaultPermission ¶
type AzureMLWorkspace ¶
type AzureManagementGroup ¶
type AzureManagementGroup struct {
// Display name of azure management group
DisplayName *string `json:"displayName,omitempty"`
// Id of azure management group
Id *string `json:"id,omitempty"`
// Azure management group name
Name *string `json:"name,omitempty"`
// Id of tenant from which azure management group belogs
TenantId *string `json:"tenantId,omitempty"`
}
Azure Management Group
type AzureManagementGroupQueryResult ¶
type AzureManagementGroupQueryResult struct {
// Error message in case of an exception
ErrorMessage *string `json:"errorMessage,omitempty"`
// List of azure management groups
Value *[]AzureManagementGroup `json:"value,omitempty"`
}
Azure management group query result
type AzurePermission ¶
type AzureResourcePermission ¶
type AzureSpnOperationStatus ¶
type AzureSubscription ¶
type AzureSubscriptionQueryResult ¶
type AzureSubscriptionQueryResult struct {
ErrorMessage *string `json:"errorMessage,omitempty"`
Value *[]AzureSubscription `json:"value,omitempty"`
}
type Client ¶
type Client interface {
// [Preview API] Create a service endpoint.
CreateServiceEndpoint(context.Context, CreateServiceEndpointArgs) (*ServiceEndpoint, error)
// [Preview API] Delete a service endpoint.
DeleteServiceEndpoint(context.Context, DeleteServiceEndpointArgs) error
// [Preview API] Proxy for a GET request defined by a service endpoint.
ExecuteServiceEndpointRequest(context.Context, ExecuteServiceEndpointRequestArgs) (*ServiceEndpointRequestResult, error)
// [Preview API] Get the service endpoint details.
GetServiceEndpointDetails(context.Context, GetServiceEndpointDetailsArgs) (*ServiceEndpoint, error)
// [Preview API] Get service endpoint execution records.
GetServiceEndpointExecutionRecords(context.Context, GetServiceEndpointExecutionRecordsArgs) (*GetServiceEndpointExecutionRecordsResponseValue, error)
// [Preview API] Get the service endpoints.
GetServiceEndpoints(context.Context, GetServiceEndpointsArgs) (*[]ServiceEndpoint, error)
// [Preview API] Get the service endpoints by name.
GetServiceEndpointsByNames(context.Context, GetServiceEndpointsByNamesArgs) (*[]ServiceEndpoint, error)
// [Preview API] Get service endpoint types.
GetServiceEndpointTypes(context.Context, GetServiceEndpointTypesArgs) (*[]ServiceEndpointType, error)
// [Preview API] Update a service endpoint.
UpdateServiceEndpoint(context.Context, UpdateServiceEndpointArgs) (*ServiceEndpoint, error)
// [Preview API] Update the service endpoints.
UpdateServiceEndpoints(context.Context, UpdateServiceEndpointsArgs) (*[]ServiceEndpoint, error)
}
func NewClient ¶
func NewClient(ctx context.Context, connection *azuredevops.Connection) (Client, error)
type ClientCertificate ¶
type ClientCertificate struct {
// Gets or sets the value of client certificate.
Value *string `json:"value,omitempty"`
}
Specifies the client certificate to be used for the endpoint request.
type ClientImpl ¶
type ClientImpl struct {
Client azuredevops.Client
}
func (*ClientImpl) CreateServiceEndpoint ¶
func (client *ClientImpl) CreateServiceEndpoint(ctx context.Context, args CreateServiceEndpointArgs) (*ServiceEndpoint, error)
[Preview API] Create a service endpoint.
func (*ClientImpl) DeleteServiceEndpoint ¶
func (client *ClientImpl) DeleteServiceEndpoint(ctx context.Context, args DeleteServiceEndpointArgs) error
[Preview API] Delete a service endpoint.
func (*ClientImpl) ExecuteServiceEndpointRequest ¶
func (client *ClientImpl) ExecuteServiceEndpointRequest(ctx context.Context, args ExecuteServiceEndpointRequestArgs) (*ServiceEndpointRequestResult, error)
[Preview API] Proxy for a GET request defined by a service endpoint.
func (*ClientImpl) GetServiceEndpointDetails ¶
func (client *ClientImpl) GetServiceEndpointDetails(ctx context.Context, args GetServiceEndpointDetailsArgs) (*ServiceEndpoint, error)
[Preview API] Get the service endpoint details.
func (*ClientImpl) GetServiceEndpointExecutionRecords ¶
func (client *ClientImpl) GetServiceEndpointExecutionRecords(ctx context.Context, args GetServiceEndpointExecutionRecordsArgs) (*GetServiceEndpointExecutionRecordsResponseValue, error)
[Preview API] Get service endpoint execution records.
func (*ClientImpl) GetServiceEndpointTypes ¶
func (client *ClientImpl) GetServiceEndpointTypes(ctx context.Context, args GetServiceEndpointTypesArgs) (*[]ServiceEndpointType, error)
[Preview API] Get service endpoint types.
func (*ClientImpl) GetServiceEndpoints ¶
func (client *ClientImpl) GetServiceEndpoints(ctx context.Context, args GetServiceEndpointsArgs) (*[]ServiceEndpoint, error)
[Preview API] Get the service endpoints.
func (*ClientImpl) GetServiceEndpointsByNames ¶
func (client *ClientImpl) GetServiceEndpointsByNames(ctx context.Context, args GetServiceEndpointsByNamesArgs) (*[]ServiceEndpoint, error)
[Preview API] Get the service endpoints by name.
func (*ClientImpl) UpdateServiceEndpoint ¶
func (client *ClientImpl) UpdateServiceEndpoint(ctx context.Context, args UpdateServiceEndpointArgs) (*ServiceEndpoint, error)
[Preview API] Update a service endpoint.
func (*ClientImpl) UpdateServiceEndpoints ¶
func (client *ClientImpl) UpdateServiceEndpoints(ctx context.Context, args UpdateServiceEndpointsArgs) (*[]ServiceEndpoint, error)
[Preview API] Update the service endpoints.
type CreateServiceEndpointArgs ¶
type CreateServiceEndpointArgs struct {
// (required) Service endpoint to create.
Endpoint *ServiceEndpoint
// (required) Project ID or project name
Project *string
}
Arguments for the CreateServiceEndpoint function
type DataSource ¶
type DataSource struct {
// Gets or sets the authentication scheme for the endpoint request.
AuthenticationScheme *AuthenticationSchemeReference `json:"authenticationScheme,omitempty"`
// Gets or sets the pagination format supported by this data source(ContinuationToken/SkipTop).
CallbackContextTemplate *string `json:"callbackContextTemplate,omitempty"`
// Gets or sets the template to check if subsequent call is needed.
CallbackRequiredTemplate *string `json:"callbackRequiredTemplate,omitempty"`
// Gets or sets the endpoint url of the data source.
EndpointUrl *string `json:"endpointUrl,omitempty"`
// Gets or sets the authorization headers of the request.
Headers *[]AuthorizationHeader `json:"headers,omitempty"`
// Gets or sets the initial value of the query params.
InitialContextTemplate *string `json:"initialContextTemplate,omitempty"`
// Gets or sets the name of the data source.
Name *string `json:"name,omitempty"`
// Gets or sets the request content of the endpoint request.
RequestContent *string `json:"requestContent,omitempty"`
// Gets or sets the request method of the endpoint request.
RequestVerb *string `json:"requestVerb,omitempty"`
// Gets or sets the resource url of the endpoint request.
ResourceUrl *string `json:"resourceUrl,omitempty"`
// Gets or sets the result selector to filter the response of the endpoint request.
ResultSelector *string `json:"resultSelector,omitempty"`
}
Specifies the data sources for this endpoint.
type DataSourceBinding ¶
type DataSourceBinding struct {
// Pagination format supported by this data source(ContinuationToken/SkipTop).
CallbackContextTemplate *string `json:"callbackContextTemplate,omitempty"`
// Subsequent calls needed?
CallbackRequiredTemplate *string `json:"callbackRequiredTemplate,omitempty"`
// Gets or sets the name of the data source.
DataSourceName *string `json:"dataSourceName,omitempty"`
// Gets or sets the endpoint Id.
EndpointId *string `json:"endpointId,omitempty"`
// Gets or sets the url of the service endpoint.
EndpointUrl *string `json:"endpointUrl,omitempty"`
// Gets or sets the authorization headers.
Headers *[]distributedtaskcommon.AuthorizationHeader `json:"headers,omitempty"`
// Defines the initial value of the query params
InitialContextTemplate *string `json:"initialContextTemplate,omitempty"`
// Gets or sets the parameters for the data source.
Parameters *map[string]string `json:"parameters,omitempty"`
// Gets or sets http request body
RequestContent *string `json:"requestContent,omitempty"`
// Gets or sets http request verb
RequestVerb *string `json:"requestVerb,omitempty"`
// Gets or sets the result selector.
ResultSelector *string `json:"resultSelector,omitempty"`
// Gets or sets the result template.
ResultTemplate *string `json:"resultTemplate,omitempty"`
// Gets or sets the target of the data source.
Target *string `json:"target,omitempty"`
}
Represents the data source binding of the endpoint.
type DataSourceDetails ¶
type DataSourceDetails struct {
// Gets or sets the data source name.
DataSourceName *string `json:"dataSourceName,omitempty"`
// Gets or sets the data source url.
DataSourceUrl *string `json:"dataSourceUrl,omitempty"`
// Gets or sets the request headers.
Headers *[]AuthorizationHeader `json:"headers,omitempty"`
// Gets or sets the initialization context used for the initial call to the data source
InitialContextTemplate *string `json:"initialContextTemplate,omitempty"`
// Gets the parameters of data source.
Parameters *map[string]string `json:"parameters,omitempty"`
// Gets or sets the data source request content.
RequestContent *string `json:"requestContent,omitempty"`
// Gets or sets the data source request verb. Get/Post are the only implemented types
RequestVerb *string `json:"requestVerb,omitempty"`
// Gets or sets the resource url of data source.
ResourceUrl *string `json:"resourceUrl,omitempty"`
// Gets or sets the result selector.
ResultSelector *string `json:"resultSelector,omitempty"`
}
Represents details of the service endpoint data source.
type DeleteServiceEndpointArgs ¶
type DeleteServiceEndpointArgs struct {
// (required) Project ID or project name
Project *string
// (required) Id of the service endpoint to delete.
EndpointId *uuid.UUID
// (optional) Specific to AzureRM endpoint created in Automatic flow. When set to true, this will also delete corresponding AAD application in Azure. Default value is true.
Deep *bool
}
Arguments for the DeleteServiceEndpoint function
type DependencyBinding ¶
type DependencyBinding struct {
// Gets or sets the value of the field on which url is dependent.
Key *string `json:"key,omitempty"`
// Gets or sets the corresponding value of url.
Value *string `json:"value,omitempty"`
}
Represents the details of the input on which a given input is dependent.
type DependencyData ¶
type DependencyData struct {
// Gets or sets the category of dependency data.
Input *string `json:"input,omitempty"`
// Gets or sets the key-value pair to specify properties and their values.
Map *[]azuredevops.KeyValuePair `json:"map,omitempty"`
}
Represents the dependency data for the endpoint inputs.
type DependsOn ¶
type DependsOn struct {
// Gets or sets the ID of the field on which URL's value is dependent.
Input *string `json:"input,omitempty"`
// Gets or sets key-value pair containing other's field value and corresponding url value.
Map *[]DependencyBinding `json:"map,omitempty"`
}
Represents the inputs on which any given input is dependent.
type EndpointAuthorization ¶
type EndpointAuthorization struct {
// Gets or sets the parameters for the selected authorization scheme.
Parameters *map[string]string `json:"parameters,omitempty"`
// Gets or sets the scheme used for service endpoint authentication.
Scheme *string `json:"scheme,omitempty"`
}
Represents the authorization used for service endpoint.
type EndpointOperationStatus ¶
type EndpointUrl ¶
type EndpointUrl struct {
// Gets or sets the dependency bindings.
DependsOn *DependsOn `json:"dependsOn,omitempty"`
// Gets or sets the display name of service endpoint url.
DisplayName *string `json:"displayName,omitempty"`
// Gets or sets the help text of service endpoint url.
HelpText *string `json:"helpText,omitempty"`
// Gets or sets the visibility of service endpoint url.
IsVisible *string `json:"isVisible,omitempty"`
// Gets or sets the value of service endpoint url.
Value *string `json:"value,omitempty"`
}
Represents url of the service endpoint.
type ExecuteServiceEndpointRequestArgs ¶
type ExecuteServiceEndpointRequestArgs struct {
// (required) Service endpoint request.
ServiceEndpointRequest *ServiceEndpointRequest
// (required) Project ID or project name
Project *string
// (required) Id of the service endpoint.
EndpointId *string
}
Arguments for the ExecuteServiceEndpointRequest function
type GetServiceEndpointDetailsArgs ¶
type GetServiceEndpointDetailsArgs struct {
// (required) Project ID or project name
Project *string
// (required) Id of the service endpoint.
EndpointId *uuid.UUID
}
Arguments for the GetServiceEndpointDetails function
type GetServiceEndpointExecutionRecordsArgs ¶
type GetServiceEndpointExecutionRecordsArgs struct {
// (required) Project ID or project name
Project *string
// (required) Id of the service endpoint.
EndpointId *uuid.UUID
// (optional) Number of service endpoint execution records to get.
Top *int
// (optional) A continuation token, returned by a previous call to this method, that can be used to return the next set of records
ContinuationToken *uint64
}
Arguments for the GetServiceEndpointExecutionRecords function
type GetServiceEndpointExecutionRecordsResponseValue ¶
type GetServiceEndpointExecutionRecordsResponseValue struct {
Value []ServiceEndpointExecutionRecord
// The continuation token to be used to get the next page of results.
ContinuationToken string
}
Return type for the GetServiceEndpointExecutionRecords function
type GetServiceEndpointTypesArgs ¶
type GetServiceEndpointTypesArgs struct {
// (optional) Type of service endpoint.
Type *string
// (optional) Scheme of service endpoint.
Scheme *string
}
Arguments for the GetServiceEndpointTypes function
type GetServiceEndpointsArgs ¶
type GetServiceEndpointsArgs struct {
// (required) Project ID or project name
Project *string
// (optional) Type of the service endpoints.
Type *string
// (optional) Authorization schemes used for service endpoints.
AuthSchemes *[]string
// (optional) Ids of the service endpoints.
EndpointIds *[]uuid.UUID
// (optional) Owner for service endpoints.
Owner *string
// (optional) Failed flag for service endpoints.
IncludeFailed *bool
// (optional) 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
IncludeDetails *bool
}
Arguments for the GetServiceEndpoints function
type GetServiceEndpointsByNamesArgs ¶
type GetServiceEndpointsByNamesArgs struct {
// (required) Project ID or project name
Project *string
// (required) Names of the service endpoints.
EndpointNames *[]string
// (optional) Type of the service endpoints.
Type *string
// (optional) Authorization schemes used for service endpoints.
AuthSchemes *[]string
// (optional) Owner for service endpoints.
Owner *string
// (optional) Failed flag for service endpoints.
IncludeFailed *bool
// (optional) 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
IncludeDetails *bool
}
Arguments for the GetServiceEndpointsByNames function
type HelpLink ¶
type HelpLink struct {
// Gets or sets the help text.
Text *string `json:"text,omitempty"`
// Gets or sets the public url of the help documentation.
Url *string `json:"url,omitempty"`
}
Specifies the public url of the help documentation.
type OAuth2TokenResult ¶
type OAuth2TokenResult struct {
AccessToken *string `json:"accessToken,omitempty"`
Error *string `json:"error,omitempty"`
ErrorDescription *string `json:"errorDescription,omitempty"`
ExpiresIn *string `json:"expiresIn,omitempty"`
IssuedAt *string `json:"issuedAt,omitempty"`
RefreshToken *string `json:"refreshToken,omitempty"`
Scope *string `json:"scope,omitempty"`
}
type OAuthConfiguration ¶
type OAuthConfiguration struct {
// Gets or sets the ClientId
ClientId *string `json:"clientId,omitempty"`
// Gets or sets the ClientSecret
ClientSecret *string `json:"clientSecret,omitempty"`
// Gets or sets the identity who created the config.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
// Gets or sets the time when config was created.
CreatedOn *azuredevops.Time `json:"createdOn,omitempty"`
// Gets or sets the type of the endpoint.
EndpointType *string `json:"endpointType,omitempty"`
// Gets or sets the unique identifier of this field
Id *uuid.UUID `json:"id,omitempty"`
// Gets or sets the identity who modified the config.
ModifiedBy *webapi.IdentityRef `json:"modifiedBy,omitempty"`
// Gets or sets the time when variable group was modified
ModifiedOn *azuredevops.Time `json:"modifiedOn,omitempty"`
// Gets or sets the name
Name *string `json:"name,omitempty"`
// Gets or sets the Url
Url *string `json:"url,omitempty"`
}
type OAuthConfigurationParams ¶
type OAuthConfigurationParams struct {
// Gets or sets the ClientId
ClientId *string `json:"clientId,omitempty"`
// Gets or sets the ClientSecret
ClientSecret *string `json:"clientSecret,omitempty"`
// Gets or sets the type of the endpoint.
EndpointType *string `json:"endpointType,omitempty"`
// Gets or sets the name
Name *string `json:"name,omitempty"`
// Gets or sets the Url
Url *string `json:"url,omitempty"`
}
type OAuthEndpointStatus ¶
type ProjectReference ¶
type ResultTransformationDetails ¶
type ResultTransformationDetails struct {
// Gets or sets the template for callback parameters
CallbackContextTemplate *string `json:"callbackContextTemplate,omitempty"`
// Gets or sets the template to decide whether to callback or not
CallbackRequiredTemplate *string `json:"callbackRequiredTemplate,omitempty"`
// Gets or sets the template for result transformation.
ResultTemplate *string `json:"resultTemplate,omitempty"`
}
Represents template to transform the result data.
type ServiceEndpoint ¶
type ServiceEndpoint struct {
// Gets or sets the identity reference for the administrators group of the service endpoint.
AdministratorsGroup *webapi.IdentityRef `json:"administratorsGroup,omitempty"`
// Gets or sets the authorization data for talking to the endpoint.
Authorization *EndpointAuthorization `json:"authorization,omitempty"`
// Gets or sets the identity reference for the user who created the Service endpoint.
CreatedBy *webapi.IdentityRef `json:"createdBy,omitempty"`
Data *map[string]string `json:"data,omitempty"`
// Gets or sets the description of endpoint.
Description *string `json:"description,omitempty"`
// This is a deprecated field.
GroupScopeId *uuid.UUID `json:"groupScopeId,omitempty"`
// Gets or sets the identifier of this endpoint.
Id *uuid.UUID `json:"id,omitempty"`
// EndPoint state indicator
IsReady *bool `json:"isReady,omitempty"`
IsShared *bool `json:"isShared,omitempty"`
// Gets or sets the friendly name of the endpoint.
Name *string `json:"name,omitempty"`
// Error message during creation/deletion of endpoint
OperationStatus interface{} `json:"operationStatus,omitempty"`
// Owner of the endpoint Supported values are "library", "agentcloud"
Owner *string `json:"owner,omitempty"`
// Gets or sets the identity reference for the readers group of the service endpoint.
ReadersGroup *webapi.IdentityRef `json:"readersGroup,omitempty"`
// Gets or sets the type of the endpoint.
Type *string `json:"type,omitempty"`
// Gets or sets the url of the endpoint.
Url *string `json:"url,omitempty"`
}
Represents an endpoint which may be used by an orchestration job.
type ServiceEndpointAuthenticationScheme ¶
type ServiceEndpointAuthenticationScheme struct {
// Gets or sets the authorization headers of service endpoint authentication scheme.
AuthorizationHeaders *[]AuthorizationHeader `json:"authorizationHeaders,omitempty"`
// Gets or sets the Authorization url required to authenticate using OAuth2
AuthorizationUrl *string `json:"authorizationUrl,omitempty"`
// Gets or sets the certificates of service endpoint authentication scheme.
ClientCertificates *[]ClientCertificate `json:"clientCertificates,omitempty"`
// Gets or sets the data source bindings of the endpoint.
DataSourceBindings *[]DataSourceBinding `json:"dataSourceBindings,omitempty"`
// Gets or sets the display name for the service endpoint authentication scheme.
DisplayName *string `json:"displayName,omitempty"`
// Gets or sets the input descriptors for the service endpoint authentication scheme.
InputDescriptors *[]forminput.InputDescriptor `json:"inputDescriptors,omitempty"`
// Gets or sets the scheme for service endpoint authentication.
Scheme *string `json:"scheme,omitempty"`
}
Represents the authentication scheme used to authenticate the endpoint.
type ServiceEndpointDetails ¶
type ServiceEndpointDetails struct {
// Gets or sets the authorization of service endpoint.
Authorization *EndpointAuthorization `json:"authorization,omitempty"`
// Gets or sets the data of service endpoint.
Data *map[string]string `json:"data,omitempty"`
// Gets or sets the type of service endpoint.
Type *string `json:"type,omitempty"`
// Gets or sets the connection url of service endpoint.
Url *string `json:"url,omitempty"`
}
Represents details of the service endpoint.
type ServiceEndpointExecutionData ¶
type ServiceEndpointExecutionData struct {
// Gets the definition of service endpoint execution owner.
Definition *ServiceEndpointExecutionOwner `json:"definition,omitempty"`
// Gets the finish time of service endpoint execution.
FinishTime *azuredevops.Time `json:"finishTime,omitempty"`
// Gets the Id of service endpoint execution data.
Id *uint64 `json:"id,omitempty"`
// Gets the owner of service endpoint execution data.
Owner *ServiceEndpointExecutionOwner `json:"owner,omitempty"`
// Gets the plan type of service endpoint execution data.
PlanType *string `json:"planType,omitempty"`
// Gets the result of service endpoint execution.
Result *ServiceEndpointExecutionResult `json:"result,omitempty"`
// Gets the start time of service endpoint execution.
StartTime *azuredevops.Time `json:"startTime,omitempty"`
}
Represents service endpoint execution data.
type ServiceEndpointExecutionOwner ¶
type ServiceEndpointExecutionOwner struct {
Links interface{} `json:"_links,omitempty"`
// Gets or sets the Id of service endpoint execution owner.
Id *int `json:"id,omitempty"`
// Gets or sets the name of service endpoint execution owner.
Name *string `json:"name,omitempty"`
}
Represents execution owner of the service endpoint.
type ServiceEndpointExecutionRecord ¶
type ServiceEndpointExecutionRecord struct {
// Gets the execution data of service endpoint execution.
Data *ServiceEndpointExecutionData `json:"data,omitempty"`
// Gets the Id of service endpoint.
EndpointId *uuid.UUID `json:"endpointId,omitempty"`
}
Represents the details of service endpoint execution.
type ServiceEndpointExecutionRecordsInput ¶
type ServiceEndpointExecutionRecordsInput struct {
Data *ServiceEndpointExecutionData `json:"data,omitempty"`
EndpointIds *[]uuid.UUID `json:"endpointIds,omitempty"`
}
type ServiceEndpointExecutionResult ¶
type ServiceEndpointExecutionResult string
type ServiceEndpointRequest ¶
type ServiceEndpointRequest struct {
// Gets or sets the data source details for the service endpoint request.
DataSourceDetails *DataSourceDetails `json:"dataSourceDetails,omitempty"`
// Gets or sets the result transformation details for the service endpoint request.
ResultTransformationDetails *ResultTransformationDetails `json:"resultTransformationDetails,omitempty"`
// Gets or sets the service endpoint details for the service endpoint request.
ServiceEndpointDetails *ServiceEndpointDetails `json:"serviceEndpointDetails,omitempty"`
}
type ServiceEndpointRequestResult ¶
type ServiceEndpointRequestResult struct {
// Gets or sets the parameters used to make subsequent calls to the data source
CallbackContextParameters *map[string]string `json:"callbackContextParameters,omitempty"`
// Gets or sets the flat that decides if another call to the data source is to be made
CallbackRequired *bool `json:"callbackRequired,omitempty"`
// Gets or sets the error message of the service endpoint request result.
ErrorMessage *string `json:"errorMessage,omitempty"`
// Gets or sets the result of service endpoint request.
Result interface{} `json:"result,omitempty"`
// Gets or sets the status code of the service endpoint request result.
StatusCode *string `json:"statusCode,omitempty"`
}
Represents result of the service endpoint request.
type ServiceEndpointType ¶
type ServiceEndpointType struct {
// Authentication scheme of service endpoint type.
AuthenticationSchemes *[]ServiceEndpointAuthenticationScheme `json:"authenticationSchemes,omitempty"`
// Data sources of service endpoint type.
DataSources *[]DataSource `json:"dataSources,omitempty"`
// Dependency data of service endpoint type.
DependencyData *[]DependencyData `json:"dependencyData,omitempty"`
// Gets or sets the description of service endpoint type.
Description *string `json:"description,omitempty"`
// Gets or sets the display name of service endpoint type.
DisplayName *string `json:"displayName,omitempty"`
// Gets or sets the endpoint url of service endpoint type.
EndpointUrl *EndpointUrl `json:"endpointUrl,omitempty"`
// Gets or sets the help link of service endpoint type.
HelpLink *HelpLink `json:"helpLink,omitempty"`
// Gets or sets the help text shown at the endpoint create dialog.
HelpMarkDown *string `json:"helpMarkDown,omitempty"`
// Gets or sets the icon url of service endpoint type.
IconUrl *string `json:"iconUrl,omitempty"`
// Input descriptor of service endpoint type.
InputDescriptors *[]forminput.InputDescriptor `json:"inputDescriptors,omitempty"`
// Gets or sets the name of service endpoint type.
Name *string `json:"name,omitempty"`
// Trusted hosts of a service endpoint type.
TrustedHosts *[]string `json:"trustedHosts,omitempty"`
// Gets or sets the ui contribution id of service endpoint type.
UiContributionId *string `json:"uiContributionId,omitempty"`
}
Represents type of the service endpoint.
type UpdateServiceEndpointArgs ¶
type UpdateServiceEndpointArgs struct {
// (required) Service endpoint to update.
Endpoint *ServiceEndpoint
// (required) Project ID or project name
Project *string
// (required) Id of the service endpoint to update.
EndpointId *uuid.UUID
// (optional) Operation for the service endpoint.
Operation *string
}
Arguments for the UpdateServiceEndpoint function
type UpdateServiceEndpointsArgs ¶
type UpdateServiceEndpointsArgs struct {
// (required) Names of the service endpoints to update.
Endpoints *[]ServiceEndpoint
// (required) Project ID or project name
Project *string
}
Arguments for the UpdateServiceEndpoints function