sourcecontrols

package
v0.20240228.1133018 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 28, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2021-09-01-preview/sourcecontrols Documentation

The sourcecontrols SDK allows for interaction with the Azure Resource Manager Service securityinsights (API Version 2021-09-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/2021-09-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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForContentType

func PossibleValuesForContentType() []string

func PossibleValuesForRepoType

func PossibleValuesForRepoType() []string

func ValidateSourceControlID

func ValidateSourceControlID(input interface{}, key string) (warnings []string, errors []error)

ValidateSourceControlID checks that 'input' can be parsed as a Source Control ID

func ValidateWorkspaceID

func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

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"
)

func (*ContentType) UnmarshalJSON added in v0.20240221.1115631

func (s *ContentType) UnmarshalJSON(bytes []byte) error

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SourceControl
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SourceControl
}

type ListCompleteResult

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SourceControl
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SourceControl
}

type RepoType

type RepoType string
const (
	RepoTypeDevOps RepoType = "DevOps"
	RepoTypeGithub RepoType = "Github"
)

func (*RepoType) UnmarshalJSON added in v0.20240221.1115631

func (s *RepoType) UnmarshalJSON(bytes []byte) 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 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

type SourceControlOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (SourceControlOperationPredicate) Matches

type SourceControlProperties

type SourceControlProperties struct {
	ContentTypes []ContentType `json:"contentTypes"`
	Description  *string       `json:"description,omitempty"`
	DisplayName  string        `json:"displayName"`
	Id           *string       `json:"id,omitempty"`
	RepoType     RepoType      `json:"repoType"`
	Repository   Repository    `json:"repository"`
}

type SourceControlsClient

type SourceControlsClient struct {
	Client *resourcemanager.Client
}

func NewSourceControlsClientWithBaseURI

func NewSourceControlsClientWithBaseURI(sdkApi sdkEnv.Api) (*SourceControlsClient, error)

func (SourceControlsClient) Create

Create ...

func (SourceControlsClient) Delete

Delete ...

func (SourceControlsClient) Get

Get ...

func (SourceControlsClient) List

List ...

func (SourceControlsClient) ListComplete

ListComplete retrieves all the results into a single object

func (SourceControlsClient) ListCompleteMatchingPredicate

func (c SourceControlsClient) ListCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate SourceControlOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type WorkspaceId

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

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) ID

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL