bestpractices

package
v0.20231023.1051734 Latest Latest
Warning

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

Go to latest
Published: Oct 23, 2023 License: MPL-2.0 Imports: 10 Imported by: 1

README

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

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

Client Initialization

client := bestpractices.NewBestPracticesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BestPracticesClient.Get

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

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

ctx := context.TODO()


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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

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 BestPracticesClient

type BestPracticesClient struct {
	Client *resourcemanager.Client
}

func NewBestPracticesClientWithBaseURI

func NewBestPracticesClientWithBaseURI(sdkApi sdkEnv.Api) (*BestPracticesClient, error)

func (BestPracticesClient) Get

Get ...

func (BestPracticesClient) ListByTenant

func (c BestPracticesClient) ListByTenant(ctx context.Context) (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
}

Jump to

Keyboard shortcuts

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