sapcentralinstances

package
v0.20241009.1142232 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

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

The sapcentralinstances SDK allows for interaction with Azure Resource Manager 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/sapcentralinstances"

Client Initialization

client := sapcentralinstances.NewSAPCentralInstancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SAPCentralInstancesClient.Create

ctx := context.TODO()
id := sapcentralinstances.NewCentralInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceName", "centralInstanceName")

payload := sapcentralinstances.SAPCentralServerInstance{
	// ...
}


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

Example Usage: SAPCentralInstancesClient.Delete

ctx := context.TODO()
id := sapcentralinstances.NewCentralInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceName", "centralInstanceName")

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

Example Usage: SAPCentralInstancesClient.Get

ctx := context.TODO()
id := sapcentralinstances.NewCentralInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceName", "centralInstanceName")

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

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

// 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: SAPCentralInstancesClient.StartInstance

ctx := context.TODO()
id := sapcentralinstances.NewCentralInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceName", "centralInstanceName")

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

Example Usage: SAPCentralInstancesClient.StopInstance

ctx := context.TODO()
id := sapcentralinstances.NewCentralInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceName", "centralInstanceName")

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


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

Example Usage: SAPCentralInstancesClient.Update

ctx := context.TODO()
id := sapcentralinstances.NewCentralInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "sapVirtualInstanceName", "centralInstanceName")

payload := sapcentralinstances.UpdateSAPCentralInstanceRequest{
	// ...
}


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 PossibleValuesForCentralServerVirtualMachineType 

func PossibleValuesForCentralServerVirtualMachineType() []string

func PossibleValuesForEnqueueReplicationServerType 

func PossibleValuesForEnqueueReplicationServerType() []string

func PossibleValuesForSAPHealthState 

func PossibleValuesForSAPHealthState() []string

func PossibleValuesForSAPVirtualInstanceStatus 

func PossibleValuesForSAPVirtualInstanceStatus() []string

func PossibleValuesForSapVirtualInstanceProvisioningState 

func PossibleValuesForSapVirtualInstanceProvisioningState() []string

func ValidateCentralInstanceID 

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

ValidateCentralInstanceID checks that 'input' can be parsed as a Central 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 CentralInstanceId 

type CentralInstanceId struct {
	SubscriptionId         string
	ResourceGroupName      string
	SapVirtualInstanceName string
	CentralInstanceName    string
}

CentralInstanceId is a struct representing the Resource ID for a Central Instance

func NewCentralInstanceID 

func NewCentralInstanceID(subscriptionId string, resourceGroupName string, sapVirtualInstanceName string, centralInstanceName string) CentralInstanceId

NewCentralInstanceID returns a new CentralInstanceId struct

func ParseCentralInstanceID 

func ParseCentralInstanceID(input string) (*CentralInstanceId, error)

ParseCentralInstanceID parses 'input' into a CentralInstanceId

func ParseCentralInstanceIDInsensitively 

func ParseCentralInstanceIDInsensitively(input string) (*CentralInstanceId, error)

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

func (*CentralInstanceId) FromParseResult 

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

func (CentralInstanceId) ID 

func (id CentralInstanceId) ID() string

ID returns the formatted Central Instance ID

func (CentralInstanceId) Segments 

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

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

func (CentralInstanceId) String 

func (id CentralInstanceId) String() string

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

type CentralServerVMDetails 

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

type CentralServerVirtualMachineType 

type CentralServerVirtualMachineType string
const (
	CentralServerVirtualMachineTypeASCS        CentralServerVirtualMachineType = "ASCS"
	CentralServerVirtualMachineTypeERS         CentralServerVirtualMachineType = "ERS"
	CentralServerVirtualMachineTypeERSInactive CentralServerVirtualMachineType = "ERSInactive"
	CentralServerVirtualMachineTypePrimary     CentralServerVirtualMachineType = "Primary"
	CentralServerVirtualMachineTypeSecondary   CentralServerVirtualMachineType = "Secondary"
	CentralServerVirtualMachineTypeStandby     CentralServerVirtualMachineType = "Standby"
	CentralServerVirtualMachineTypeUnknown     CentralServerVirtualMachineType = "Unknown"
)

func (*CentralServerVirtualMachineType) UnmarshalJSON 

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

type CreateOperationResponse 

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

type DeleteOperationResponse 

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

type EnqueueReplicationServerProperties 

type EnqueueReplicationServerProperties struct {
	ErsVersion    *EnqueueReplicationServerType `json:"ersVersion,omitempty"`
	Health        *SAPHealthState               `json:"health,omitempty"`
	Hostname      *string                       `json:"hostname,omitempty"`
	IPAddress     *string                       `json:"ipAddress,omitempty"`
	InstanceNo    *string                       `json:"instanceNo,omitempty"`
	KernelPatch   *string                       `json:"kernelPatch,omitempty"`
	KernelVersion *string                       `json:"kernelVersion,omitempty"`
}

type EnqueueReplicationServerType 

type EnqueueReplicationServerType string
const (
	EnqueueReplicationServerTypeEnqueueReplicatorOne EnqueueReplicationServerType = "EnqueueReplicator1"
	EnqueueReplicationServerTypeEnqueueReplicatorTwo EnqueueReplicationServerType = "EnqueueReplicator2"
)

func (*EnqueueReplicationServerType) UnmarshalJSON 

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

type EnqueueServerProperties 

type EnqueueServerProperties struct {
	Health    *SAPHealthState `json:"health,omitempty"`
	Hostname  *string         `json:"hostname,omitempty"`
	IPAddress *string         `json:"ipAddress,omitempty"`
	Port      *int64          `json:"port,omitempty"`
}

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 GatewayServerProperties 

type GatewayServerProperties struct {
	Health *SAPHealthState `json:"health,omitempty"`
	Port   *int64          `json:"port,omitempty"`
}

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationResponse 

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

type LoadBalancerDetails 

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

type MessageServerProperties 

type MessageServerProperties struct {
	HTTPPort       *int64          `json:"httpPort,omitempty"`
	HTTPSPort      *int64          `json:"httpsPort,omitempty"`
	Health         *SAPHealthState `json:"health,omitempty"`
	Hostname       *string         `json:"hostname,omitempty"`
	IPAddress      *string         `json:"ipAddress,omitempty"`
	InternalMsPort *int64          `json:"internalMsPort,omitempty"`
	MsPort         *int64          `json:"msPort,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 SAPCentralInstancesClient 

type SAPCentralInstancesClient struct {
	Client *resourcemanager.Client
}

func NewSAPCentralInstancesClientWithBaseURI 

func NewSAPCentralInstancesClientWithBaseURI(sdkApi sdkEnv.Api) (*SAPCentralInstancesClient, error)

func (SAPCentralInstancesClient) Create 

func (c SAPCentralInstancesClient) Create(ctx context.Context, id CentralInstanceId, input SAPCentralServerInstance) (result CreateOperationResponse, err error)

Create ...

func (SAPCentralInstancesClient) CreateThenPoll 

func (c SAPCentralInstancesClient) CreateThenPoll(ctx context.Context, id CentralInstanceId, input SAPCentralServerInstance) error

CreateThenPoll performs Create then polls until it's completed

func (SAPCentralInstancesClient) Delete 

func (c SAPCentralInstancesClient) Delete(ctx context.Context, id CentralInstanceId) (result DeleteOperationResponse, err error)

Delete ...

func (SAPCentralInstancesClient) DeleteThenPoll 

func (c SAPCentralInstancesClient) DeleteThenPoll(ctx context.Context, id CentralInstanceId) error

DeleteThenPoll performs Delete then polls until it's completed

func (SAPCentralInstancesClient) Get 

func (c SAPCentralInstancesClient) Get(ctx context.Context, id CentralInstanceId) (result GetOperationResponse, err error)

Get ...

func (SAPCentralInstancesClient) List 

func (c SAPCentralInstancesClient) List(ctx context.Context, id SapVirtualInstanceId) (result ListOperationResponse, err error)

List ...

func (SAPCentralInstancesClient) ListComplete 

func (c SAPCentralInstancesClient) ListComplete(ctx context.Context, id SapVirtualInstanceId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SAPCentralInstancesClient) ListCompleteMatchingPredicate 

func (c SAPCentralInstancesClient) ListCompleteMatchingPredicate(ctx context.Context, id SapVirtualInstanceId, predicate SAPCentralServerInstanceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (SAPCentralInstancesClient) StartInstance 

func (c SAPCentralInstancesClient) StartInstance(ctx context.Context, id CentralInstanceId) (result StartInstanceOperationResponse, err error)

StartInstance ...

func (SAPCentralInstancesClient) StartInstanceThenPoll 

func (c SAPCentralInstancesClient) StartInstanceThenPoll(ctx context.Context, id CentralInstanceId) error

StartInstanceThenPoll performs StartInstance then polls until it's completed

func (SAPCentralInstancesClient) StopInstance 

func (c SAPCentralInstancesClient) StopInstance(ctx context.Context, id CentralInstanceId, input StopRequest) (result StopInstanceOperationResponse, err error)

StopInstance ...

func (SAPCentralInstancesClient) StopInstanceThenPoll 

func (c SAPCentralInstancesClient) StopInstanceThenPoll(ctx context.Context, id CentralInstanceId, input StopRequest) error

StopInstanceThenPoll performs StopInstance then polls until it's completed

func (SAPCentralInstancesClient) Update 

func (c SAPCentralInstancesClient) Update(ctx context.Context, id CentralInstanceId, input UpdateSAPCentralInstanceRequest) (result UpdateOperationResponse, err error)

Update ...

func (SAPCentralInstancesClient) UpdateThenPoll 

func (c SAPCentralInstancesClient) UpdateThenPoll(ctx context.Context, id CentralInstanceId, input UpdateSAPCentralInstanceRequest) error

UpdateThenPoll performs Update then polls until it's completed

type SAPCentralServerInstance 

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

type SAPCentralServerInstanceOperationPredicate 

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

func (SAPCentralServerInstanceOperationPredicate) Matches 

func (p SAPCentralServerInstanceOperationPredicate) Matches(input SAPCentralServerInstance) bool

type SAPCentralServerProperties 

type SAPCentralServerProperties struct {
	EnqueueReplicationServerProperties *EnqueueReplicationServerProperties  `json:"enqueueReplicationServerProperties,omitempty"`
	EnqueueServerProperties            *EnqueueServerProperties             `json:"enqueueServerProperties,omitempty"`
	Errors                             *SAPVirtualInstanceError             `json:"errors,omitempty"`
	GatewayServerProperties            *GatewayServerProperties             `json:"gatewayServerProperties,omitempty"`
	Health                             *SAPHealthState                      `json:"health,omitempty"`
	InstanceNo                         *string                              `json:"instanceNo,omitempty"`
	KernelPatch                        *string                              `json:"kernelPatch,omitempty"`
	KernelVersion                      *string                              `json:"kernelVersion,omitempty"`
	LoadBalancerDetails                *LoadBalancerDetails                 `json:"loadBalancerDetails,omitempty"`
	MessageServerProperties            *MessageServerProperties             `json:"messageServerProperties,omitempty"`
	ProvisioningState                  *SapVirtualInstanceProvisioningState `json:"provisioningState,omitempty"`
	Status                             *SAPVirtualInstanceStatus            `json:"status,omitempty"`
	Subnet                             *string                              `json:"subnet,omitempty"`
	VMDetails                          *[]CentralServerVMDetails            `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        *SAPCentralServerInstance
}

type UpdateSAPCentralInstanceRequest 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.