configurationassignments

package
v0.20230717.1131407 Latest Latest
Warning

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

Go to latest
Published: Jul 17, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/maintenance/2023-04-01/configurationassignments Documentation

The configurationassignments SDK allows for interaction with the Azure Resource Manager Service maintenance (API Version 2023-04-01).

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/maintenance/2023-04-01/configurationassignments"

Client Initialization

client := configurationassignments.NewConfigurationAssignmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConfigurationAssignmentsClient.CreateOrUpdate

ctx := context.TODO()
id := configurationassignments.NewScopedConfigurationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "configurationAssignmentValue")

payload := configurationassignments.ConfigurationAssignment{
	// ...
}


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: ConfigurationAssignmentsClient.CreateOrUpdateParent

ctx := context.TODO()
id := configurationassignments.NewScopedConfigurationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "configurationAssignmentValue")

payload := configurationassignments.ConfigurationAssignment{
	// ...
}


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

Example Usage: ConfigurationAssignmentsClient.Delete

ctx := context.TODO()
id := configurationassignments.NewScopedConfigurationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "configurationAssignmentValue")

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: ConfigurationAssignmentsClient.DeleteParent

ctx := context.TODO()
id := configurationassignments.NewScopedConfigurationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "configurationAssignmentValue")

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

Example Usage: ConfigurationAssignmentsClient.ForResourceGroupCreateOrUpdate

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

payload := configurationassignments.ConfigurationAssignment{
	// ...
}


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

Example Usage: ConfigurationAssignmentsClient.ForResourceGroupDelete

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

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

Example Usage: ConfigurationAssignmentsClient.ForResourceGroupGet

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

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

Example Usage: ConfigurationAssignmentsClient.ForResourceGroupUpdate

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

payload := configurationassignments.ConfigurationAssignment{
	// ...
}


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

Example Usage: ConfigurationAssignmentsClient.ForSubscriptionsCreateOrUpdate

ctx := context.TODO()
id := configurationassignments.NewConfigurationAssignmentID("12345678-1234-9876-4563-123456789012", "configurationAssignmentValue")

payload := configurationassignments.ConfigurationAssignment{
	// ...
}


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

Example Usage: ConfigurationAssignmentsClient.ForSubscriptionsDelete

ctx := context.TODO()
id := configurationassignments.NewConfigurationAssignmentID("12345678-1234-9876-4563-123456789012", "configurationAssignmentValue")

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

Example Usage: ConfigurationAssignmentsClient.ForSubscriptionsGet

ctx := context.TODO()
id := configurationassignments.NewConfigurationAssignmentID("12345678-1234-9876-4563-123456789012", "configurationAssignmentValue")

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

Example Usage: ConfigurationAssignmentsClient.ForSubscriptionsUpdate

ctx := context.TODO()
id := configurationassignments.NewConfigurationAssignmentID("12345678-1234-9876-4563-123456789012", "configurationAssignmentValue")

payload := configurationassignments.ConfigurationAssignment{
	// ...
}


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

Example Usage: ConfigurationAssignmentsClient.Get

ctx := context.TODO()
id := configurationassignments.NewScopedConfigurationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "configurationAssignmentValue")

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: ConfigurationAssignmentsClient.GetParent

ctx := context.TODO()
id := configurationassignments.NewScopedConfigurationAssignmentID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group", "configurationAssignmentValue")

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

Example Usage: ConfigurationAssignmentsClient.List

ctx := context.TODO()
id := configurationassignments.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: ConfigurationAssignmentsClient.ListParent

ctx := context.TODO()
id := configurationassignments.NewScopeID("/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/some-resource-group")

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

Example Usage: ConfigurationAssignmentsClient.WithinSubscriptionList

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

read, err := client.WithinSubscriptionList(ctx, id)
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 PossibleValuesForTagOperators

func PossibleValuesForTagOperators() []string

func ValidateConfigurationAssignmentID

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

ValidateConfigurationAssignmentID checks that 'input' can be parsed as a Configuration Assignment ID

func ValidateProviderConfigurationAssignmentID

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

ValidateProviderConfigurationAssignmentID checks that 'input' can be parsed as a Provider Configuration Assignment ID

func ValidateScopedConfigurationAssignmentID added in v0.20230717.1131407

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

ValidateScopedConfigurationAssignmentID checks that 'input' can be parsed as a Scoped Configuration Assignment ID

Types

type ConfigurationAssignment

type ConfigurationAssignment struct {
	Id         *string                            `json:"id,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ConfigurationAssignmentProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type ConfigurationAssignmentFilterProperties

type ConfigurationAssignmentFilterProperties struct {
	Locations      *[]string              `json:"locations,omitempty"`
	OsTypes        *[]string              `json:"osTypes,omitempty"`
	ResourceGroups *[]string              `json:"resourceGroups,omitempty"`
	ResourceTypes  *[]string              `json:"resourceTypes,omitempty"`
	TagSettings    *TagSettingsProperties `json:"tagSettings,omitempty"`
}

type ConfigurationAssignmentId

type ConfigurationAssignmentId struct {
	SubscriptionId              string
	ConfigurationAssignmentName string
}

ConfigurationAssignmentId is a struct representing the Resource ID for a Configuration Assignment

func NewConfigurationAssignmentID

func NewConfigurationAssignmentID(subscriptionId string, configurationAssignmentName string) ConfigurationAssignmentId

NewConfigurationAssignmentID returns a new ConfigurationAssignmentId struct

func ParseConfigurationAssignmentID

func ParseConfigurationAssignmentID(input string) (*ConfigurationAssignmentId, error)

ParseConfigurationAssignmentID parses 'input' into a ConfigurationAssignmentId

func ParseConfigurationAssignmentIDInsensitively

func ParseConfigurationAssignmentIDInsensitively(input string) (*ConfigurationAssignmentId, error)

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

func (ConfigurationAssignmentId) ID

ID returns the formatted Configuration Assignment ID

func (ConfigurationAssignmentId) Segments

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

func (ConfigurationAssignmentId) String

func (id ConfigurationAssignmentId) String() string

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

type ConfigurationAssignmentProperties

type ConfigurationAssignmentProperties struct {
	Filter                     *ConfigurationAssignmentFilterProperties `json:"filter,omitempty"`
	MaintenanceConfigurationId *string                                  `json:"maintenanceConfigurationId,omitempty"`
	ResourceId                 *string                                  `json:"resourceId,omitempty"`
}

type ConfigurationAssignmentsClient

type ConfigurationAssignmentsClient struct {
	Client *resourcemanager.Client
}

func NewConfigurationAssignmentsClientWithBaseURI

func NewConfigurationAssignmentsClientWithBaseURI(api environments.Api) (*ConfigurationAssignmentsClient, error)

func (ConfigurationAssignmentsClient) CreateOrUpdate

CreateOrUpdate ...

func (ConfigurationAssignmentsClient) CreateOrUpdateParent

CreateOrUpdateParent ...

func (ConfigurationAssignmentsClient) Delete

Delete ...

func (ConfigurationAssignmentsClient) DeleteParent

DeleteParent ...

func (ConfigurationAssignmentsClient) ForResourceGroupCreateOrUpdate

ForResourceGroupCreateOrUpdate ...

func (ConfigurationAssignmentsClient) ForResourceGroupDelete

ForResourceGroupDelete ...

func (ConfigurationAssignmentsClient) ForResourceGroupGet

ForResourceGroupGet ...

func (ConfigurationAssignmentsClient) ForResourceGroupUpdate

ForResourceGroupUpdate ...

func (ConfigurationAssignmentsClient) ForSubscriptionsCreateOrUpdate

ForSubscriptionsCreateOrUpdate ...

func (ConfigurationAssignmentsClient) ForSubscriptionsDelete

ForSubscriptionsDelete ...

func (ConfigurationAssignmentsClient) ForSubscriptionsGet

ForSubscriptionsGet ...

func (ConfigurationAssignmentsClient) ForSubscriptionsUpdate

ForSubscriptionsUpdate ...

func (ConfigurationAssignmentsClient) Get

Get ...

func (ConfigurationAssignmentsClient) GetParent

GetParent ...

func (ConfigurationAssignmentsClient) List

List ...

func (ConfigurationAssignmentsClient) ListParent

ListParent ...

func (ConfigurationAssignmentsClient) WithinSubscriptionList

WithinSubscriptionList ...

type CreateOrUpdateOperationResponse

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

type CreateOrUpdateParentOperationResponse

type CreateOrUpdateParentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type DeleteOperationResponse

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

type DeleteParentOperationResponse

type DeleteParentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ForResourceGroupCreateOrUpdateOperationResponse

type ForResourceGroupCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ForResourceGroupDeleteOperationResponse

type ForResourceGroupDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ForResourceGroupGetOperationResponse

type ForResourceGroupGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ForResourceGroupUpdateOperationResponse

type ForResourceGroupUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ForSubscriptionsCreateOrUpdateOperationResponse

type ForSubscriptionsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ForSubscriptionsDeleteOperationResponse

type ForSubscriptionsDeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ForSubscriptionsGetOperationResponse

type ForSubscriptionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ForSubscriptionsUpdateOperationResponse

type ForSubscriptionsUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type GetOperationResponse

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

type GetParentOperationResponse

type GetParentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConfigurationAssignment
}

type ListConfigurationAssignmentsResult

type ListConfigurationAssignmentsResult struct {
	Value *[]ConfigurationAssignment `json:"value,omitempty"`
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListConfigurationAssignmentsResult
}

type ListParentOperationResponse

type ListParentOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListConfigurationAssignmentsResult
}

type ProviderConfigurationAssignmentId

type ProviderConfigurationAssignmentId struct {
	SubscriptionId              string
	ResourceGroupName           string
	ConfigurationAssignmentName string
}

ProviderConfigurationAssignmentId is a struct representing the Resource ID for a Provider Configuration Assignment

func NewProviderConfigurationAssignmentID

func NewProviderConfigurationAssignmentID(subscriptionId string, resourceGroupName string, configurationAssignmentName string) ProviderConfigurationAssignmentId

NewProviderConfigurationAssignmentID returns a new ProviderConfigurationAssignmentId struct

func ParseProviderConfigurationAssignmentID

func ParseProviderConfigurationAssignmentID(input string) (*ProviderConfigurationAssignmentId, error)

ParseProviderConfigurationAssignmentID parses 'input' into a ProviderConfigurationAssignmentId

func ParseProviderConfigurationAssignmentIDInsensitively

func ParseProviderConfigurationAssignmentIDInsensitively(input string) (*ProviderConfigurationAssignmentId, error)

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

func (ProviderConfigurationAssignmentId) ID

ID returns the formatted Provider Configuration Assignment ID

func (ProviderConfigurationAssignmentId) Segments

Segments returns a slice of Resource ID Segments which comprise this Provider Configuration Assignment ID

func (ProviderConfigurationAssignmentId) String

String returns a human-readable description of this Provider Configuration Assignment ID

type ScopedConfigurationAssignmentId added in v0.20230717.1131407

type ScopedConfigurationAssignmentId struct {
	Scope                       string
	ConfigurationAssignmentName string
}

ScopedConfigurationAssignmentId is a struct representing the Resource ID for a Scoped Configuration Assignment

func NewScopedConfigurationAssignmentID added in v0.20230717.1131407

func NewScopedConfigurationAssignmentID(scope string, configurationAssignmentName string) ScopedConfigurationAssignmentId

NewScopedConfigurationAssignmentID returns a new ScopedConfigurationAssignmentId struct

func ParseScopedConfigurationAssignmentID added in v0.20230717.1131407

func ParseScopedConfigurationAssignmentID(input string) (*ScopedConfigurationAssignmentId, error)

ParseScopedConfigurationAssignmentID parses 'input' into a ScopedConfigurationAssignmentId

func ParseScopedConfigurationAssignmentIDInsensitively added in v0.20230717.1131407

func ParseScopedConfigurationAssignmentIDInsensitively(input string) (*ScopedConfigurationAssignmentId, error)

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

func (ScopedConfigurationAssignmentId) ID added in v0.20230717.1131407

ID returns the formatted Scoped Configuration Assignment ID

func (ScopedConfigurationAssignmentId) Segments added in v0.20230717.1131407

Segments returns a slice of Resource ID Segments which comprise this Scoped Configuration Assignment ID

func (ScopedConfigurationAssignmentId) String added in v0.20230717.1131407

String returns a human-readable description of this Scoped Configuration Assignment ID

type TagOperators

type TagOperators string
const (
	TagOperatorsAll TagOperators = "All"
	TagOperatorsAny TagOperators = "Any"
)

func (*TagOperators) UnmarshalJSON added in v0.20230717.1131407

func (s *TagOperators) UnmarshalJSON(bytes []byte) error

type TagSettingsProperties

type TagSettingsProperties struct {
	FilterOperator *TagOperators        `json:"filterOperator,omitempty"`
	Tags           *map[string][]string `json:"tags,omitempty"`
}

type WithinSubscriptionListOperationResponse

type WithinSubscriptionListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ListConfigurationAssignmentsResult
}

Jump to

Keyboard shortcuts

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