autoprovisioningsettings

README

github.com/hashicorp/go-azure-sdk/resource-manager/security/2017-08-01-preview/autoprovisioningsettings Documentation

The autoprovisioningsettings SDK allows for interaction with the Azure Resource Manager Service security (API Version 2017-08-01-preview).

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/security/2017-08-01-preview/autoprovisioningsettings"

Client Initialization

client := autoprovisioningsettings.NewAutoProvisioningSettingsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AutoProvisioningSettingsClient.Create

ctx := context.TODO()
id := autoprovisioningsettings.NewAutoProvisioningSettingID("12345678-1234-9876-4563-123456789012", "autoProvisioningSettingValue")

payload := autoprovisioningsettings.AutoProvisioningSetting{
	// ...
}


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

Example Usage: AutoProvisioningSettingsClient.Get

ctx := context.TODO()
id := autoprovisioningsettings.NewAutoProvisioningSettingID("12345678-1234-9876-4563-123456789012", "autoProvisioningSettingValue")

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: AutoProvisioningSettingsClient.List

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

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForAutoProvision() []string
• func ValidateAutoProvisioningSettingID(input interface{}, key string) (warnings []string, errors []error)
• type AutoProvision
  • func (s *AutoProvision) UnmarshalJSON(bytes []byte) error
• type AutoProvisioningSetting
• type AutoProvisioningSettingId
  • func NewAutoProvisioningSettingID(subscriptionId string, autoProvisioningSettingName string) AutoProvisioningSettingId
  • func ParseAutoProvisioningSettingID(input string) (*AutoProvisioningSettingId, error)
  • func ParseAutoProvisioningSettingIDInsensitively(input string) (*AutoProvisioningSettingId, error)
  • func (id *AutoProvisioningSettingId) FromParseResult(input resourceids.ParseResult) error
  • func (id AutoProvisioningSettingId) ID() string
  • func (id AutoProvisioningSettingId) Segments() []resourceids.Segment
  • func (id AutoProvisioningSettingId) String() string
• type AutoProvisioningSettingOperationPredicate
  • func (p AutoProvisioningSettingOperationPredicate) Matches(input AutoProvisioningSetting) bool
• type AutoProvisioningSettingProperties
• type AutoProvisioningSettingsClient
  • func NewAutoProvisioningSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*AutoProvisioningSettingsClient, error)
  • func (c AutoProvisioningSettingsClient) Create(ctx context.Context, id AutoProvisioningSettingId, ...) (result CreateOperationResponse, err error)
  • func (c AutoProvisioningSettingsClient) Get(ctx context.Context, id AutoProvisioningSettingId) (result GetOperationResponse, err error)
  • func (c AutoProvisioningSettingsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c AutoProvisioningSettingsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c AutoProvisioningSettingsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
• type CreateOperationResponse
• type GetOperationResponse
• type ListCompleteResult
• type ListOperationResponse

Functions

func PossibleValuesForAutoProvision

func PossibleValuesForAutoProvision() []string

func ValidateAutoProvisioningSettingID

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

ValidateAutoProvisioningSettingID checks that 'input' can be parsed as a Auto Provisioning Setting ID

Types

type AutoProvision

type AutoProvision string

const (
	AutoProvisionOff AutoProvision = "Off"
	AutoProvisionOn  AutoProvision = "On"
)

func (*AutoProvision) UnmarshalJSON

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

type AutoProvisioningSetting

type AutoProvisioningSetting struct {
	Id         *string                            `json:"id,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *AutoProvisioningSettingProperties `json:"properties,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type AutoProvisioningSettingId

type AutoProvisioningSettingId struct {
	SubscriptionId              string
	AutoProvisioningSettingName string
}

AutoProvisioningSettingId is a struct representing the Resource ID for a Auto Provisioning Setting

func NewAutoProvisioningSettingID

func NewAutoProvisioningSettingID(subscriptionId string, autoProvisioningSettingName string) AutoProvisioningSettingId

NewAutoProvisioningSettingID returns a new AutoProvisioningSettingId struct

func ParseAutoProvisioningSettingID

func ParseAutoProvisioningSettingID(input string) (*AutoProvisioningSettingId, error)

ParseAutoProvisioningSettingID parses 'input' into a AutoProvisioningSettingId

func ParseAutoProvisioningSettingIDInsensitively

func ParseAutoProvisioningSettingIDInsensitively(input string) (*AutoProvisioningSettingId, error)

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

func (*AutoProvisioningSettingId) FromParseResult

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

func (AutoProvisioningSettingId) ID

func (id AutoProvisioningSettingId) ID() string

ID returns the formatted Auto Provisioning Setting ID

func (AutoProvisioningSettingId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Auto Provisioning Setting ID

func (AutoProvisioningSettingId) String

func (id AutoProvisioningSettingId) String() string

String returns a human-readable description of this Auto Provisioning Setting ID

type AutoProvisioningSettingOperationPredicate

type AutoProvisioningSettingOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (AutoProvisioningSettingOperationPredicate) Matches

func (p AutoProvisioningSettingOperationPredicate) Matches(input AutoProvisioningSetting) bool

type AutoProvisioningSettingProperties

type AutoProvisioningSettingProperties struct {
	AutoProvision AutoProvision `json:"autoProvision"`
}

type AutoProvisioningSettingsClient

type AutoProvisioningSettingsClient struct {
	Client *resourcemanager.Client
}

func NewAutoProvisioningSettingsClientWithBaseURI

func NewAutoProvisioningSettingsClientWithBaseURI(sdkApi sdkEnv.Api) (*AutoProvisioningSettingsClient, error)

func (AutoProvisioningSettingsClient) Create

func (c AutoProvisioningSettingsClient) Create(ctx context.Context, id AutoProvisioningSettingId, input AutoProvisioningSetting) (result CreateOperationResponse, err error)

Create ...

func (AutoProvisioningSettingsClient) Get

func (c AutoProvisioningSettingsClient) Get(ctx context.Context, id AutoProvisioningSettingId) (result GetOperationResponse, err error)

Get ...

func (AutoProvisioningSettingsClient) List

func (c AutoProvisioningSettingsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (AutoProvisioningSettingsClient) ListComplete

func (c AutoProvisioningSettingsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (AutoProvisioningSettingsClient) ListCompleteMatchingPredicate

func (c AutoProvisioningSettingsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate AutoProvisioningSettingOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AutoProvisioningSetting
}

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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