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/devtestlab/2018-09-15/artifacts Documentation

The artifacts SDK allows for interaction with the Azure Resource Manager Service devtestlab (API Version 2018-09-15).

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/devtestlab/2018-09-15/artifacts"

Client Initialization

client := artifacts.NewArtifactsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ArtifactsClient.GenerateArmTemplate

ctx := context.TODO()
id := artifacts.NewArtifactID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "artifactSourceValue", "artifactValue")

payload := artifacts.GenerateArmTemplateRequest{
	// ...
}


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

Example Usage: ArtifactsClient.Get

ctx := context.TODO()
id := artifacts.NewArtifactID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "artifactSourceValue", "artifactValue")

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

Example Usage: ArtifactsClient.List

ctx := context.TODO()
id := artifacts.NewArtifactSourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "labValue", "artifactSourceValue")

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

# Functions

No description provided by the author
No description provided by the author
NewArtifactID returns a new ArtifactId struct.
No description provided by the author
NewArtifactSourceID returns a new ArtifactSourceId struct.
ParseArtifactID parses 'input' into a ArtifactId.
ParseArtifactIDInsensitively parses 'input' case-insensitively into a ArtifactId note: this method should only be used for API response data and not user input.
ParseArtifactSourceID parses 'input' into a ArtifactSourceId.
ParseArtifactSourceIDInsensitively parses 'input' case-insensitively into a ArtifactSourceId note: this method should only be used for API response data and not user input.
No description provided by the author
ValidateArtifactID checks that 'input' can be parsed as a Artifact ID.
ValidateArtifactSourceID checks that 'input' can be parsed as a Artifact Source ID.

# Constants

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
ArtifactId is a struct representing the Resource ID for a Artifact.
No description provided by the author
No description provided by the author
No description provided by the author
ArtifactSourceId is a struct representing the Resource ID for a Artifact Source.
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

# Type aliases

No description provided by the author