bestpracticesversions

README

github.com/hashicorp/go-azure-sdk/resource-manager/automanage/2022-05-04/bestpracticesversions Documentation

The bestpracticesversions SDK allows for interaction with the Azure Resource Manager Service automanage (API Version 2022-05-04).

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/automanage/2022-05-04/bestpracticesversions"

Client Initialization

client := bestpracticesversions.NewBestPracticesVersionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BestPracticesVersionsClient.Get

ctx := context.TODO()
id := bestpracticesversions.NewVersionID("bestPracticeValue", "versionValue")

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: BestPracticesVersionsClient.ListByTenant

ctx := context.TODO()
id := bestpracticesversions.NewBestPracticeID("bestPracticeValue")

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

Documentation

Index

• func ValidateBestPracticeID(input interface{}, key string) (warnings []string, errors []error)
• func ValidateVersionID(input interface{}, key string) (warnings []string, errors []error)
• type BestPractice
• type BestPracticeId
  • func NewBestPracticeID(bestPracticeName string) BestPracticeId
  • func ParseBestPracticeID(input string) (*BestPracticeId, error)
  • func ParseBestPracticeIDInsensitively(input string) (*BestPracticeId, error)
  • func (id BestPracticeId) ID() string
  • func (id BestPracticeId) Segments() []resourceids.Segment
  • func (id BestPracticeId) String() string
• type BestPracticeList
• type BestPracticesVersionsClient
  • func NewBestPracticesVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*BestPracticesVersionsClient, error)
  • func (c BestPracticesVersionsClient) Get(ctx context.Context, id VersionId) (result GetOperationResponse, err error)
  • func (c BestPracticesVersionsClient) ListByTenant(ctx context.Context, id BestPracticeId) (result ListByTenantOperationResponse, err error)
• type ConfigurationProfileProperties
• type GetOperationResponse
• type ListByTenantOperationResponse
• type VersionId
  • func NewVersionID(bestPracticeName string, versionName string) VersionId
  • func ParseVersionID(input string) (*VersionId, error)
  • func ParseVersionIDInsensitively(input string) (*VersionId, error)
  • func (id VersionId) ID() string
  • func (id VersionId) Segments() []resourceids.Segment
  • func (id VersionId) String() string

Functions

func ValidateBestPracticeID

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

ValidateBestPracticeID checks that 'input' can be parsed as a Best Practice ID

func ValidateVersionID

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

ValidateVersionID checks that 'input' can be parsed as a Version ID

Types

type BestPractice

type BestPractice struct {
	Id         *string                         `json:"id,omitempty"`
	Name       *string                         `json:"name,omitempty"`
	Properties *ConfigurationProfileProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type BestPracticeId

type BestPracticeId struct {
	BestPracticeName string
}

BestPracticeId is a struct representing the Resource ID for a Best Practice

func NewBestPracticeID

func NewBestPracticeID(bestPracticeName string) BestPracticeId

NewBestPracticeID returns a new BestPracticeId struct

func ParseBestPracticeID

func ParseBestPracticeID(input string) (*BestPracticeId, error)

ParseBestPracticeID parses 'input' into a BestPracticeId

func ParseBestPracticeIDInsensitively

func ParseBestPracticeIDInsensitively(input string) (*BestPracticeId, error)

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

func (BestPracticeId) ID

func (id BestPracticeId) ID() string

ID returns the formatted Best Practice ID

func (BestPracticeId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Best Practice ID

func (BestPracticeId) String

func (id BestPracticeId) String() string

String returns a human-readable description of this Best Practice ID

type BestPracticeList

type BestPracticeList struct {
	Value *[]BestPractice `json:"value,omitempty"`
}

type BestPracticesVersionsClient

type BestPracticesVersionsClient struct {
	Client *resourcemanager.Client
}

func NewBestPracticesVersionsClientWithBaseURI

func NewBestPracticesVersionsClientWithBaseURI(sdkApi sdkEnv.Api) (*BestPracticesVersionsClient, error)

func (BestPracticesVersionsClient) Get

func (c BestPracticesVersionsClient) Get(ctx context.Context, id VersionId) (result GetOperationResponse, err error)

Get ...

func (BestPracticesVersionsClient) ListByTenant

func (c BestPracticesVersionsClient) ListByTenant(ctx context.Context, id BestPracticeId) (result ListByTenantOperationResponse, err error)

ListByTenant ...

type ConfigurationProfileProperties

type ConfigurationProfileProperties struct {
	Configuration *interface{} `json:"configuration,omitempty"`
}

type GetOperationResponse

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

type ListByTenantOperationResponse

type ListByTenantOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BestPracticeList
}

type VersionId

type VersionId struct {
	BestPracticeName string
	VersionName      string
}

VersionId is a struct representing the Resource ID for a Version

func NewVersionID

func NewVersionID(bestPracticeName string, versionName string) VersionId

NewVersionID returns a new VersionId struct

func ParseVersionID

func ParseVersionID(input string) (*VersionId, error)

ParseVersionID parses 'input' into a VersionId

func ParseVersionIDInsensitively

func ParseVersionIDInsensitively(input string) (*VersionId, error)

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

func (VersionId) ID

func (id VersionId) ID() string

ID returns the formatted Version ID

func (VersionId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Version ID

func (VersionId) String

func (id VersionId) String() string

String returns a human-readable description of this Version ID