python2package

package
v0.20240530.1123407 Latest Latest
Warning

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

Go to latest
Published: May 30, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2023-11-01/python2package Documentation

The python2package SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2023-11-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/automation/2023-11-01/python2package"

Client Initialization

client := python2package.NewPython2PackageClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: Python2PackageClient.CreateOrUpdate

ctx := context.TODO()
id := python2package.NewPython2PackageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "python2PackageValue")

payload := python2package.PythonPackageCreateParameters{
	// ...
}


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

ctx := context.TODO()
id := python2package.NewPython2PackageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "python2PackageValue")

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

ctx := context.TODO()
id := python2package.NewPython2PackageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "python2PackageValue")

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: Python2PackageClient.ListByAutomationAccount

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

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

Example Usage: Python2PackageClient.Update

ctx := context.TODO()
id := python2package.NewPython2PackageID("12345678-1234-9876-4563-123456789012", "example-resource-group", "automationAccountValue", "python2PackageValue")

payload := python2package.PythonPackageUpdateParameters{
	// ...
}


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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForModuleProvisioningState

func PossibleValuesForModuleProvisioningState() []string

func ValidateAutomationAccountID

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

ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account ID

func ValidatePython2PackageID

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

ValidatePython2PackageID checks that 'input' can be parsed as a Python 2 Package ID

Types

type AutomationAccountId

type AutomationAccountId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
}

AutomationAccountId is a struct representing the Resource ID for a Automation Account

func NewAutomationAccountID

func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId

NewAutomationAccountID returns a new AutomationAccountId struct

func ParseAutomationAccountID

func ParseAutomationAccountID(input string) (*AutomationAccountId, error)

ParseAutomationAccountID parses 'input' into a AutomationAccountId

func ParseAutomationAccountIDInsensitively

func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)

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

func (*AutomationAccountId) FromParseResult

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

func (AutomationAccountId) ID

func (id AutomationAccountId) ID() string

ID returns the formatted Automation Account ID

func (AutomationAccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Automation Account ID

func (AutomationAccountId) String

func (id AutomationAccountId) String() string

String returns a human-readable description of this Automation Account ID

type ContentHash

type ContentHash struct {
	Algorithm string `json:"algorithm"`
	Value     string `json:"value"`
}
type ContentLink struct {
	ContentHash *ContentHash `json:"contentHash,omitempty"`
	Uri         *string      `json:"uri,omitempty"`
	Version     *string      `json:"version,omitempty"`
}

type CreateOrUpdateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

type ListByAutomationAccountCompleteResult

type ListByAutomationAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Module
}

type ListByAutomationAccountOperationResponse

type ListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Module
}

type Module

type Module struct {
	Etag       *string            `json:"etag,omitempty"`
	Id         *string            `json:"id,omitempty"`
	Location   *string            `json:"location,omitempty"`
	Name       *string            `json:"name,omitempty"`
	Properties *ModuleProperties  `json:"properties,omitempty"`
	Tags       *map[string]string `json:"tags,omitempty"`
	Type       *string            `json:"type,omitempty"`
}

type ModuleErrorInfo

type ModuleErrorInfo struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
}

type ModuleOperationPredicate

type ModuleOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ModuleOperationPredicate) Matches

func (p ModuleOperationPredicate) Matches(input Module) bool

type ModuleProperties

type ModuleProperties struct {
	ActivityCount     *int64                   `json:"activityCount,omitempty"`
	ContentLink       *ContentLink             `json:"contentLink,omitempty"`
	CreationTime      *string                  `json:"creationTime,omitempty"`
	Description       *string                  `json:"description,omitempty"`
	Error             *ModuleErrorInfo         `json:"error,omitempty"`
	IsComposite       *bool                    `json:"isComposite,omitempty"`
	IsGlobal          *bool                    `json:"isGlobal,omitempty"`
	LastModifiedTime  *string                  `json:"lastModifiedTime,omitempty"`
	ProvisioningState *ModuleProvisioningState `json:"provisioningState,omitempty"`
	SizeInBytes       *int64                   `json:"sizeInBytes,omitempty"`
	Version           *string                  `json:"version,omitempty"`
}

func (*ModuleProperties) GetCreationTimeAsTime

func (o *ModuleProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*ModuleProperties) GetLastModifiedTimeAsTime

func (o *ModuleProperties) GetLastModifiedTimeAsTime() (*time.Time, error)

func (*ModuleProperties) SetCreationTimeAsTime

func (o *ModuleProperties) SetCreationTimeAsTime(input time.Time)

func (*ModuleProperties) SetLastModifiedTimeAsTime

func (o *ModuleProperties) SetLastModifiedTimeAsTime(input time.Time)

type ModuleProvisioningState

type ModuleProvisioningState string
const (
	ModuleProvisioningStateActivitiesStored            ModuleProvisioningState = "ActivitiesStored"
	ModuleProvisioningStateCanceled                    ModuleProvisioningState = "Canceled"
	ModuleProvisioningStateConnectionTypeImported      ModuleProvisioningState = "ConnectionTypeImported"
	ModuleProvisioningStateContentDownloaded           ModuleProvisioningState = "ContentDownloaded"
	ModuleProvisioningStateContentRetrieved            ModuleProvisioningState = "ContentRetrieved"
	ModuleProvisioningStateContentStored               ModuleProvisioningState = "ContentStored"
	ModuleProvisioningStateContentValidated            ModuleProvisioningState = "ContentValidated"
	ModuleProvisioningStateCreated                     ModuleProvisioningState = "Created"
	ModuleProvisioningStateCreating                    ModuleProvisioningState = "Creating"
	ModuleProvisioningStateFailed                      ModuleProvisioningState = "Failed"
	ModuleProvisioningStateModuleDataStored            ModuleProvisioningState = "ModuleDataStored"
	ModuleProvisioningStateModuleImportRunbookComplete ModuleProvisioningState = "ModuleImportRunbookComplete"
	ModuleProvisioningStateRunningImportModuleRunbook  ModuleProvisioningState = "RunningImportModuleRunbook"
	ModuleProvisioningStateStartingImportModuleRunbook ModuleProvisioningState = "StartingImportModuleRunbook"
	ModuleProvisioningStateSucceeded                   ModuleProvisioningState = "Succeeded"
	ModuleProvisioningStateUpdating                    ModuleProvisioningState = "Updating"
)

func (*ModuleProvisioningState) UnmarshalJSON

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

type Python2PackageClient

type Python2PackageClient struct {
	Client *resourcemanager.Client
}

func NewPython2PackageClientWithBaseURI

func NewPython2PackageClientWithBaseURI(sdkApi sdkEnv.Api) (*Python2PackageClient, error)

func (Python2PackageClient) CreateOrUpdate

CreateOrUpdate ...

func (Python2PackageClient) Delete

Delete ...

func (Python2PackageClient) Get

Get ...

func (Python2PackageClient) ListByAutomationAccount

ListByAutomationAccount ...

func (Python2PackageClient) ListByAutomationAccountComplete

ListByAutomationAccountComplete retrieves all the results into a single object

func (Python2PackageClient) ListByAutomationAccountCompleteMatchingPredicate

func (c Python2PackageClient) ListByAutomationAccountCompleteMatchingPredicate(ctx context.Context, id AutomationAccountId, predicate ModuleOperationPredicate) (result ListByAutomationAccountCompleteResult, err error)

ListByAutomationAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (Python2PackageClient) Update

Update ...

type Python2PackageId

type Python2PackageId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
	Python2PackageName    string
}

Python2PackageId is a struct representing the Resource ID for a Python 2 Package

func NewPython2PackageID

func NewPython2PackageID(subscriptionId string, resourceGroupName string, automationAccountName string, python2PackageName string) Python2PackageId

NewPython2PackageID returns a new Python2PackageId struct

func ParsePython2PackageID

func ParsePython2PackageID(input string) (*Python2PackageId, error)

ParsePython2PackageID parses 'input' into a Python2PackageId

func ParsePython2PackageIDInsensitively

func ParsePython2PackageIDInsensitively(input string) (*Python2PackageId, error)

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

func (*Python2PackageId) FromParseResult

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

func (Python2PackageId) ID

func (id Python2PackageId) ID() string

ID returns the formatted Python 2 Package ID

func (Python2PackageId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Python 2 Package ID

func (Python2PackageId) String

func (id Python2PackageId) String() string

String returns a human-readable description of this Python 2 Package ID

type PythonPackageCreateParameters

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

type PythonPackageCreateProperties

type PythonPackageCreateProperties struct {
	ContentLink ContentLink `json:"contentLink"`
}

type PythonPackageUpdateParameters

type PythonPackageUpdateParameters struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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