saprecommendations

README

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

The saprecommendations 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/saprecommendations"

Client Initialization

client := saprecommendations.NewSAPRecommendationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SAPRecommendationsClient.SAPSizingRecommendations

ctx := context.TODO()
id := saprecommendations.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

payload := saprecommendations.SAPSizingRecommendationRequest{
	// ...
}


read, err := client.SAPSizingRecommendations(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func PossibleValuesForSAPDatabaseScaleMethod() []string
• func PossibleValuesForSAPDatabaseType() []string
• func PossibleValuesForSAPDeploymentType() []string
• func PossibleValuesForSAPEnvironmentType() []string
• func PossibleValuesForSAPHighAvailabilityType() []string
• func PossibleValuesForSAPProductType() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type RawSAPSizingRecommendationResultImpl
• type SAPDatabaseScaleMethod
  • func (s *SAPDatabaseScaleMethod) UnmarshalJSON(bytes []byte) error
• type SAPDatabaseType
  • func (s *SAPDatabaseType) UnmarshalJSON(bytes []byte) error
• type SAPDeploymentType
  • func (s *SAPDeploymentType) UnmarshalJSON(bytes []byte) error
• type SAPEnvironmentType
  • func (s *SAPEnvironmentType) UnmarshalJSON(bytes []byte) error
• type SAPHighAvailabilityType
  • func (s *SAPHighAvailabilityType) UnmarshalJSON(bytes []byte) error
• type SAPProductType
  • func (s *SAPProductType) UnmarshalJSON(bytes []byte) error
• type SAPRecommendationsClient
  • func NewSAPRecommendationsClientWithBaseURI(sdkApi sdkEnv.Api) (*SAPRecommendationsClient, error)
  • func (c SAPRecommendationsClient) SAPSizingRecommendations(ctx context.Context, id LocationId, input SAPSizingRecommendationRequest) (result SAPSizingRecommendationsOperationResponse, err error)
• type SAPSizingRecommendationRequest
• type SAPSizingRecommendationResult
• type SAPSizingRecommendationsOperationResponse
• type SingleServerRecommendationResult
  • func (s SingleServerRecommendationResult) MarshalJSON() ([]byte, error)
• type ThreeTierRecommendationResult
  • func (s ThreeTierRecommendationResult) MarshalJSON() ([]byte, error)

Functions

func PossibleValuesForSAPDatabaseScaleMethod

func PossibleValuesForSAPDatabaseScaleMethod() []string

func PossibleValuesForSAPDatabaseType

func PossibleValuesForSAPDatabaseType() []string

func PossibleValuesForSAPDeploymentType

func PossibleValuesForSAPDeploymentType() []string

func PossibleValuesForSAPEnvironmentType

func PossibleValuesForSAPEnvironmentType() []string

func PossibleValuesForSAPHighAvailabilityType

func PossibleValuesForSAPHighAvailabilityType() []string

func PossibleValuesForSAPProductType

func PossibleValuesForSAPProductType() []string

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type RawSAPSizingRecommendationResultImpl

type RawSAPSizingRecommendationResultImpl struct {
	Type   string
	Values map[string]interface{}
}

RawModeOfTransitImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

type SAPDatabaseScaleMethod

type SAPDatabaseScaleMethod string

const (
	SAPDatabaseScaleMethodScaleUp SAPDatabaseScaleMethod = "ScaleUp"
)

func (*SAPDatabaseScaleMethod) UnmarshalJSON

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

type SAPDatabaseType

type SAPDatabaseType string

const (
	SAPDatabaseTypeDBTwo SAPDatabaseType = "DB2"
	SAPDatabaseTypeHANA  SAPDatabaseType = "HANA"
)

func (*SAPDatabaseType) UnmarshalJSON

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

type SAPDeploymentType

type SAPDeploymentType string

const (
	SAPDeploymentTypeSingleServer SAPDeploymentType = "SingleServer"
	SAPDeploymentTypeThreeTier    SAPDeploymentType = "ThreeTier"
)

func (*SAPDeploymentType) UnmarshalJSON

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

type SAPEnvironmentType

type SAPEnvironmentType string

const (
	SAPEnvironmentTypeNonProd SAPEnvironmentType = "NonProd"
	SAPEnvironmentTypeProd    SAPEnvironmentType = "Prod"
)

func (*SAPEnvironmentType) UnmarshalJSON

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

type SAPHighAvailabilityType

type SAPHighAvailabilityType string

const (
	SAPHighAvailabilityTypeAvailabilitySet  SAPHighAvailabilityType = "AvailabilitySet"
	SAPHighAvailabilityTypeAvailabilityZone SAPHighAvailabilityType = "AvailabilityZone"
)

func (*SAPHighAvailabilityType) UnmarshalJSON

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

type SAPProductType

type SAPProductType string

const (
	SAPProductTypeECC       SAPProductType = "ECC"
	SAPProductTypeOther     SAPProductType = "Other"
	SAPProductTypeSFourHANA SAPProductType = "S4HANA"
)

func (*SAPProductType) UnmarshalJSON

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

type SAPRecommendationsClient

type SAPRecommendationsClient struct {
	Client *resourcemanager.Client
}

func NewSAPRecommendationsClientWithBaseURI

func NewSAPRecommendationsClientWithBaseURI(sdkApi sdkEnv.Api) (*SAPRecommendationsClient, error)

func (SAPRecommendationsClient) SAPSizingRecommendations

func (c SAPRecommendationsClient) SAPSizingRecommendations(ctx context.Context, id LocationId, input SAPSizingRecommendationRequest) (result SAPSizingRecommendationsOperationResponse, err error)

SAPSizingRecommendations ...

type SAPSizingRecommendationRequest

type SAPSizingRecommendationRequest struct {
	AppLocation          string                   `json:"appLocation"`
	DatabaseType         SAPDatabaseType          `json:"databaseType"`
	DbMemory             int64                    `json:"dbMemory"`
	DbScaleMethod        *SAPDatabaseScaleMethod  `json:"dbScaleMethod,omitempty"`
	DeploymentType       SAPDeploymentType        `json:"deploymentType"`
	Environment          SAPEnvironmentType       `json:"environment"`
	HighAvailabilityType *SAPHighAvailabilityType `json:"highAvailabilityType,omitempty"`
	SapProduct           SAPProductType           `json:"sapProduct"`
	Saps                 int64                    `json:"saps"`
}

type SAPSizingRecommendationResult

type SAPSizingRecommendationResult interface {
}

type SAPSizingRecommendationsOperationResponse

type SAPSizingRecommendationsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SAPSizingRecommendationResult
}

type SingleServerRecommendationResult

type SingleServerRecommendationResult struct {
	VMSku *string `json:"vmSku,omitempty"`
}

func (SingleServerRecommendationResult) MarshalJSON

func (s SingleServerRecommendationResult) MarshalJSON() ([]byte, error)

type ThreeTierRecommendationResult

type ThreeTierRecommendationResult struct {
	ApplicationServerInstanceCount *int64  `json:"applicationServerInstanceCount,omitempty"`
	ApplicationServerVMSku         *string `json:"applicationServerVmSku,omitempty"`
	CentralServerInstanceCount     *int64  `json:"centralServerInstanceCount,omitempty"`
	CentralServerVMSku             *string `json:"centralServerVmSku,omitempty"`
	DatabaseInstanceCount          *int64  `json:"databaseInstanceCount,omitempty"`
	DbVMSku                        *string `json:"dbVmSku,omitempty"`
}

func (ThreeTierRecommendationResult) MarshalJSON

func (s ThreeTierRecommendationResult) MarshalJSON() ([]byte, error)