armtemplates

package
v0.20240627.1122744 Latest Latest
Warning

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

Go to latest
Published: Jun 27, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/devtestlab/2018-09-15/armtemplates Documentation

The armtemplates 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/armtemplates"

Client Initialization

client := armtemplates.NewArmTemplatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ArmTemplatesClient.Get

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

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

Example Usage: ArmTemplatesClient.List

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

// alternatively `client.List(ctx, id, armtemplates.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, armtemplates.DefaultListOperationOptions())
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 ValidateArmTemplateID

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

ValidateArmTemplateID checks that 'input' can be parsed as a Arm Template ID

func ValidateArtifactSourceID

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

ValidateArtifactSourceID checks that 'input' can be parsed as a Artifact Source ID

Types

type ArmTemplate

type ArmTemplate struct {
	Id         *string               `json:"id,omitempty"`
	Location   *string               `json:"location,omitempty"`
	Name       *string               `json:"name,omitempty"`
	Properties ArmTemplateProperties `json:"properties"`
	Tags       *map[string]string    `json:"tags,omitempty"`
	Type       *string               `json:"type,omitempty"`
}

type ArmTemplateId

type ArmTemplateId struct {
	SubscriptionId     string
	ResourceGroupName  string
	LabName            string
	ArtifactSourceName string
	ArmTemplateName    string
}

ArmTemplateId is a struct representing the Resource ID for a Arm Template

func NewArmTemplateID

func NewArmTemplateID(subscriptionId string, resourceGroupName string, labName string, artifactSourceName string, armTemplateName string) ArmTemplateId

NewArmTemplateID returns a new ArmTemplateId struct

func ParseArmTemplateID

func ParseArmTemplateID(input string) (*ArmTemplateId, error)

ParseArmTemplateID parses 'input' into a ArmTemplateId

func ParseArmTemplateIDInsensitively

func ParseArmTemplateIDInsensitively(input string) (*ArmTemplateId, error)

ParseArmTemplateIDInsensitively parses 'input' case-insensitively into a ArmTemplateId note: this method should only be used for API response data and not user input

func (*ArmTemplateId) FromParseResult

func (id *ArmTemplateId) FromParseResult(input resourceids.ParseResult) error

func (ArmTemplateId) ID

func (id ArmTemplateId) ID() string

ID returns the formatted Arm Template ID

func (ArmTemplateId) Segments

func (id ArmTemplateId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Arm Template ID

func (ArmTemplateId) String

func (id ArmTemplateId) String() string

String returns a human-readable description of this Arm Template ID

type ArmTemplateOperationPredicate

type ArmTemplateOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ArmTemplateOperationPredicate) Matches

type ArmTemplateProperties

type ArmTemplateProperties struct {
	Contents                 *interface{}               `json:"contents,omitempty"`
	CreatedDate              *string                    `json:"createdDate,omitempty"`
	Description              *string                    `json:"description,omitempty"`
	DisplayName              *string                    `json:"displayName,omitempty"`
	Enabled                  *bool                      `json:"enabled,omitempty"`
	Icon                     *string                    `json:"icon,omitempty"`
	ParametersValueFilesInfo *[]ParametersValueFileInfo `json:"parametersValueFilesInfo,omitempty"`
	Publisher                *string                    `json:"publisher,omitempty"`
}

func (*ArmTemplateProperties) GetCreatedDateAsTime

func (o *ArmTemplateProperties) GetCreatedDateAsTime() (*time.Time, error)

func (*ArmTemplateProperties) SetCreatedDateAsTime

func (o *ArmTemplateProperties) SetCreatedDateAsTime(input time.Time)

type ArmTemplatesClient

type ArmTemplatesClient struct {
	Client *resourcemanager.Client
}

func NewArmTemplatesClientWithBaseURI

func NewArmTemplatesClientWithBaseURI(sdkApi sdkEnv.Api) (*ArmTemplatesClient, error)

func (ArmTemplatesClient) Get

Get ...

func (ArmTemplatesClient) List

List ...

func (ArmTemplatesClient) ListComplete

ListComplete retrieves all the results into a single object

func (ArmTemplatesClient) ListCompleteMatchingPredicate

func (c ArmTemplatesClient) ListCompleteMatchingPredicate(ctx context.Context, id ArtifactSourceId, options ListOperationOptions, predicate ArmTemplateOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ArtifactSourceId

type ArtifactSourceId struct {
	SubscriptionId     string
	ResourceGroupName  string
	LabName            string
	ArtifactSourceName string
}

ArtifactSourceId is a struct representing the Resource ID for a Artifact Source

func NewArtifactSourceID

func NewArtifactSourceID(subscriptionId string, resourceGroupName string, labName string, artifactSourceName string) ArtifactSourceId

NewArtifactSourceID returns a new ArtifactSourceId struct

func ParseArtifactSourceID

func ParseArtifactSourceID(input string) (*ArtifactSourceId, error)

ParseArtifactSourceID parses 'input' into a ArtifactSourceId

func ParseArtifactSourceIDInsensitively

func ParseArtifactSourceIDInsensitively(input string) (*ArtifactSourceId, error)

ParseArtifactSourceIDInsensitively parses 'input' case-insensitively into a ArtifactSourceId note: this method should only be used for API response data and not user input

func (*ArtifactSourceId) FromParseResult

func (id *ArtifactSourceId) FromParseResult(input resourceids.ParseResult) error

func (ArtifactSourceId) ID

func (id ArtifactSourceId) ID() string

ID returns the formatted Artifact Source ID

func (ArtifactSourceId) Segments

func (id ArtifactSourceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Artifact Source ID

func (ArtifactSourceId) String

func (id ArtifactSourceId) String() string

String returns a human-readable description of this Artifact Source ID

type GetOperationOptions

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationOptions

type ListOperationOptions struct {
	Expand  *string
	Filter  *string
	Orderby *string
	Top     *int64
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery

type ListOperationResponse

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

type ParametersValueFileInfo

type ParametersValueFileInfo struct {
	FileName            *string      `json:"fileName,omitempty"`
	ParametersValueInfo *interface{} `json:"parametersValueInfo,omitempty"`
}

Jump to

Keyboard shortcuts

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