repositories

README

github.com/hashicorp/go-azure-sdk/resource-manager/securityinsights/2023-11-01/repositories Documentation

The repositories SDK allows for interaction with the Azure Resource Manager Service securityinsights (API Version 2023-11-01).

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/2023-11-01/repositories"

Client Initialization

client := repositories.NewRepositoriesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RepositoriesClient.SourceControllistRepositories

ctx := context.TODO()
id := repositories.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceValue")

payload := repositories.RepositoryAccessProperties{
	// ...
}


// alternatively `client.SourceControllistRepositories(ctx, id, payload)` can be used to do batched pagination
items, err := client.SourceControllistRepositoriesComplete(ctx, id, payload)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForRepositoryAccessKind() []string
• func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)
• type Repo
• type RepoOperationPredicate
  • func (p RepoOperationPredicate) Matches(input Repo) bool
• type RepositoriesClient
  • func NewRepositoriesClientWithBaseURI(sdkApi sdkEnv.Api) (*RepositoriesClient, error)
  • func (c RepositoriesClient) SourceControllistRepositories(ctx context.Context, id WorkspaceId, input RepositoryAccessProperties) (result SourceControllistRepositoriesOperationResponse, err error)
  • func (c RepositoriesClient) SourceControllistRepositoriesComplete(ctx context.Context, id WorkspaceId, input RepositoryAccessProperties) (SourceControllistRepositoriesCompleteResult, error)
  • func (c RepositoriesClient) SourceControllistRepositoriesCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, input RepositoryAccessProperties, ...) (result SourceControllistRepositoriesCompleteResult, err error)
• type RepositoryAccess
• type RepositoryAccessKind
  • func (s *RepositoryAccessKind) UnmarshalJSON(bytes []byte) error
• type RepositoryAccessObject
• type RepositoryAccessProperties
• type SourceControllistRepositoriesCompleteResult
• type SourceControllistRepositoriesOperationResponse
• type WorkspaceId
  • func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId
  • func ParseWorkspaceID(input string) (*WorkspaceId, error)
  • func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)
  • func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error
  • func (id WorkspaceId) ID() string
  • func (id WorkspaceId) Segments() []resourceids.Segment
  • func (id WorkspaceId) String() string

Functions

func PossibleValuesForRepositoryAccessKind

func PossibleValuesForRepositoryAccessKind() []string

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 Repo

type Repo struct {
	Branches       *[]string `json:"branches,omitempty"`
	FullName       *string   `json:"fullName,omitempty"`
	InstallationId *int64    `json:"installationId,omitempty"`
	Url            *string   `json:"url,omitempty"`
}

type RepoOperationPredicate

type RepoOperationPredicate struct {
	FullName       *string
	InstallationId *int64
	Url            *string
}

func (RepoOperationPredicate) Matches

func (p RepoOperationPredicate) Matches(input Repo) bool

type RepositoriesClient

type RepositoriesClient struct {
	Client *resourcemanager.Client
}

func NewRepositoriesClientWithBaseURI

func NewRepositoriesClientWithBaseURI(sdkApi sdkEnv.Api) (*RepositoriesClient, error)

func (RepositoriesClient) SourceControllistRepositories

func (c RepositoriesClient) SourceControllistRepositories(ctx context.Context, id WorkspaceId, input RepositoryAccessProperties) (result SourceControllistRepositoriesOperationResponse, err error)

SourceControllistRepositories ...

func (RepositoriesClient) SourceControllistRepositoriesComplete

func (c RepositoriesClient) SourceControllistRepositoriesComplete(ctx context.Context, id WorkspaceId, input RepositoryAccessProperties) (SourceControllistRepositoriesCompleteResult, error)

SourceControllistRepositoriesComplete retrieves all the results into a single object

func (RepositoriesClient) SourceControllistRepositoriesCompleteMatchingPredicate

func (c RepositoriesClient) SourceControllistRepositoriesCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, input RepositoryAccessProperties, predicate RepoOperationPredicate) (result SourceControllistRepositoriesCompleteResult, err error)

SourceControllistRepositoriesCompleteMatchingPredicate retrieves all the results and then applies the predicate

type RepositoryAccess

type RepositoryAccess struct {
	ClientId       *string              `json:"clientId,omitempty"`
	Code           *string              `json:"code,omitempty"`
	InstallationId *string              `json:"installationId,omitempty"`
	Kind           RepositoryAccessKind `json:"kind"`
	State          *string              `json:"state,omitempty"`
	Token          *string              `json:"token,omitempty"`
}

type RepositoryAccessKind

type RepositoryAccessKind string

const (
	RepositoryAccessKindApp   RepositoryAccessKind = "App"
	RepositoryAccessKindOAuth RepositoryAccessKind = "OAuth"
	RepositoryAccessKindPAT   RepositoryAccessKind = "PAT"
)

func (*RepositoryAccessKind) UnmarshalJSON

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

type RepositoryAccessObject

type RepositoryAccessObject struct {
	RepositoryAccess RepositoryAccess `json:"repositoryAccess"`
}

type RepositoryAccessProperties

type RepositoryAccessProperties struct {
	Properties RepositoryAccessObject `json:"properties"`
}

type SourceControllistRepositoriesCompleteResult

type SourceControllistRepositoriesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Repo
}

type SourceControllistRepositoriesOperationResponse

type SourceControllistRepositoriesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Repo
}

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