README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2022-07-01-preview/sourcecontrols
Documentation
The sourcecontrols
SDK allows for interaction with the Azure Resource Manager Service securityinsights
(API Version 2022-07-01-preview
).
This readme covers example usages, but further information on using this SDK can be found in the project root.
Import Path
import "github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2022-07-01-preview/sourcecontrols"
Client Initialization
client := sourcecontrols.NewSourceControlsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SourceControlsClient.Create
ctx := context.TODO()
id := sourcecontrols.NewSourceControlID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sourceControlIdValue")
payload := sourcecontrols.SourceControl{
// ...
}
read, err := client.Create(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SourceControlsClient.Delete
ctx := context.TODO()
id := sourcecontrols.NewSourceControlID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sourceControlIdValue")
read, err := client.Delete(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SourceControlsClient.Get
ctx := context.TODO()
id := sourcecontrols.NewSourceControlID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue", "sourceControlIdValue")
read, err := client.Get(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: SourceControlsClient.List
ctx := context.TODO()
id := sourcecontrols.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")
// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Documentation ¶
Index ¶
- func PossibleValuesForContentType() []string
- func PossibleValuesForDeploymentFetchStatus() []string
- func PossibleValuesForDeploymentResult() []string
- func PossibleValuesForDeploymentState() []string
- func PossibleValuesForRepoType() []string
- func PossibleValuesForVersion() []string
- func ValidateSourceControlID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
- type AzureDevOpsResourceInfo
- type ContentPathMap
- type ContentType
- type CreateOperationResponse
- type DeleteOperationResponse
- type Deployment
- type DeploymentFetchStatus
- type DeploymentInfo
- type DeploymentResult
- type DeploymentState
- type GetOperationResponse
- type GitHubResourceInfo
- type ListCompleteResult
- type ListOperationResponse
- type RepoType
- type Repository
- type RepositoryResourceInfo
- type SourceControl
- type SourceControlId
- type SourceControlOperationPredicate
- type SourceControlProperties
- type SourceControlsClient
- func (c SourceControlsClient) Create(ctx context.Context, id SourceControlId, input SourceControl) (result CreateOperationResponse, err error)
- func (c SourceControlsClient) Delete(ctx context.Context, id SourceControlId) (result DeleteOperationResponse, err error)
- func (c SourceControlsClient) Get(ctx context.Context, id SourceControlId) (result GetOperationResponse, err error)
- func (c SourceControlsClient) List(ctx context.Context, id WorkspaceId) (resp ListOperationResponse, err error)
- func (c SourceControlsClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)
- func (c SourceControlsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate SourceControlOperationPredicate) (resp ListCompleteResult, err error)
- type Version
- type Webhook
- type WorkspaceId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForContentType ¶
func PossibleValuesForContentType() []string
func PossibleValuesForDeploymentFetchStatus ¶
func PossibleValuesForDeploymentFetchStatus() []string
func PossibleValuesForDeploymentResult ¶
func PossibleValuesForDeploymentResult() []string
func PossibleValuesForDeploymentState ¶
func PossibleValuesForDeploymentState() []string
func PossibleValuesForRepoType ¶
func PossibleValuesForRepoType() []string
func PossibleValuesForVersion ¶
func PossibleValuesForVersion() []string
func ValidateSourceControlID ¶
ValidateSourceControlID checks that 'input' can be parsed as a Source Control ID
func ValidateWorkspaceID ¶
ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID
Types ¶
type AzureDevOpsResourceInfo ¶
type ContentPathMap ¶
type ContentPathMap struct { ContentType *ContentType `json:"contentType,omitempty"` Path *string `json:"path,omitempty"` }
type ContentType ¶
type ContentType string
const ( ContentTypeAnalyticRule ContentType = "AnalyticRule" ContentTypeWorkbook ContentType = "Workbook" )
type CreateOperationResponse ¶
type CreateOperationResponse struct { HttpResponse *http.Response Model *SourceControl }
type DeleteOperationResponse ¶
type Deployment ¶
type Deployment struct { DeploymentId *string `json:"deploymentId,omitempty"` DeploymentLogsUrl *string `json:"deploymentLogsUrl,omitempty"` DeploymentResult *DeploymentResult `json:"deploymentResult,omitempty"` DeploymentState *DeploymentState `json:"deploymentState,omitempty"` DeploymentTime *string `json:"deploymentTime,omitempty"` }
func (*Deployment) GetDeploymentTimeAsTime ¶
func (o *Deployment) GetDeploymentTimeAsTime() (*time.Time, error)
func (*Deployment) SetDeploymentTimeAsTime ¶
func (o *Deployment) SetDeploymentTimeAsTime(input time.Time)
type DeploymentFetchStatus ¶
type DeploymentFetchStatus string
const ( DeploymentFetchStatusNotFound DeploymentFetchStatus = "NotFound" DeploymentFetchStatusSuccess DeploymentFetchStatus = "Success" )
type DeploymentInfo ¶
type DeploymentInfo struct { Deployment *Deployment `json:"deployment,omitempty"` DeploymentFetchStatus *DeploymentFetchStatus `json:"deploymentFetchStatus,omitempty"` Message *string `json:"message,omitempty"` }
type DeploymentResult ¶
type DeploymentResult string
const ( DeploymentResultCanceled DeploymentResult = "Canceled" DeploymentResultFailed DeploymentResult = "Failed" DeploymentResultSuccess DeploymentResult = "Success" )
type DeploymentState ¶
type DeploymentState string
const ( DeploymentStateCanceling DeploymentState = "Canceling" DeploymentStateCompleted DeploymentState = "Completed" DeploymentStateInProgress DeploymentState = "In_Progress" DeploymentStateQueued DeploymentState = "Queued" )
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *SourceControl }
type GitHubResourceInfo ¶
type GitHubResourceInfo struct {
AppInstallationId *string `json:"appInstallationId,omitempty"`
}
type ListCompleteResult ¶
type ListCompleteResult struct {
Items []SourceControl
}
type ListOperationResponse ¶
type ListOperationResponse struct { HttpResponse *http.Response Model *[]SourceControl // contains filtered or unexported fields }
func (ListOperationResponse) HasMore ¶
func (r ListOperationResponse) HasMore() bool
func (ListOperationResponse) LoadMore ¶
func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)
type Repository ¶
type Repository struct { Branch *string `json:"branch,omitempty"` DeploymentLogsUrl *string `json:"deploymentLogsUrl,omitempty"` DisplayUrl *string `json:"displayUrl,omitempty"` PathMapping *[]ContentPathMap `json:"pathMapping,omitempty"` Url *string `json:"url,omitempty"` }
type RepositoryResourceInfo ¶
type RepositoryResourceInfo struct { AzureDevOpsResourceInfo *AzureDevOpsResourceInfo `json:"azureDevOpsResourceInfo,omitempty"` GitHubResourceInfo *GitHubResourceInfo `json:"gitHubResourceInfo,omitempty"` Webhook *Webhook `json:"webhook,omitempty"` }
type SourceControl ¶
type SourceControl struct { Etag *string `json:"etag,omitempty"` Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *SourceControlProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type SourceControlId ¶
type SourceControlId struct { SubscriptionId string ResourceGroupName string WorkspaceName string SourceControlId string }
SourceControlId is a struct representing the Resource ID for a Source Control
func NewSourceControlID ¶
func NewSourceControlID(subscriptionId string, resourceGroupName string, workspaceName string, sourceControlId string) SourceControlId
NewSourceControlID returns a new SourceControlId struct
func ParseSourceControlID ¶
func ParseSourceControlID(input string) (*SourceControlId, error)
ParseSourceControlID parses 'input' into a SourceControlId
func ParseSourceControlIDInsensitively ¶
func ParseSourceControlIDInsensitively(input string) (*SourceControlId, error)
ParseSourceControlIDInsensitively parses 'input' case-insensitively into a SourceControlId note: this method should only be used for API response data and not user input
func (*SourceControlId) FromParseResult ¶
func (id *SourceControlId) FromParseResult(input resourceids.ParseResult) error
func (SourceControlId) ID ¶
func (id SourceControlId) ID() string
ID returns the formatted Source Control ID
func (SourceControlId) Segments ¶
func (id SourceControlId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Source Control ID
func (SourceControlId) String ¶
func (id SourceControlId) String() string
String returns a human-readable description of this Source Control ID
type SourceControlOperationPredicate ¶
func (SourceControlOperationPredicate) Matches ¶
func (p SourceControlOperationPredicate) Matches(input SourceControl) bool
type SourceControlProperties ¶
type SourceControlProperties struct { ContentTypes []ContentType `json:"contentTypes"` Description *string `json:"description,omitempty"` DisplayName string `json:"displayName"` Id *string `json:"id,omitempty"` LastDeploymentInfo *DeploymentInfo `json:"lastDeploymentInfo,omitempty"` RepoType RepoType `json:"repoType"` Repository Repository `json:"repository"` RepositoryResourceInfo *RepositoryResourceInfo `json:"repositoryResourceInfo,omitempty"` Version *Version `json:"version,omitempty"` }
type SourceControlsClient ¶
type SourceControlsClient struct { Client autorest.Client // contains filtered or unexported fields }
func NewSourceControlsClientWithBaseURI ¶
func NewSourceControlsClientWithBaseURI(endpoint string) SourceControlsClient
func (SourceControlsClient) Create ¶
func (c SourceControlsClient) Create(ctx context.Context, id SourceControlId, input SourceControl) (result CreateOperationResponse, err error)
Create ...
func (SourceControlsClient) Delete ¶
func (c SourceControlsClient) Delete(ctx context.Context, id SourceControlId) (result DeleteOperationResponse, err error)
Delete ...
func (SourceControlsClient) Get ¶
func (c SourceControlsClient) Get(ctx context.Context, id SourceControlId) (result GetOperationResponse, err error)
Get ...
func (SourceControlsClient) List ¶
func (c SourceControlsClient) List(ctx context.Context, id WorkspaceId) (resp ListOperationResponse, err error)
List ...
func (SourceControlsClient) ListComplete ¶
func (c SourceControlsClient) ListComplete(ctx context.Context, id WorkspaceId) (ListCompleteResult, error)
ListComplete retrieves all of the results into a single object
func (SourceControlsClient) ListCompleteMatchingPredicate ¶
func (c SourceControlsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate SourceControlOperationPredicate) (resp ListCompleteResult, err error)
ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate
type WorkspaceId ¶
WorkspaceId is a struct representing the Resource ID for a Workspace
func NewWorkspaceID ¶
func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId
NewWorkspaceID returns a new WorkspaceId struct
func ParseWorkspaceID ¶
func ParseWorkspaceID(input string) (*WorkspaceId, error)
ParseWorkspaceID parses 'input' into a WorkspaceId
func ParseWorkspaceIDInsensitively ¶
func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)
ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId note: this method should only be used for API response data and not user input
func (*WorkspaceId) FromParseResult ¶
func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error
func (WorkspaceId) Segments ¶
func (id WorkspaceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Workspace ID
func (WorkspaceId) String ¶
func (id WorkspaceId) String() string
String returns a human-readable description of this Workspace ID
Source Files ¶
- client.go
- constants.go
- id_sourcecontrol.go
- id_workspace.go
- method_create_autorest.go
- method_delete_autorest.go
- method_get_autorest.go
- method_list_autorest.go
- model_azuredevopsresourceinfo.go
- model_contentpathmap.go
- model_deployment.go
- model_deploymentinfo.go
- model_githubresourceinfo.go
- model_repository.go
- model_repositoryresourceinfo.go
- model_sourcecontrol.go
- model_sourcecontrolproperties.go
- model_webhook.go
- predicates.go
- version.go