configurationprofiles

README

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

The configurationprofiles 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/automanage/2022-05-04/configurationprofiles"

Client Initialization

client := configurationprofiles.NewConfigurationProfilesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConfigurationProfilesClient.CreateOrUpdate

ctx := context.TODO()
id := configurationprofiles.NewConfigurationProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "configurationProfileValue")

payload := configurationprofiles.ConfigurationProfile{
	// ...
}


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

Example Usage: ConfigurationProfilesClient.Delete

ctx := context.TODO()
id := configurationprofiles.NewConfigurationProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "configurationProfileValue")

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

Example Usage: ConfigurationProfilesClient.Get

ctx := context.TODO()
id := configurationprofiles.NewConfigurationProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "configurationProfileValue")

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: ConfigurationProfilesClient.ListByResourceGroup

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

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

Example Usage: ConfigurationProfilesClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: ConfigurationProfilesClient.Update

ctx := context.TODO()
id := configurationprofiles.NewConfigurationProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "configurationProfileValue")

payload := configurationprofiles.ConfigurationProfileUpdate{
	// ...
}


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

Documentation

Index

• func ValidateConfigurationProfileID(input interface{}, key string) (warnings []string, errors []error)
• type ConfigurationProfile
• type ConfigurationProfileId
  • func NewConfigurationProfileID(subscriptionId string, resourceGroupName string, ...) ConfigurationProfileId
  • func ParseConfigurationProfileID(input string) (*ConfigurationProfileId, error)
  • func ParseConfigurationProfileIDInsensitively(input string) (*ConfigurationProfileId, error)
  • func (id *ConfigurationProfileId) FromParseResult(input resourceids.ParseResult) error
  • func (id ConfigurationProfileId) ID() string
  • func (id ConfigurationProfileId) Segments() []resourceids.Segment
  • func (id ConfigurationProfileId) String() string
• type ConfigurationProfileList
• type ConfigurationProfileProperties
• type ConfigurationProfileUpdate
• type ConfigurationProfilesClient
  • func NewConfigurationProfilesClientWithBaseURI(sdkApi sdkEnv.Api) (*ConfigurationProfilesClient, error)
  • func (c ConfigurationProfilesClient) CreateOrUpdate(ctx context.Context, id ConfigurationProfileId, input ConfigurationProfile) (result CreateOrUpdateOperationResponse, err error)
  • func (c ConfigurationProfilesClient) Delete(ctx context.Context, id ConfigurationProfileId) (result DeleteOperationResponse, err error)
  • func (c ConfigurationProfilesClient) Get(ctx context.Context, id ConfigurationProfileId) (result GetOperationResponse, err error)
  • func (c ConfigurationProfilesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
  • func (c ConfigurationProfilesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
  • func (c ConfigurationProfilesClient) Update(ctx context.Context, id ConfigurationProfileId, ...) (result UpdateOperationResponse, err error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListByResourceGroupOperationResponse
• type ListBySubscriptionOperationResponse
• type UpdateOperationResponse

Functions

func ValidateConfigurationProfileID

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

ValidateConfigurationProfileID checks that 'input' can be parsed as a Configuration Profile ID

Types

type ConfigurationProfile

type ConfigurationProfile struct {
	Id         *string                         `json:"id,omitempty"`
	Location   string                          `json:"location"`
	Name       *string                         `json:"name,omitempty"`
	Properties *ConfigurationProfileProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type ConfigurationProfileId

type ConfigurationProfileId struct {
	SubscriptionId           string
	ResourceGroupName        string
	ConfigurationProfileName string
}

ConfigurationProfileId is a struct representing the Resource ID for a Configuration Profile

func NewConfigurationProfileID

func NewConfigurationProfileID(subscriptionId string, resourceGroupName string, configurationProfileName string) ConfigurationProfileId

NewConfigurationProfileID returns a new ConfigurationProfileId struct

func ParseConfigurationProfileID

func ParseConfigurationProfileID(input string) (*ConfigurationProfileId, error)

ParseConfigurationProfileID parses 'input' into a ConfigurationProfileId

func ParseConfigurationProfileIDInsensitively

func ParseConfigurationProfileIDInsensitively(input string) (*ConfigurationProfileId, error)

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

func (*ConfigurationProfileId) FromParseResult

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

func (ConfigurationProfileId) ID

func (id ConfigurationProfileId) ID() string

ID returns the formatted Configuration Profile ID

func (ConfigurationProfileId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Configuration Profile ID

func (ConfigurationProfileId) String

func (id ConfigurationProfileId) String() string

String returns a human-readable description of this Configuration Profile ID

type ConfigurationProfileList

type ConfigurationProfileList struct {
	Value *[]ConfigurationProfile `json:"value,omitempty"`
}

type ConfigurationProfileProperties

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

type ConfigurationProfileUpdate

type ConfigurationProfileUpdate struct {
	Properties *ConfigurationProfileProperties `json:"properties,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
}

type ConfigurationProfilesClient

type ConfigurationProfilesClient struct {
	Client *resourcemanager.Client
}

func NewConfigurationProfilesClientWithBaseURI

func NewConfigurationProfilesClientWithBaseURI(sdkApi sdkEnv.Api) (*ConfigurationProfilesClient, error)

func (ConfigurationProfilesClient) CreateOrUpdate

func (c ConfigurationProfilesClient) CreateOrUpdate(ctx context.Context, id ConfigurationProfileId, input ConfigurationProfile) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ConfigurationProfilesClient) Delete

func (c ConfigurationProfilesClient) Delete(ctx context.Context, id ConfigurationProfileId) (result DeleteOperationResponse, err error)

Delete ...

func (ConfigurationProfilesClient) Get

func (c ConfigurationProfilesClient) Get(ctx context.Context, id ConfigurationProfileId) (result GetOperationResponse, err error)

Get ...

func (ConfigurationProfilesClient) ListByResourceGroup

func (c ConfigurationProfilesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (ConfigurationProfilesClient) ListBySubscription

func (c ConfigurationProfilesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (ConfigurationProfilesClient) Update

func (c ConfigurationProfilesClient) Update(ctx context.Context, id ConfigurationProfileId, input ConfigurationProfileUpdate) (result UpdateOperationResponse, err error)

Update ...

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationProfile
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

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

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationProfileList
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationProfileList
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationProfile
}