Documentation ¶
Overview ¶
Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devops/armdevops(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/devops/armdevops). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.
Package devops implements the Azure ARM Devops service API version 2019-07-01-preview.
Azure DevOps Resource Provider
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type Authorization
- type BaseClient
- type BootstrapConfiguration
- type CloudError
- type CloudErrorBody
- type CodeRepository
- type CodeRepositoryType
- type InputDataType
- type InputDescriptor
- type InputValue
- type Operation
- type OperationDisplayValue
- type OperationListResult
- type OperationListResultIterator
- func (iter *OperationListResultIterator) Next() error
- func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter OperationListResultIterator) NotDone() bool
- func (iter OperationListResultIterator) Response() OperationListResult
- func (iter OperationListResultIterator) Value() Operation
- type OperationListResultPage
- func (page *OperationListResultPage) Next() error
- func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page OperationListResultPage) NotDone() bool
- func (page OperationListResultPage) Response() OperationListResult
- func (page OperationListResultPage) Values() []Operation
- type OperationsClient
- func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
- func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
- func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
- func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
- type OrganizationReference
- type Pipeline
- type PipelineListResult
- type PipelineListResultIterator
- func (iter *PipelineListResultIterator) Next() error
- func (iter *PipelineListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter PipelineListResultIterator) NotDone() bool
- func (iter PipelineListResultIterator) Response() PipelineListResult
- func (iter PipelineListResultIterator) Value() Pipeline
- type PipelineListResultPage
- func (page *PipelineListResultPage) Next() error
- func (page *PipelineListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page PipelineListResultPage) NotDone() bool
- func (page PipelineListResultPage) Response() PipelineListResult
- func (page PipelineListResultPage) Values() []Pipeline
- type PipelineProperties
- type PipelineTemplate
- type PipelineTemplateDefinition
- type PipelineTemplateDefinitionListResult
- type PipelineTemplateDefinitionListResultIterator
- func (iter *PipelineTemplateDefinitionListResultIterator) Next() error
- func (iter *PipelineTemplateDefinitionListResultIterator) NextWithContext(ctx context.Context) (err error)
- func (iter PipelineTemplateDefinitionListResultIterator) NotDone() bool
- func (iter PipelineTemplateDefinitionListResultIterator) Response() PipelineTemplateDefinitionListResult
- func (iter PipelineTemplateDefinitionListResultIterator) Value() PipelineTemplateDefinition
- type PipelineTemplateDefinitionListResultPage
- func (page *PipelineTemplateDefinitionListResultPage) Next() error
- func (page *PipelineTemplateDefinitionListResultPage) NextWithContext(ctx context.Context) (err error)
- func (page PipelineTemplateDefinitionListResultPage) NotDone() bool
- func (page PipelineTemplateDefinitionListResultPage) Response() PipelineTemplateDefinitionListResult
- func (page PipelineTemplateDefinitionListResultPage) Values() []PipelineTemplateDefinition
- type PipelineTemplateDefinitionsClient
- func (client PipelineTemplateDefinitionsClient) List(ctx context.Context) (result PipelineTemplateDefinitionListResultPage, err error)
- func (client PipelineTemplateDefinitionsClient) ListComplete(ctx context.Context) (result PipelineTemplateDefinitionListResultIterator, err error)
- func (client PipelineTemplateDefinitionsClient) ListPreparer(ctx context.Context) (*http.Request, error)
- func (client PipelineTemplateDefinitionsClient) ListResponder(resp *http.Response) (result PipelineTemplateDefinitionListResult, err error)
- func (client PipelineTemplateDefinitionsClient) ListSender(req *http.Request) (*http.Response, error)
- type PipelineUpdateParameters
- type PipelinesClient
- func (client PipelinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, pipelineName string, ...) (result PipelinesCreateOrUpdateFuture, err error)
- func (client PipelinesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, pipelineName string, ...) (*http.Request, error)
- func (client PipelinesClient) CreateOrUpdateResponder(resp *http.Response) (result Pipeline, err error)
- func (client PipelinesClient) CreateOrUpdateSender(req *http.Request) (future PipelinesCreateOrUpdateFuture, err error)
- func (client PipelinesClient) Delete(ctx context.Context, resourceGroupName string, pipelineName string) (result autorest.Response, err error)
- func (client PipelinesClient) DeletePreparer(ctx context.Context, resourceGroupName string, pipelineName string) (*http.Request, error)
- func (client PipelinesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client PipelinesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client PipelinesClient) Get(ctx context.Context, resourceGroupName string, pipelineName string) (result Pipeline, err error)
- func (client PipelinesClient) GetPreparer(ctx context.Context, resourceGroupName string, pipelineName string) (*http.Request, error)
- func (client PipelinesClient) GetResponder(resp *http.Response) (result Pipeline, err error)
- func (client PipelinesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client PipelinesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result PipelineListResultPage, err error)
- func (client PipelinesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result PipelineListResultIterator, err error)
- func (client PipelinesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client PipelinesClient) ListByResourceGroupResponder(resp *http.Response) (result PipelineListResult, err error)
- func (client PipelinesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client PipelinesClient) ListBySubscription(ctx context.Context) (result PipelineListResultPage, err error)
- func (client PipelinesClient) ListBySubscriptionComplete(ctx context.Context) (result PipelineListResultIterator, err error)
- func (client PipelinesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
- func (client PipelinesClient) ListBySubscriptionResponder(resp *http.Response) (result PipelineListResult, err error)
- func (client PipelinesClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)
- func (client PipelinesClient) Update(ctx context.Context, resourceGroupName string, pipelineName string, ...) (result Pipeline, err error)
- func (client PipelinesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, pipelineName string, ...) (*http.Request, error)
- func (client PipelinesClient) UpdateResponder(resp *http.Response) (result Pipeline, err error)
- func (client PipelinesClient) UpdateSender(req *http.Request) (*http.Response, error)
- type PipelinesCreateOrUpdateFuture
- type ProjectReference
- type Resource
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Devops
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type Authorization ¶
type Authorization struct { // AuthorizationType - Type of authorization. AuthorizationType *string `json:"authorizationType,omitempty"` // Parameters - Authorization parameters corresponding to the authorization type. Parameters map[string]*string `json:"parameters"` }
Authorization authorization info used to access a resource (like code repository).
func (Authorization) MarshalJSON ¶
func (a Authorization) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Authorization.
type BaseClient ¶
BaseClient is the base client for Devops.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
type BootstrapConfiguration ¶
type BootstrapConfiguration struct { // Repository - Repository containing the source code for the pipeline. Repository *CodeRepository `json:"repository,omitempty"` // Template - Template used to bootstrap the pipeline. Template *PipelineTemplate `json:"template,omitempty"` }
BootstrapConfiguration configuration used to bootstrap a Pipeline.
type CloudError ¶
type CloudError struct { // Error - Details of the error from the Pipelines Resource Provider. Error *CloudErrorBody `json:"error,omitempty"` }
CloudError an error response from the Pipelines Resource Provider.
type CloudErrorBody ¶
type CloudErrorBody struct { // Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically. Code *string `json:"code,omitempty"` // Message - A message describing the error, intended to be suitable for display in a user interface. Message *string `json:"message,omitempty"` // Target - The target of the particular error. For example, the name of the property in error or the method where the error occurred. Target *string `json:"target,omitempty"` // Details - A list of additional details about the error. Details *[]CloudErrorBody `json:"details,omitempty"` }
CloudErrorBody an error response from the Pipelines Resource Provider.
type CodeRepository ¶
type CodeRepository struct { // RepositoryType - Type of code repository. Possible values include: 'GitHub', 'VstsGit' RepositoryType CodeRepositoryType `json:"repositoryType,omitempty"` // ID - Unique immutable identifier of the code repository. ID *string `json:"id,omitempty"` // DefaultBranch - Default branch used to configure Continuous Integration (CI) in the pipeline. DefaultBranch *string `json:"defaultBranch,omitempty"` // Authorization - Authorization info to access the code repository. Authorization *Authorization `json:"authorization,omitempty"` // Properties - Repository-specific properties. Properties map[string]*string `json:"properties"` }
CodeRepository repository containing the source code for a pipeline.
func (CodeRepository) MarshalJSON ¶
func (cr CodeRepository) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CodeRepository.
type CodeRepositoryType ¶
type CodeRepositoryType string
CodeRepositoryType enumerates the values for code repository type.
const ( // GitHub ... GitHub CodeRepositoryType = "gitHub" // VstsGit ... VstsGit CodeRepositoryType = "vstsGit" )
func PossibleCodeRepositoryTypeValues ¶
func PossibleCodeRepositoryTypeValues() []CodeRepositoryType
PossibleCodeRepositoryTypeValues returns an array of possible values for the CodeRepositoryType const type.
type InputDataType ¶
type InputDataType string
InputDataType enumerates the values for input data type.
const ( // InputDataTypeAuthorization ... InputDataTypeAuthorization InputDataType = "Authorization" // InputDataTypeBool ... InputDataTypeBool InputDataType = "Bool" // InputDataTypeInt ... InputDataTypeInt InputDataType = "Int" // InputDataTypeSecureString ... InputDataTypeSecureString InputDataType = "SecureString" // InputDataTypeString ... InputDataTypeString InputDataType = "String" )
func PossibleInputDataTypeValues ¶
func PossibleInputDataTypeValues() []InputDataType
PossibleInputDataTypeValues returns an array of possible values for the InputDataType const type.
type InputDescriptor ¶
type InputDescriptor struct { // ID - Identifier of the input parameter. ID *string `json:"id,omitempty"` // Description - Description of the input parameter. Description *string `json:"description,omitempty"` // Type - Data type of the value of the input parameter. Possible values include: 'InputDataTypeString', 'InputDataTypeSecureString', 'InputDataTypeInt', 'InputDataTypeBool', 'InputDataTypeAuthorization' Type InputDataType `json:"type,omitempty"` // PossibleValues - List of possible values for the input parameter. PossibleValues *[]InputValue `json:"possibleValues,omitempty"` }
InputDescriptor representation of a pipeline template input parameter.
type InputValue ¶
type InputValue struct { // Value - Value of an input parameter. Value *string `json:"value,omitempty"` // DisplayValue - Description of the input parameter value. DisplayValue *string `json:"displayValue,omitempty"` }
InputValue representation of a pipeline template input parameter value.
type Operation ¶
type Operation struct { // Name - READ-ONLY; Name of the operation. Name *string `json:"name,omitempty"` // IsDataAction - Indicates whether the operation applies to data-plane. IsDataAction *string `json:"isDataAction,omitempty"` // OperationDisplayValue - Display information of the operation. *OperationDisplayValue `json:"display,omitempty"` }
Operation properties of an Operation.
func (Operation) MarshalJSON ¶
MarshalJSON is the custom marshaler for Operation.
func (*Operation) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Operation struct.
type OperationDisplayValue ¶
type OperationDisplayValue struct { // Operation - READ-ONLY; Friendly name of the operation. Operation *string `json:"operation,omitempty"` // Resource - READ-ONLY; Friendly name of the resource type the operation applies to. Resource *string `json:"resource,omitempty"` // Description - READ-ONLY; Friendly description of the operation. Description *string `json:"description,omitempty"` // Provider - READ-ONLY; Friendly name of the resource provider. Provider *string `json:"provider,omitempty"` }
OperationDisplayValue display information of an operation.
func (OperationDisplayValue) MarshalJSON ¶
func (odv OperationDisplayValue) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationDisplayValue.
type OperationListResult ¶
type OperationListResult struct { autorest.Response `json:"-"` // Value - READ-ONLY; List of operations supported by Microsoft.DevOps resource provider. Value *[]Operation `json:"value,omitempty"` // NextLink - The URL to get the next set of operations, if there are any. NextLink *string `json:"nextLink,omitempty"` }
OperationListResult result of a request to list all operations supported by Microsoft.DevOps resource provider.
func (OperationListResult) IsEmpty ¶
func (olr OperationListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
func (OperationListResult) MarshalJSON ¶
func (olr OperationListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OperationListResult.
type OperationListResultIterator ¶
type OperationListResultIterator struct {
// contains filtered or unexported fields
}
OperationListResultIterator provides access to a complete listing of Operation values.
func NewOperationListResultIterator ¶
func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator
Creates a new instance of the OperationListResultIterator type.
func (*OperationListResultIterator) Next ¶
func (iter *OperationListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListResultIterator) NextWithContext ¶
func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (OperationListResultIterator) NotDone ¶
func (iter OperationListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (OperationListResultIterator) Response ¶
func (iter OperationListResultIterator) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultIterator) Value ¶
func (iter OperationListResultIterator) Value() Operation
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type OperationListResultPage ¶
type OperationListResultPage struct {
// contains filtered or unexported fields
}
OperationListResultPage contains a page of Operation values.
func NewOperationListResultPage ¶
func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage
Creates a new instance of the OperationListResultPage type.
func (*OperationListResultPage) Next ¶
func (page *OperationListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*OperationListResultPage) NextWithContext ¶
func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (OperationListResultPage) NotDone ¶
func (page OperationListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (OperationListResultPage) Response ¶
func (page OperationListResultPage) Response() OperationListResult
Response returns the raw server response from the last page request.
func (OperationListResultPage) Values ¶
func (page OperationListResultPage) Values() []Operation
Values returns the slice of values for the current page or nil if there are no values.
type OperationsClient ¶
type OperationsClient struct {
BaseClient
}
OperationsClient is the azure DevOps Resource Provider
func NewOperationsClient ¶
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
func NewOperationsClientWithBaseURI ¶
func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (OperationsClient) List ¶
func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)
List lists all the operations supported by Microsoft.DevOps resource provider.
func (OperationsClient) ListComplete ¶
func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (OperationsClient) ListPreparer ¶
ListPreparer prepares the List request.
func (OperationsClient) ListResponder ¶
func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (OperationsClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type OrganizationReference ¶
type OrganizationReference struct { // ID - READ-ONLY; Unique immutable identifier for the Azure DevOps Organization. ID *string `json:"id,omitempty"` // Name - Name of the Azure DevOps Organization. Name *string `json:"name,omitempty"` }
OrganizationReference reference to an Azure DevOps Organization.
func (OrganizationReference) MarshalJSON ¶
func (or OrganizationReference) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OrganizationReference.
type Pipeline ¶
type Pipeline struct { autorest.Response `json:"-"` // PipelineProperties - Custom properties of the Pipeline. *PipelineProperties `json:"properties,omitempty"` // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Type - READ-ONLY; Resource Type Type *string `json:"type,omitempty"` // Tags - Resource Tags Tags map[string]*string `json:"tags"` // Location - Resource Location Location *string `json:"location,omitempty"` // Name - READ-ONLY; Resource Name Name *string `json:"name,omitempty"` }
Pipeline azure DevOps Pipeline used to configure Continuous Integration (CI) & Continuous Delivery (CD) for Azure resources.
func (Pipeline) MarshalJSON ¶
MarshalJSON is the custom marshaler for Pipeline.
func (*Pipeline) UnmarshalJSON ¶
UnmarshalJSON is the custom unmarshaler for Pipeline struct.
type PipelineListResult ¶
type PipelineListResult struct { autorest.Response `json:"-"` // Value - List of pipelines. Value *[]Pipeline `json:"value,omitempty"` // NextLink - URL to get the next set of Pipelines, if there are any. NextLink *string `json:"nextLink,omitempty"` }
PipelineListResult result of a request to list all Azure Pipelines under a given scope.
func (PipelineListResult) IsEmpty ¶
func (plr PipelineListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type PipelineListResultIterator ¶
type PipelineListResultIterator struct {
// contains filtered or unexported fields
}
PipelineListResultIterator provides access to a complete listing of Pipeline values.
func NewPipelineListResultIterator ¶
func NewPipelineListResultIterator(page PipelineListResultPage) PipelineListResultIterator
Creates a new instance of the PipelineListResultIterator type.
func (*PipelineListResultIterator) Next ¶
func (iter *PipelineListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*PipelineListResultIterator) NextWithContext ¶
func (iter *PipelineListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (PipelineListResultIterator) NotDone ¶
func (iter PipelineListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (PipelineListResultIterator) Response ¶
func (iter PipelineListResultIterator) Response() PipelineListResult
Response returns the raw server response from the last page request.
func (PipelineListResultIterator) Value ¶
func (iter PipelineListResultIterator) Value() Pipeline
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type PipelineListResultPage ¶
type PipelineListResultPage struct {
// contains filtered or unexported fields
}
PipelineListResultPage contains a page of Pipeline values.
func NewPipelineListResultPage ¶
func NewPipelineListResultPage(cur PipelineListResult, getNextPage func(context.Context, PipelineListResult) (PipelineListResult, error)) PipelineListResultPage
Creates a new instance of the PipelineListResultPage type.
func (*PipelineListResultPage) Next ¶
func (page *PipelineListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*PipelineListResultPage) NextWithContext ¶
func (page *PipelineListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (PipelineListResultPage) NotDone ¶
func (page PipelineListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (PipelineListResultPage) Response ¶
func (page PipelineListResultPage) Response() PipelineListResult
Response returns the raw server response from the last page request.
func (PipelineListResultPage) Values ¶
func (page PipelineListResultPage) Values() []Pipeline
Values returns the slice of values for the current page or nil if there are no values.
type PipelineProperties ¶
type PipelineProperties struct { // PipelineID - READ-ONLY; Unique identifier of the Azure Pipeline within the Azure DevOps Project. PipelineID *int32 `json:"pipelineId,omitempty"` // Organization - Reference to the Azure DevOps Organization containing the Pipeline. Organization *OrganizationReference `json:"organization,omitempty"` // Project - Reference to the Azure DevOps Project containing the Pipeline. Project *ProjectReference `json:"project,omitempty"` // BootstrapConfiguration - Configuration used to bootstrap the Pipeline. BootstrapConfiguration *BootstrapConfiguration `json:"bootstrapConfiguration,omitempty"` }
PipelineProperties custom properties of a Pipeline.
func (PipelineProperties) MarshalJSON ¶
func (pp PipelineProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PipelineProperties.
type PipelineTemplate ¶
type PipelineTemplate struct { // ID - Unique identifier of the pipeline template. ID *string `json:"id,omitempty"` // Parameters - Dictionary of input parameters used in the pipeline template. Parameters map[string]*string `json:"parameters"` }
PipelineTemplate template used to bootstrap the pipeline.
func (PipelineTemplate) MarshalJSON ¶
func (pt PipelineTemplate) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PipelineTemplate.
type PipelineTemplateDefinition ¶
type PipelineTemplateDefinition struct { // ID - Unique identifier of the pipeline template. ID *string `json:"id,omitempty"` // Description - Description of the pipeline enabled by the template. Description *string `json:"description,omitempty"` // Inputs - List of input parameters required by the template to create a pipeline. Inputs *[]InputDescriptor `json:"inputs,omitempty"` }
PipelineTemplateDefinition definition of a pipeline template.
type PipelineTemplateDefinitionListResult ¶
type PipelineTemplateDefinitionListResult struct { autorest.Response `json:"-"` // Value - List of pipeline template definitions. Value *[]PipelineTemplateDefinition `json:"value,omitempty"` // NextLink - The URL to get the next set of pipeline template definitions, if there are any. NextLink *string `json:"nextLink,omitempty"` }
PipelineTemplateDefinitionListResult result of a request to list all pipeline template definitions.
func (PipelineTemplateDefinitionListResult) IsEmpty ¶
func (ptdlr PipelineTemplateDefinitionListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
type PipelineTemplateDefinitionListResultIterator ¶
type PipelineTemplateDefinitionListResultIterator struct {
// contains filtered or unexported fields
}
PipelineTemplateDefinitionListResultIterator provides access to a complete listing of PipelineTemplateDefinition values.
func NewPipelineTemplateDefinitionListResultIterator ¶
func NewPipelineTemplateDefinitionListResultIterator(page PipelineTemplateDefinitionListResultPage) PipelineTemplateDefinitionListResultIterator
Creates a new instance of the PipelineTemplateDefinitionListResultIterator type.
func (*PipelineTemplateDefinitionListResultIterator) Next ¶
func (iter *PipelineTemplateDefinitionListResultIterator) Next() error
Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*PipelineTemplateDefinitionListResultIterator) NextWithContext ¶
func (iter *PipelineTemplateDefinitionListResultIterator) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.
func (PipelineTemplateDefinitionListResultIterator) NotDone ¶
func (iter PipelineTemplateDefinitionListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (PipelineTemplateDefinitionListResultIterator) Response ¶
func (iter PipelineTemplateDefinitionListResultIterator) Response() PipelineTemplateDefinitionListResult
Response returns the raw server response from the last page request.
func (PipelineTemplateDefinitionListResultIterator) Value ¶
func (iter PipelineTemplateDefinitionListResultIterator) Value() PipelineTemplateDefinition
Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.
type PipelineTemplateDefinitionListResultPage ¶
type PipelineTemplateDefinitionListResultPage struct {
// contains filtered or unexported fields
}
PipelineTemplateDefinitionListResultPage contains a page of PipelineTemplateDefinition values.
func NewPipelineTemplateDefinitionListResultPage ¶
func NewPipelineTemplateDefinitionListResultPage(cur PipelineTemplateDefinitionListResult, getNextPage func(context.Context, PipelineTemplateDefinitionListResult) (PipelineTemplateDefinitionListResult, error)) PipelineTemplateDefinitionListResultPage
Creates a new instance of the PipelineTemplateDefinitionListResultPage type.
func (*PipelineTemplateDefinitionListResultPage) Next ¶
func (page *PipelineTemplateDefinitionListResultPage) Next() error
Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.
func (*PipelineTemplateDefinitionListResultPage) NextWithContext ¶
func (page *PipelineTemplateDefinitionListResultPage) NextWithContext(ctx context.Context) (err error)
NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.
func (PipelineTemplateDefinitionListResultPage) NotDone ¶
func (page PipelineTemplateDefinitionListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (PipelineTemplateDefinitionListResultPage) Response ¶
func (page PipelineTemplateDefinitionListResultPage) Response() PipelineTemplateDefinitionListResult
Response returns the raw server response from the last page request.
func (PipelineTemplateDefinitionListResultPage) Values ¶
func (page PipelineTemplateDefinitionListResultPage) Values() []PipelineTemplateDefinition
Values returns the slice of values for the current page or nil if there are no values.
type PipelineTemplateDefinitionsClient ¶
type PipelineTemplateDefinitionsClient struct {
BaseClient
}
PipelineTemplateDefinitionsClient is the azure DevOps Resource Provider
func NewPipelineTemplateDefinitionsClient ¶
func NewPipelineTemplateDefinitionsClient(subscriptionID string) PipelineTemplateDefinitionsClient
NewPipelineTemplateDefinitionsClient creates an instance of the PipelineTemplateDefinitionsClient client.
func NewPipelineTemplateDefinitionsClientWithBaseURI ¶
func NewPipelineTemplateDefinitionsClientWithBaseURI(baseURI string, subscriptionID string) PipelineTemplateDefinitionsClient
NewPipelineTemplateDefinitionsClientWithBaseURI creates an instance of the PipelineTemplateDefinitionsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (PipelineTemplateDefinitionsClient) List ¶
func (client PipelineTemplateDefinitionsClient) List(ctx context.Context) (result PipelineTemplateDefinitionListResultPage, err error)
List lists all pipeline templates which can be used to configure an Azure Pipeline.
func (PipelineTemplateDefinitionsClient) ListComplete ¶
func (client PipelineTemplateDefinitionsClient) ListComplete(ctx context.Context) (result PipelineTemplateDefinitionListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (PipelineTemplateDefinitionsClient) ListPreparer ¶
func (client PipelineTemplateDefinitionsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
func (PipelineTemplateDefinitionsClient) ListResponder ¶
func (client PipelineTemplateDefinitionsClient) ListResponder(resp *http.Response) (result PipelineTemplateDefinitionListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (PipelineTemplateDefinitionsClient) ListSender ¶
func (client PipelineTemplateDefinitionsClient) ListSender(req *http.Request) (*http.Response, error)
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type PipelineUpdateParameters ¶
type PipelineUpdateParameters struct { // Tags - Dictionary of key-value pairs to be set as tags on the Azure Pipeline. This will overwrite any existing tags. Tags map[string]*string `json:"tags"` }
PipelineUpdateParameters request payload used to update an existing Azure Pipeline.
func (PipelineUpdateParameters) MarshalJSON ¶
func (pup PipelineUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for PipelineUpdateParameters.
type PipelinesClient ¶
type PipelinesClient struct {
BaseClient
}
PipelinesClient is the azure DevOps Resource Provider
func NewPipelinesClient ¶
func NewPipelinesClient(subscriptionID string) PipelinesClient
NewPipelinesClient creates an instance of the PipelinesClient client.
func NewPipelinesClientWithBaseURI ¶
func NewPipelinesClientWithBaseURI(baseURI string, subscriptionID string) PipelinesClient
NewPipelinesClientWithBaseURI creates an instance of the PipelinesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).
func (PipelinesClient) CreateOrUpdate ¶
func (client PipelinesClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, pipelineName string, createOperationParameters Pipeline) (result PipelinesCreateOrUpdateFuture, err error)
CreateOrUpdate creates or updates an Azure Pipeline. Parameters: resourceGroupName - name of the resource group within the Azure subscription. pipelineName - the name of the Azure Pipeline resource in ARM. createOperationParameters - the request payload to create the Azure Pipeline.
func (PipelinesClient) CreateOrUpdatePreparer ¶
func (client PipelinesClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, pipelineName string, createOperationParameters Pipeline) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (PipelinesClient) CreateOrUpdateResponder ¶
func (client PipelinesClient) CreateOrUpdateResponder(resp *http.Response) (result Pipeline, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (PipelinesClient) CreateOrUpdateSender ¶
func (client PipelinesClient) CreateOrUpdateSender(req *http.Request) (future PipelinesCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (PipelinesClient) Delete ¶
func (client PipelinesClient) Delete(ctx context.Context, resourceGroupName string, pipelineName string) (result autorest.Response, err error)
Delete deletes an Azure Pipeline. Parameters: resourceGroupName - name of the resource group within the Azure subscription. pipelineName - the name of the Azure Pipeline resource.
func (PipelinesClient) DeletePreparer ¶
func (client PipelinesClient) DeletePreparer(ctx context.Context, resourceGroupName string, pipelineName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (PipelinesClient) DeleteResponder ¶
func (client PipelinesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (PipelinesClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (PipelinesClient) Get ¶
func (client PipelinesClient) Get(ctx context.Context, resourceGroupName string, pipelineName string) (result Pipeline, err error)
Get gets an existing Azure Pipeline. Parameters: resourceGroupName - name of the resource group within the Azure subscription. pipelineName - the name of the Azure Pipeline resource in ARM.
func (PipelinesClient) GetPreparer ¶
func (client PipelinesClient) GetPreparer(ctx context.Context, resourceGroupName string, pipelineName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (PipelinesClient) GetResponder ¶
func (client PipelinesClient) GetResponder(resp *http.Response) (result Pipeline, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (PipelinesClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (PipelinesClient) ListByResourceGroup ¶
func (client PipelinesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result PipelineListResultPage, err error)
ListByResourceGroup lists all Azure Pipelines under the specified resource group. Parameters: resourceGroupName - name of the resource group within the Azure subscription.
func (PipelinesClient) ListByResourceGroupComplete ¶
func (client PipelinesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result PipelineListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (PipelinesClient) ListByResourceGroupPreparer ¶
func (client PipelinesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (PipelinesClient) ListByResourceGroupResponder ¶
func (client PipelinesClient) ListByResourceGroupResponder(resp *http.Response) (result PipelineListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (PipelinesClient) ListByResourceGroupSender ¶
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (PipelinesClient) ListBySubscription ¶
func (client PipelinesClient) ListBySubscription(ctx context.Context) (result PipelineListResultPage, err error)
ListBySubscription lists all Azure Pipelines under the specified subscription.
func (PipelinesClient) ListBySubscriptionComplete ¶
func (client PipelinesClient) ListBySubscriptionComplete(ctx context.Context) (result PipelineListResultIterator, err error)
ListBySubscriptionComplete enumerates all values, automatically crossing page boundaries as required.
func (PipelinesClient) ListBySubscriptionPreparer ¶
func (client PipelinesClient) ListBySubscriptionPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionPreparer prepares the ListBySubscription request.
func (PipelinesClient) ListBySubscriptionResponder ¶
func (client PipelinesClient) ListBySubscriptionResponder(resp *http.Response) (result PipelineListResult, err error)
ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.
func (PipelinesClient) ListBySubscriptionSender ¶
ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.
func (PipelinesClient) Update ¶
func (client PipelinesClient) Update(ctx context.Context, resourceGroupName string, pipelineName string, updateOperationParameters PipelineUpdateParameters) (result Pipeline, err error)
Update updates the properties of an Azure Pipeline. Currently, only tags can be updated. Parameters: resourceGroupName - name of the resource group within the Azure subscription. pipelineName - the name of the Azure Pipeline resource. updateOperationParameters - the request payload containing the properties to update in the Azure Pipeline.
func (PipelinesClient) UpdatePreparer ¶
func (client PipelinesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, pipelineName string, updateOperationParameters PipelineUpdateParameters) (*http.Request, error)
UpdatePreparer prepares the Update request.
func (PipelinesClient) UpdateResponder ¶
func (client PipelinesClient) UpdateResponder(resp *http.Response) (result Pipeline, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
func (PipelinesClient) UpdateSender ¶
UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.
type PipelinesCreateOrUpdateFuture ¶
type PipelinesCreateOrUpdateFuture struct { azure.FutureAPI // Result returns the result of the asynchronous operation. // If the operation has not completed it will return an error. Result func(PipelinesClient) (Pipeline, error) }
PipelinesCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (*PipelinesCreateOrUpdateFuture) UnmarshalJSON ¶
func (future *PipelinesCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
type ProjectReference ¶
type ProjectReference struct { // ID - READ-ONLY; Unique immutable identifier of the Azure DevOps Project. ID *string `json:"id,omitempty"` // Name - Name of the Azure DevOps Project. Name *string `json:"name,omitempty"` }
ProjectReference reference to an Azure DevOps Project.
func (ProjectReference) MarshalJSON ¶
func (pr ProjectReference) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProjectReference.
type Resource ¶
type Resource struct { // ID - READ-ONLY; Resource Id ID *string `json:"id,omitempty"` // Type - READ-ONLY; Resource Type Type *string `json:"type,omitempty"` // Tags - Resource Tags Tags map[string]*string `json:"tags"` // Location - Resource Location Location *string `json:"location,omitempty"` // Name - READ-ONLY; Resource Name Name *string `json:"name,omitempty"` }
Resource an Azure Resource Manager (ARM) resource.
func (Resource) MarshalJSON ¶
MarshalJSON is the custom marshaler for Resource.