applications

package
v0.20240923.1142107 Latest Latest
Warning

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

Go to latest
Published: Sep 23, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/hdinsight/2021-06-01/applications Documentation

The applications SDK allows for interaction with Azure Resource Manager hdinsight (API Version 2021-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/hdinsight/2021-06-01/applications"

Client Initialization

client := applications.NewApplicationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApplicationsClient.Create

ctx := context.TODO()
id := applications.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

payload := applications.Application{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ApplicationsClient.Delete

ctx := context.TODO()
id := applications.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ApplicationsClient.Get

ctx := context.TODO()
id := applications.NewApplicationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "applicationName")

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: ApplicationsClient.ListByCluster

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

// alternatively `client.ListByCluster(ctx, id)` can be used to do batched pagination
items, err := client.ListByClusterComplete(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 PossibleValuesForDaysOfWeek

func PossibleValuesForDaysOfWeek() []string

func PossibleValuesForPrivateIPAllocationMethod

func PossibleValuesForPrivateIPAllocationMethod() []string

func PossibleValuesForPrivateLinkConfigurationProvisioningState

func PossibleValuesForPrivateLinkConfigurationProvisioningState() []string

func ValidateApplicationID

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

ValidateApplicationID checks that 'input' can be parsed as a Application ID

Types

type Application

type Application struct {
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *ApplicationProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ApplicationGetEndpoint

type ApplicationGetEndpoint struct {
	DestinationPort  *int64  `json:"destinationPort,omitempty"`
	Location         *string `json:"location,omitempty"`
	PrivateIPAddress *string `json:"privateIPAddress,omitempty"`
	PublicPort       *int64  `json:"publicPort,omitempty"`
}

type ApplicationGetHTTPSEndpoint

type ApplicationGetHTTPSEndpoint struct {
	AccessModes        *[]string `json:"accessModes,omitempty"`
	DestinationPort    *int64    `json:"destinationPort,omitempty"`
	DisableGatewayAuth *bool     `json:"disableGatewayAuth,omitempty"`
	Location           *string   `json:"location,omitempty"`
	PrivateIPAddress   *string   `json:"privateIPAddress,omitempty"`
	PublicPort         *int64    `json:"publicPort,omitempty"`
	SubDomainSuffix    *string   `json:"subDomainSuffix,omitempty"`
}

type ApplicationId

type ApplicationId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
	ApplicationName   string
}

ApplicationId is a struct representing the Resource ID for a Application

func NewApplicationID

func NewApplicationID(subscriptionId string, resourceGroupName string, clusterName string, applicationName string) ApplicationId

NewApplicationID returns a new ApplicationId struct

func ParseApplicationID

func ParseApplicationID(input string) (*ApplicationId, error)

ParseApplicationID parses 'input' into a ApplicationId

func ParseApplicationIDInsensitively

func ParseApplicationIDInsensitively(input string) (*ApplicationId, error)

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

func (*ApplicationId) FromParseResult

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

func (ApplicationId) ID

func (id ApplicationId) ID() string

ID returns the formatted Application ID

func (ApplicationId) Segments

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

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

func (ApplicationId) String

func (id ApplicationId) String() string

String returns a human-readable description of this Application ID

type ApplicationOperationPredicate

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

func (ApplicationOperationPredicate) Matches

type ApplicationProperties

type ApplicationProperties struct {
	ApplicationState          *string                        `json:"applicationState,omitempty"`
	ApplicationType           *string                        `json:"applicationType,omitempty"`
	ComputeProfile            *ComputeProfile                `json:"computeProfile,omitempty"`
	CreatedDate               *string                        `json:"createdDate,omitempty"`
	Errors                    *[]Errors                      `json:"errors,omitempty"`
	HTTPSEndpoints            *[]ApplicationGetHTTPSEndpoint `json:"httpsEndpoints,omitempty"`
	InstallScriptActions      *[]RuntimeScriptAction         `json:"installScriptActions,omitempty"`
	MarketplaceIdentifier     *string                        `json:"marketplaceIdentifier,omitempty"`
	PrivateLinkConfigurations *[]PrivateLinkConfiguration    `json:"privateLinkConfigurations,omitempty"`
	ProvisioningState         *string                        `json:"provisioningState,omitempty"`
	SshEndpoints              *[]ApplicationGetEndpoint      `json:"sshEndpoints,omitempty"`
	UninstallScriptActions    *[]RuntimeScriptAction         `json:"uninstallScriptActions,omitempty"`
}

type ApplicationsClient

type ApplicationsClient struct {
	Client *resourcemanager.Client
}

func NewApplicationsClientWithBaseURI

func NewApplicationsClientWithBaseURI(sdkApi sdkEnv.Api) (*ApplicationsClient, error)

func (ApplicationsClient) Create

Create ...

func (ApplicationsClient) CreateThenPoll

func (c ApplicationsClient) CreateThenPoll(ctx context.Context, id ApplicationId, input Application) error

CreateThenPoll performs Create then polls until it's completed

func (ApplicationsClient) Delete

Delete ...

func (ApplicationsClient) DeleteThenPoll

func (c ApplicationsClient) DeleteThenPoll(ctx context.Context, id ApplicationId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ApplicationsClient) Get

Get ...

func (ApplicationsClient) ListByCluster

ListByCluster ...

func (ApplicationsClient) ListByClusterComplete

ListByClusterComplete retrieves all the results into a single object

func (ApplicationsClient) ListByClusterCompleteMatchingPredicate

func (c ApplicationsClient) ListByClusterCompleteMatchingPredicate(ctx context.Context, id commonids.HDInsightClusterId, predicate ApplicationOperationPredicate) (result ListByClusterCompleteResult, err error)

ListByClusterCompleteMatchingPredicate retrieves all the results and then applies the predicate

type Autoscale

type Autoscale struct {
	Capacity   *AutoscaleCapacity   `json:"capacity,omitempty"`
	Recurrence *AutoscaleRecurrence `json:"recurrence,omitempty"`
}

type AutoscaleCapacity

type AutoscaleCapacity struct {
	MaxInstanceCount *int64 `json:"maxInstanceCount,omitempty"`
	MinInstanceCount *int64 `json:"minInstanceCount,omitempty"`
}

type AutoscaleRecurrence

type AutoscaleRecurrence struct {
	Schedule *[]AutoscaleSchedule `json:"schedule,omitempty"`
	TimeZone *string              `json:"timeZone,omitempty"`
}

type AutoscaleSchedule

type AutoscaleSchedule struct {
	Days            *[]DaysOfWeek             `json:"days,omitempty"`
	TimeAndCapacity *AutoscaleTimeAndCapacity `json:"timeAndCapacity,omitempty"`
}

type AutoscaleTimeAndCapacity

type AutoscaleTimeAndCapacity struct {
	MaxInstanceCount *int64  `json:"maxInstanceCount,omitempty"`
	MinInstanceCount *int64  `json:"minInstanceCount,omitempty"`
	Time             *string `json:"time,omitempty"`
}

type ComputeProfile

type ComputeProfile struct {
	Roles *[]Role `json:"roles,omitempty"`
}

type CreateOperationResponse

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Application
}

type DataDisksGroups

type DataDisksGroups struct {
	DiskSizeGB         *int64  `json:"diskSizeGB,omitempty"`
	DisksPerNode       *int64  `json:"disksPerNode,omitempty"`
	StorageAccountType *string `json:"storageAccountType,omitempty"`
}

type DaysOfWeek

type DaysOfWeek string
const (
	DaysOfWeekFriday    DaysOfWeek = "Friday"
	DaysOfWeekMonday    DaysOfWeek = "Monday"
	DaysOfWeekSaturday  DaysOfWeek = "Saturday"
	DaysOfWeekSunday    DaysOfWeek = "Sunday"
	DaysOfWeekThursday  DaysOfWeek = "Thursday"
	DaysOfWeekTuesday   DaysOfWeek = "Tuesday"
	DaysOfWeekWednesday DaysOfWeek = "Wednesday"
)

func (*DaysOfWeek) UnmarshalJSON

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

type DeleteOperationResponse

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

type Errors

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

type GetOperationResponse

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

type HardwareProfile

type HardwareProfile struct {
	VMSize *string `json:"vmSize,omitempty"`
}

type IPConfiguration

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

type IPConfigurationProperties

type IPConfigurationProperties struct {
	Primary                   *bool                                      `json:"primary,omitempty"`
	PrivateIPAddress          *string                                    `json:"privateIPAddress,omitempty"`
	PrivateIPAllocationMethod *PrivateIPAllocationMethod                 `json:"privateIPAllocationMethod,omitempty"`
	ProvisioningState         *PrivateLinkConfigurationProvisioningState `json:"provisioningState,omitempty"`
	Subnet                    *ResourceId                                `json:"subnet,omitempty"`
}

type LinuxOperatingSystemProfile

type LinuxOperatingSystemProfile struct {
	Password   *string     `json:"password,omitempty"`
	SshProfile *SshProfile `json:"sshProfile,omitempty"`
	Username   *string     `json:"username,omitempty"`
}

type ListByClusterCompleteResult

type ListByClusterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Application
}

type ListByClusterCustomPager added in v0.20240628.1153531

type ListByClusterCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByClusterCustomPager) NextPageLink() *odata.Link

type ListByClusterOperationResponse

type ListByClusterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Application
}

type OsProfile

type OsProfile struct {
	LinuxOperatingSystemProfile *LinuxOperatingSystemProfile `json:"linuxOperatingSystemProfile,omitempty"`
}

type PrivateIPAllocationMethod

type PrivateIPAllocationMethod string
const (
	PrivateIPAllocationMethodDynamic PrivateIPAllocationMethod = "dynamic"
	PrivateIPAllocationMethodStatic  PrivateIPAllocationMethod = "static"
)

func (*PrivateIPAllocationMethod) UnmarshalJSON

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

type PrivateLinkConfiguration

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

type PrivateLinkConfigurationProperties

type PrivateLinkConfigurationProperties struct {
	GroupId           string                                     `json:"groupId"`
	IPConfigurations  []IPConfiguration                          `json:"ipConfigurations"`
	ProvisioningState *PrivateLinkConfigurationProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateLinkConfigurationProvisioningState

type PrivateLinkConfigurationProvisioningState string
const (
	PrivateLinkConfigurationProvisioningStateCanceled   PrivateLinkConfigurationProvisioningState = "Canceled"
	PrivateLinkConfigurationProvisioningStateDeleting   PrivateLinkConfigurationProvisioningState = "Deleting"
	PrivateLinkConfigurationProvisioningStateFailed     PrivateLinkConfigurationProvisioningState = "Failed"
	PrivateLinkConfigurationProvisioningStateInProgress PrivateLinkConfigurationProvisioningState = "InProgress"
	PrivateLinkConfigurationProvisioningStateSucceeded  PrivateLinkConfigurationProvisioningState = "Succeeded"
)

func (*PrivateLinkConfigurationProvisioningState) UnmarshalJSON

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

type ResourceId

type ResourceId struct {
	Id *string `json:"id,omitempty"`
}

type Role

type Role struct {
	Autoscale             *Autoscale             `json:"autoscale,omitempty"`
	DataDisksGroups       *[]DataDisksGroups     `json:"dataDisksGroups,omitempty"`
	EncryptDataDisks      *bool                  `json:"encryptDataDisks,omitempty"`
	HardwareProfile       *HardwareProfile       `json:"hardwareProfile,omitempty"`
	MinInstanceCount      *int64                 `json:"minInstanceCount,omitempty"`
	Name                  *string                `json:"name,omitempty"`
	OsProfile             *OsProfile             `json:"osProfile,omitempty"`
	ScriptActions         *[]ScriptAction        `json:"scriptActions,omitempty"`
	TargetInstanceCount   *int64                 `json:"targetInstanceCount,omitempty"`
	VMGroupName           *string                `json:"VMGroupName,omitempty"`
	VirtualNetworkProfile *VirtualNetworkProfile `json:"virtualNetworkProfile,omitempty"`
}

type RuntimeScriptAction

type RuntimeScriptAction struct {
	ApplicationName *string  `json:"applicationName,omitempty"`
	Name            string   `json:"name"`
	Parameters      *string  `json:"parameters,omitempty"`
	Roles           []string `json:"roles"`
	Uri             string   `json:"uri"`
}

type ScriptAction

type ScriptAction struct {
	Name       string `json:"name"`
	Parameters string `json:"parameters"`
	Uri        string `json:"uri"`
}

type SshProfile

type SshProfile struct {
	PublicKeys *[]SshPublicKey `json:"publicKeys,omitempty"`
}

type SshPublicKey

type SshPublicKey struct {
	CertificateData *string `json:"certificateData,omitempty"`
}

type VirtualNetworkProfile

type VirtualNetworkProfile struct {
	Id     *string `json:"id,omitempty"`
	Subnet *string `json:"subnet,omitempty"`
}

Jump to

Keyboard shortcuts

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