package
0.20240715.1103416
Repository: https://github.com/hashicorp/go-azure-sdk.git
Documentation: pkg.go.dev

# README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2024-04-01/devops Documentation

The devops SDK allows for interaction with the Azure Resource Manager Service security (API Version 2024-04-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/security/2024-04-01/devops"

Client Initialization

client := devops.NewDevOpsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DevOpsClient.AzureDevOpsOrgsCreateOrUpdate

ctx := context.TODO()
id := devops.NewAzureDevOpsOrgID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue")

payload := devops.AzureDevOpsOrg{
	// ...
}


if err := client.AzureDevOpsOrgsCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.AzureDevOpsOrgsGet

ctx := context.TODO()
id := devops.NewAzureDevOpsOrgID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue")

read, err := client.AzureDevOpsOrgsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DevOpsClient.AzureDevOpsOrgsList

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

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

Example Usage: DevOpsClient.AzureDevOpsOrgsListAvailable

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

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

Example Usage: DevOpsClient.AzureDevOpsOrgsUpdate

ctx := context.TODO()
id := devops.NewAzureDevOpsOrgID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue")

payload := devops.AzureDevOpsOrg{
	// ...
}


if err := client.AzureDevOpsOrgsUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.AzureDevOpsProjectsCreateOrUpdate

ctx := context.TODO()
id := devops.NewProjectID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue", "projectValue")

payload := devops.AzureDevOpsProject{
	// ...
}


if err := client.AzureDevOpsProjectsCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.AzureDevOpsProjectsGet

ctx := context.TODO()
id := devops.NewProjectID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue", "projectValue")

read, err := client.AzureDevOpsProjectsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DevOpsClient.AzureDevOpsProjectsList

ctx := context.TODO()
id := devops.NewAzureDevOpsOrgID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue")

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

Example Usage: DevOpsClient.AzureDevOpsProjectsUpdate

ctx := context.TODO()
id := devops.NewProjectID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue", "projectValue")

payload := devops.AzureDevOpsProject{
	// ...
}


if err := client.AzureDevOpsProjectsUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.AzureDevOpsReposCreateOrUpdate

ctx := context.TODO()
id := devops.NewProjectRepoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue", "projectValue", "repoValue")

payload := devops.AzureDevOpsRepository{
	// ...
}


if err := client.AzureDevOpsReposCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.AzureDevOpsReposGet

ctx := context.TODO()
id := devops.NewProjectRepoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue", "projectValue", "repoValue")

read, err := client.AzureDevOpsReposGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DevOpsClient.AzureDevOpsReposList

ctx := context.TODO()
id := devops.NewProjectID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue", "projectValue")

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

Example Usage: DevOpsClient.AzureDevOpsReposUpdate

ctx := context.TODO()
id := devops.NewProjectRepoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "azureDevOpsOrgValue", "projectValue", "repoValue")

payload := devops.AzureDevOpsRepository{
	// ...
}


if err := client.AzureDevOpsReposUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.ConfigurationsCreateOrUpdate

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

payload := devops.DevOpsConfiguration{
	// ...
}


if err := client.ConfigurationsCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.ConfigurationsDelete

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

if err := client.ConfigurationsDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.ConfigurationsGet

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

read, err := client.ConfigurationsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DevOpsClient.ConfigurationsList

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

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

Example Usage: DevOpsClient.ConfigurationsUpdate

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

payload := devops.DevOpsConfiguration{
	// ...
}


if err := client.ConfigurationsUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: DevOpsClient.GitHubOwnersGet

ctx := context.TODO()
id := devops.NewGitHubOwnerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "gitHubOwnerValue")

read, err := client.GitHubOwnersGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DevOpsClient.GitHubOwnersList

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

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

Example Usage: DevOpsClient.GitHubOwnersListAvailable

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

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

Example Usage: DevOpsClient.GitHubReposGet

ctx := context.TODO()
id := devops.NewRepoID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "gitHubOwnerValue", "repoValue")

read, err := client.GitHubReposGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DevOpsClient.GitHubReposList

ctx := context.TODO()
id := devops.NewGitHubOwnerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "gitHubOwnerValue")

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

Example Usage: DevOpsClient.GitLabGroupsGet

ctx := context.TODO()
id := devops.NewGitLabGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "gitLabGroupValue")

read, err := client.GitLabGroupsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DevOpsClient.GitLabGroupsList

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

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

Example Usage: DevOpsClient.GitLabGroupsListAvailable

ctx := context.TODO()
id := devops.NewSecurityConnectorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue")

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

Example Usage: DevOpsClient.GitLabProjectsGet

ctx := context.TODO()
id := devops.NewGitLabGroupProjectID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "gitLabGroupValue", "projectValue")

read, err := client.GitLabProjectsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: DevOpsClient.GitLabProjectsList

ctx := context.TODO()
id := devops.NewGitLabGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "gitLabGroupValue")

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

Example Usage: DevOpsClient.GitLabSubgroupsList

ctx := context.TODO()
id := devops.NewGitLabGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "securityConnectorValue", "gitLabGroupValue")

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

# Functions

NewAzureDevOpsOrgID returns a new AzureDevOpsOrgId struct.
No description provided by the author
NewGitHubOwnerID returns a new GitHubOwnerId struct.
NewGitLabGroupID returns a new GitLabGroupId struct.
NewGitLabGroupProjectID returns a new GitLabGroupProjectId struct.
NewProjectID returns a new ProjectId struct.
NewProjectRepoID returns a new ProjectRepoId struct.
NewRepoID returns a new RepoId struct.
NewSecurityConnectorID returns a new SecurityConnectorId struct.
ParseAzureDevOpsOrgID parses 'input' into a AzureDevOpsOrgId.
ParseAzureDevOpsOrgIDInsensitively parses 'input' case-insensitively into a AzureDevOpsOrgId note: this method should only be used for API response data and not user input.
ParseGitHubOwnerID parses 'input' into a GitHubOwnerId.
ParseGitHubOwnerIDInsensitively parses 'input' case-insensitively into a GitHubOwnerId note: this method should only be used for API response data and not user input.
ParseGitLabGroupID parses 'input' into a GitLabGroupId.
ParseGitLabGroupIDInsensitively parses 'input' case-insensitively into a GitLabGroupId note: this method should only be used for API response data and not user input.
ParseGitLabGroupProjectID parses 'input' into a GitLabGroupProjectId.
ParseGitLabGroupProjectIDInsensitively parses 'input' case-insensitively into a GitLabGroupProjectId note: this method should only be used for API response data and not user input.
ParseProjectID parses 'input' into a ProjectId.
ParseProjectIDInsensitively parses 'input' case-insensitively into a ProjectId note: this method should only be used for API response data and not user input.
ParseProjectRepoID parses 'input' into a ProjectRepoId.
ParseProjectRepoIDInsensitively parses 'input' case-insensitively into a ProjectRepoId note: this method should only be used for API response data and not user input.
ParseRepoID parses 'input' into a RepoId.
ParseRepoIDInsensitively parses 'input' case-insensitively into a RepoId note: this method should only be used for API response data and not user input.
ParseSecurityConnectorID parses 'input' into a SecurityConnectorId.
ParseSecurityConnectorIDInsensitively parses 'input' case-insensitively into a SecurityConnectorId note: this method should only be used for API response data and not user input.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValidateAzureDevOpsOrgID checks that 'input' can be parsed as a Azure Dev Ops Org ID.
ValidateGitHubOwnerID checks that 'input' can be parsed as a Git Hub Owner ID.
ValidateGitLabGroupID checks that 'input' can be parsed as a Git Lab Group ID.
ValidateGitLabGroupProjectID checks that 'input' can be parsed as a Git Lab Group Project ID.
ValidateProjectID checks that 'input' can be parsed as a Project ID.
ValidateProjectRepoID checks that 'input' can be parsed as a Project Repo ID.
ValidateRepoID checks that 'input' can be parsed as a Repo ID.
ValidateSecurityConnectorID checks that 'input' can be parsed as a Security Connector ID.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
AzureDevOpsOrgId is a struct representing the Resource ID for a Azure Dev Ops Org.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GitHubOwnerId is a struct representing the Resource ID for a Git Hub Owner.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GitLabGroupId is a struct representing the Resource ID for a Git Lab Group.
No description provided by the author
GitLabGroupProjectId is a struct representing the Resource ID for a Git Lab Group Project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ProjectId is a struct representing the Resource ID for a Project.
ProjectRepoId is a struct representing the Resource ID for a Project Repo.
RepoId is a struct representing the Resource ID for a Repo.
SecurityConnectorId is a struct representing the Resource ID for a Security Connector.
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author