globalparameters

package
v0.20231020.1124011 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/datafactory/2018-06-01/globalparameters Documentation

The globalparameters SDK allows for interaction with the Azure Resource Manager Service datafactory (API Version 2018-06-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/datafactory/2018-06-01/globalparameters"

Client Initialization

client := globalparameters.NewGlobalParametersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GlobalParametersClient.CreateOrUpdate

ctx := context.TODO()
id := globalparameters.NewGlobalParameterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "globalParameterValue")

payload := globalparameters.GlobalParameterResource{
	// ...
}


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: GlobalParametersClient.Delete

ctx := context.TODO()
id := globalparameters.NewGlobalParameterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "globalParameterValue")

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: GlobalParametersClient.Get

ctx := context.TODO()
id := globalparameters.NewGlobalParameterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "factoryValue", "globalParameterValue")

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: GlobalParametersClient.ListByFactory

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForGlobalParameterType

func PossibleValuesForGlobalParameterType() []string

func ValidateFactoryID

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

ValidateFactoryID checks that 'input' can be parsed as a Factory ID

func ValidateGlobalParameterID

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

ValidateGlobalParameterID checks that 'input' can be parsed as a Global Parameter ID

Types

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type FactoryId

type FactoryId struct {
	SubscriptionId    string
	ResourceGroupName string
	FactoryName       string
}

FactoryId is a struct representing the Resource ID for a Factory

func NewFactoryID

func NewFactoryID(subscriptionId string, resourceGroupName string, factoryName string) FactoryId

NewFactoryID returns a new FactoryId struct

func ParseFactoryID

func ParseFactoryID(input string) (*FactoryId, error)

ParseFactoryID parses 'input' into a FactoryId

func ParseFactoryIDInsensitively

func ParseFactoryIDInsensitively(input string) (*FactoryId, error)

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

func (FactoryId) ID

func (id FactoryId) ID() string

ID returns the formatted Factory ID

func (FactoryId) Segments

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

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

func (FactoryId) String

func (id FactoryId) String() string

String returns a human-readable description of this Factory ID

type GetOperationResponse

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

type GlobalParameterId

type GlobalParameterId struct {
	SubscriptionId      string
	ResourceGroupName   string
	FactoryName         string
	GlobalParameterName string
}

GlobalParameterId is a struct representing the Resource ID for a Global Parameter

func NewGlobalParameterID

func NewGlobalParameterID(subscriptionId string, resourceGroupName string, factoryName string, globalParameterName string) GlobalParameterId

NewGlobalParameterID returns a new GlobalParameterId struct

func ParseGlobalParameterID

func ParseGlobalParameterID(input string) (*GlobalParameterId, error)

ParseGlobalParameterID parses 'input' into a GlobalParameterId

func ParseGlobalParameterIDInsensitively

func ParseGlobalParameterIDInsensitively(input string) (*GlobalParameterId, error)

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

func (GlobalParameterId) ID

func (id GlobalParameterId) ID() string

ID returns the formatted Global Parameter ID

func (GlobalParameterId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Global Parameter ID

func (GlobalParameterId) String

func (id GlobalParameterId) String() string

String returns a human-readable description of this Global Parameter ID

type GlobalParameterResource

type GlobalParameterResource struct {
	Etag       *string                                 `json:"etag,omitempty"`
	Id         *string                                 `json:"id,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties map[string]GlobalParameterSpecification `json:"properties"`
	Type       *string                                 `json:"type,omitempty"`
}

type GlobalParameterResourceOperationPredicate

type GlobalParameterResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (GlobalParameterResourceOperationPredicate) Matches

type GlobalParameterSpecification

type GlobalParameterSpecification struct {
	Type  GlobalParameterType `json:"type"`
	Value interface{}         `json:"value"`
}

type GlobalParameterType

type GlobalParameterType string
const (
	GlobalParameterTypeArray  GlobalParameterType = "Array"
	GlobalParameterTypeBool   GlobalParameterType = "Bool"
	GlobalParameterTypeFloat  GlobalParameterType = "Float"
	GlobalParameterTypeInt    GlobalParameterType = "Int"
	GlobalParameterTypeObject GlobalParameterType = "Object"
	GlobalParameterTypeString GlobalParameterType = "String"
)

func (*GlobalParameterType) UnmarshalJSON added in v0.20230516.1215417

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

type GlobalParametersClient

type GlobalParametersClient struct {
	Client *resourcemanager.Client
}

func NewGlobalParametersClientWithBaseURI

func NewGlobalParametersClientWithBaseURI(sdkApi sdkEnv.Api) (*GlobalParametersClient, error)

func (GlobalParametersClient) CreateOrUpdate

CreateOrUpdate ...

func (GlobalParametersClient) Delete

Delete ...

func (GlobalParametersClient) Get

Get ...

func (GlobalParametersClient) ListByFactory

ListByFactory ...

func (GlobalParametersClient) ListByFactoryComplete

ListByFactoryComplete retrieves all the results into a single object

func (GlobalParametersClient) ListByFactoryCompleteMatchingPredicate

func (c GlobalParametersClient) ListByFactoryCompleteMatchingPredicate(ctx context.Context, id FactoryId, predicate GlobalParameterResourceOperationPredicate) (result ListByFactoryCompleteResult, err error)

ListByFactoryCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListByFactoryCompleteResult

type ListByFactoryCompleteResult struct {
	Items []GlobalParameterResource
}

type ListByFactoryOperationResponse

type ListByFactoryOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GlobalParameterResource
}

Jump to

Keyboard shortcuts

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