sapapplicationserverinstances

package
v0.20240227.1165506 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/workloads/2023-04-01/sapapplicationserverinstances Documentation

The sapapplicationserverinstances SDK allows for interaction with the Azure Resource Manager Service workloads (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/workloads/2023-04-01/sapapplicationserverinstances"

Client Initialization

client := sapapplicationserverinstances.NewSAPApplicationServerInstancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SAPApplicationServerInstancesClient.Create

ctx := context.TODO()
id := sapapplicationserverinstances.NewApplicationInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "applicationInstanceValue")

payload := sapapplicationserverinstances.SAPApplicationServerInstance{
	// ...
}


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

Example Usage: SAPApplicationServerInstancesClient.Delete

ctx := context.TODO()
id := sapapplicationserverinstances.NewApplicationInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "applicationInstanceValue")

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

Example Usage: SAPApplicationServerInstancesClient.Get

ctx := context.TODO()
id := sapapplicationserverinstances.NewApplicationInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "applicationInstanceValue")

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

ctx := context.TODO()
id := sapapplicationserverinstances.NewSapVirtualInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue")

// 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
}

Example Usage: SAPApplicationServerInstancesClient.StartInstance

ctx := context.TODO()
id := sapapplicationserverinstances.NewApplicationInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "applicationInstanceValue")

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

Example Usage: SAPApplicationServerInstancesClient.StopInstance

ctx := context.TODO()
id := sapapplicationserverinstances.NewApplicationInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "applicationInstanceValue")

payload := sapapplicationserverinstances.StopRequest{
	// ...
}


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

Example Usage: SAPApplicationServerInstancesClient.Update

ctx := context.TODO()
id := sapapplicationserverinstances.NewApplicationInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceValue", "applicationInstanceValue")

payload := sapapplicationserverinstances.UpdateSAPApplicationInstanceRequest{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForApplicationServerVirtualMachineType

func PossibleValuesForApplicationServerVirtualMachineType() []string

func PossibleValuesForSAPHealthState

func PossibleValuesForSAPHealthState() []string

func PossibleValuesForSAPVirtualInstanceStatus

func PossibleValuesForSAPVirtualInstanceStatus() []string

func PossibleValuesForSapVirtualInstanceProvisioningState

func PossibleValuesForSapVirtualInstanceProvisioningState() []string

func ValidateApplicationInstanceID

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

ValidateApplicationInstanceID checks that 'input' can be parsed as a Application Instance ID

func ValidateSapVirtualInstanceID

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

ValidateSapVirtualInstanceID checks that 'input' can be parsed as a Sap Virtual Instance ID

Types

type ApplicationInstanceId

type ApplicationInstanceId struct {
	SubscriptionId          string
	ResourceGroupName       string
	SapVirtualInstanceName  string
	ApplicationInstanceName string
}

ApplicationInstanceId is a struct representing the Resource ID for a Application Instance

func NewApplicationInstanceID

func NewApplicationInstanceID(subscriptionId string, resourceGroupName string, sapVirtualInstanceName string, applicationInstanceName string) ApplicationInstanceId

NewApplicationInstanceID returns a new ApplicationInstanceId struct

func ParseApplicationInstanceID

func ParseApplicationInstanceID(input string) (*ApplicationInstanceId, error)

ParseApplicationInstanceID parses 'input' into a ApplicationInstanceId

func ParseApplicationInstanceIDInsensitively

func ParseApplicationInstanceIDInsensitively(input string) (*ApplicationInstanceId, error)

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

func (*ApplicationInstanceId) FromParseResult

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

func (ApplicationInstanceId) ID

func (id ApplicationInstanceId) ID() string

ID returns the formatted Application Instance ID

func (ApplicationInstanceId) Segments

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

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

func (ApplicationInstanceId) String

func (id ApplicationInstanceId) String() string

String returns a human-readable description of this Application Instance ID

type ApplicationServerVMDetails

type ApplicationServerVMDetails struct {
	StorageDetails   *[]StorageInformation                `json:"storageDetails,omitempty"`
	Type             *ApplicationServerVirtualMachineType `json:"type,omitempty"`
	VirtualMachineId *string                              `json:"virtualMachineId,omitempty"`
}

type ApplicationServerVirtualMachineType

type ApplicationServerVirtualMachineType string
const (
	ApplicationServerVirtualMachineTypeActive  ApplicationServerVirtualMachineType = "Active"
	ApplicationServerVirtualMachineTypeStandby ApplicationServerVirtualMachineType = "Standby"
	ApplicationServerVirtualMachineTypeUnknown ApplicationServerVirtualMachineType = "Unknown"
)

func (*ApplicationServerVirtualMachineType) UnmarshalJSON

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

type CreateOperationResponse

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

type DeleteOperationResponse

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

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,omitempty"`
}

type ErrorDefinition

type ErrorDefinition struct {
	Code    *string            `json:"code,omitempty"`
	Details *[]ErrorDefinition `json:"details,omitempty"`
	Message *string            `json:"message,omitempty"`
}

type ErrorDetail

type ErrorDetail struct {
	AdditionalInfo *[]ErrorAdditionalInfo `json:"additionalInfo,omitempty"`
	Code           *string                `json:"code,omitempty"`
	Details        *[]ErrorDetail         `json:"details,omitempty"`
	Message        *string                `json:"message,omitempty"`
	Target         *string                `json:"target,omitempty"`
}

type GetOperationResponse

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

type ListCompleteResult

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

type ListOperationResponse

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

type LoadBalancerDetails

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

type OperationStatusResult

type OperationStatusResult struct {
	EndTime         *string                  `json:"endTime,omitempty"`
	Error           *ErrorDetail             `json:"error,omitempty"`
	Id              *string                  `json:"id,omitempty"`
	Name            *string                  `json:"name,omitempty"`
	Operations      *[]OperationStatusResult `json:"operations,omitempty"`
	PercentComplete *float64                 `json:"percentComplete,omitempty"`
	StartTime       *string                  `json:"startTime,omitempty"`
	Status          string                   `json:"status"`
}

func (*OperationStatusResult) GetEndTimeAsTime

func (o *OperationStatusResult) GetEndTimeAsTime() (*time.Time, error)

func (*OperationStatusResult) GetStartTimeAsTime

func (o *OperationStatusResult) GetStartTimeAsTime() (*time.Time, error)

func (*OperationStatusResult) SetEndTimeAsTime

func (o *OperationStatusResult) SetEndTimeAsTime(input time.Time)

func (*OperationStatusResult) SetStartTimeAsTime

func (o *OperationStatusResult) SetStartTimeAsTime(input time.Time)

type SAPApplicationServerInstance

type SAPApplicationServerInstance struct {
	Id         *string                         `json:"id,omitempty"`
	Location   string                          `json:"location"`
	Name       *string                         `json:"name,omitempty"`
	Properties *SAPApplicationServerProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData          `json:"systemData,omitempty"`
	Tags       *map[string]string              `json:"tags,omitempty"`
	Type       *string                         `json:"type,omitempty"`
}

type SAPApplicationServerInstanceOperationPredicate

type SAPApplicationServerInstanceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (SAPApplicationServerInstanceOperationPredicate) Matches

type SAPApplicationServerInstancesClient

type SAPApplicationServerInstancesClient struct {
	Client *resourcemanager.Client
}

func NewSAPApplicationServerInstancesClientWithBaseURI

func NewSAPApplicationServerInstancesClientWithBaseURI(sdkApi sdkEnv.Api) (*SAPApplicationServerInstancesClient, error)

func (SAPApplicationServerInstancesClient) Create

Create ...

func (SAPApplicationServerInstancesClient) CreateThenPoll

CreateThenPoll performs Create then polls until it's completed

func (SAPApplicationServerInstancesClient) Delete

Delete ...

func (SAPApplicationServerInstancesClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (SAPApplicationServerInstancesClient) Get

Get ...

func (SAPApplicationServerInstancesClient) List

List ...

func (SAPApplicationServerInstancesClient) ListComplete

ListComplete retrieves all the results into a single object

func (SAPApplicationServerInstancesClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SAPApplicationServerInstancesClient) StartInstance

StartInstance ...

func (SAPApplicationServerInstancesClient) StartInstanceThenPoll

StartInstanceThenPoll performs StartInstance then polls until it's completed

func (SAPApplicationServerInstancesClient) StopInstance

StopInstance ...

func (SAPApplicationServerInstancesClient) StopInstanceThenPoll

StopInstanceThenPoll performs StopInstance then polls until it's completed

func (SAPApplicationServerInstancesClient) Update

Update ...

func (SAPApplicationServerInstancesClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type SAPApplicationServerProperties

type SAPApplicationServerProperties struct {
	Errors              *SAPVirtualInstanceError             `json:"errors,omitempty"`
	GatewayPort         *int64                               `json:"gatewayPort,omitempty"`
	Health              *SAPHealthState                      `json:"health,omitempty"`
	Hostname            *string                              `json:"hostname,omitempty"`
	IPAddress           *string                              `json:"ipAddress,omitempty"`
	IcmHTTPPort         *int64                               `json:"icmHttpPort,omitempty"`
	IcmHTTPSPort        *int64                               `json:"icmHttpsPort,omitempty"`
	InstanceNo          *string                              `json:"instanceNo,omitempty"`
	KernelPatch         *string                              `json:"kernelPatch,omitempty"`
	KernelVersion       *string                              `json:"kernelVersion,omitempty"`
	LoadBalancerDetails *LoadBalancerDetails                 `json:"loadBalancerDetails,omitempty"`
	ProvisioningState   *SapVirtualInstanceProvisioningState `json:"provisioningState,omitempty"`
	Status              *SAPVirtualInstanceStatus            `json:"status,omitempty"`
	Subnet              *string                              `json:"subnet,omitempty"`
	VMDetails           *[]ApplicationServerVMDetails        `json:"vmDetails,omitempty"`
}

type SAPHealthState

type SAPHealthState string
const (
	SAPHealthStateDegraded  SAPHealthState = "Degraded"
	SAPHealthStateHealthy   SAPHealthState = "Healthy"
	SAPHealthStateUnhealthy SAPHealthState = "Unhealthy"
	SAPHealthStateUnknown   SAPHealthState = "Unknown"
)

func (*SAPHealthState) UnmarshalJSON

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

type SAPVirtualInstanceError

type SAPVirtualInstanceError struct {
	Properties *ErrorDefinition `json:"properties,omitempty"`
}

type SAPVirtualInstanceStatus

type SAPVirtualInstanceStatus string
const (
	SAPVirtualInstanceStatusOffline          SAPVirtualInstanceStatus = "Offline"
	SAPVirtualInstanceStatusPartiallyRunning SAPVirtualInstanceStatus = "PartiallyRunning"
	SAPVirtualInstanceStatusRunning          SAPVirtualInstanceStatus = "Running"
	SAPVirtualInstanceStatusSoftShutdown     SAPVirtualInstanceStatus = "SoftShutdown"
	SAPVirtualInstanceStatusStarting         SAPVirtualInstanceStatus = "Starting"
	SAPVirtualInstanceStatusStopping         SAPVirtualInstanceStatus = "Stopping"
	SAPVirtualInstanceStatusUnavailable      SAPVirtualInstanceStatus = "Unavailable"
)

func (*SAPVirtualInstanceStatus) UnmarshalJSON

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

type SapVirtualInstanceId

type SapVirtualInstanceId struct {
	SubscriptionId         string
	ResourceGroupName      string
	SapVirtualInstanceName string
}

SapVirtualInstanceId is a struct representing the Resource ID for a Sap Virtual Instance

func NewSapVirtualInstanceID

func NewSapVirtualInstanceID(subscriptionId string, resourceGroupName string, sapVirtualInstanceName string) SapVirtualInstanceId

NewSapVirtualInstanceID returns a new SapVirtualInstanceId struct

func ParseSapVirtualInstanceID

func ParseSapVirtualInstanceID(input string) (*SapVirtualInstanceId, error)

ParseSapVirtualInstanceID parses 'input' into a SapVirtualInstanceId

func ParseSapVirtualInstanceIDInsensitively

func ParseSapVirtualInstanceIDInsensitively(input string) (*SapVirtualInstanceId, error)

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

func (*SapVirtualInstanceId) FromParseResult

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

func (SapVirtualInstanceId) ID

func (id SapVirtualInstanceId) ID() string

ID returns the formatted Sap Virtual Instance ID

func (SapVirtualInstanceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Sap Virtual Instance ID

func (SapVirtualInstanceId) String

func (id SapVirtualInstanceId) String() string

String returns a human-readable description of this Sap Virtual Instance ID

type SapVirtualInstanceProvisioningState

type SapVirtualInstanceProvisioningState string
const (
	SapVirtualInstanceProvisioningStateCreating  SapVirtualInstanceProvisioningState = "Creating"
	SapVirtualInstanceProvisioningStateDeleting  SapVirtualInstanceProvisioningState = "Deleting"
	SapVirtualInstanceProvisioningStateFailed    SapVirtualInstanceProvisioningState = "Failed"
	SapVirtualInstanceProvisioningStateSucceeded SapVirtualInstanceProvisioningState = "Succeeded"
	SapVirtualInstanceProvisioningStateUpdating  SapVirtualInstanceProvisioningState = "Updating"
)

func (*SapVirtualInstanceProvisioningState) UnmarshalJSON

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

type StartInstanceOperationResponse

type StartInstanceOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationStatusResult
}

type StopInstanceOperationResponse

type StopInstanceOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OperationStatusResult
}

type StopRequest

type StopRequest struct {
	SoftStopTimeoutSeconds *int64 `json:"softStopTimeoutSeconds,omitempty"`
}

type StorageInformation

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SAPApplicationServerInstance
}

type UpdateSAPApplicationInstanceRequest

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

Jump to

Keyboard shortcuts

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