providerinstances

package
v0.20230405.1143248 Latest Latest
Warning

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

Go to latest
Published: Apr 5, 2023 License: MPL-2.0 Imports: 15 Imported by: 1

README

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

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

Client Initialization

client := providerinstances.NewProviderInstancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ProviderInstancesClient.Create

ctx := context.TODO()
id := providerinstances.NewProviderInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "monitorValue", "providerInstanceValue")

payload := providerinstances.ProviderInstance{
	// ...
}


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

Example Usage: ProviderInstancesClient.Delete

ctx := context.TODO()
id := providerinstances.NewProviderInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "monitorValue", "providerInstanceValue")

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

Example Usage: ProviderInstancesClient.Get

ctx := context.TODO()
id := providerinstances.NewProviderInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "monitorValue", "providerInstanceValue")

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

ctx := context.TODO()
id := providerinstances.NewMonitorID("12345678-1234-9876-4563-123456789012", "example-resource-group", "monitorValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForSslPreference

func PossibleValuesForSslPreference() []string

func PossibleValuesForWorkloadMonitorProvisioningState

func PossibleValuesForWorkloadMonitorProvisioningState() []string

func ValidateMonitorID

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

ValidateMonitorID checks that 'input' can be parsed as a Monitor ID

func ValidateProviderInstanceID

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

ValidateProviderInstanceID checks that 'input' can be parsed as a Provider Instance ID

Types

type CreateOperationResponse

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

type DB2ProviderInstanceProperties

type DB2ProviderInstanceProperties struct {
	DbName            *string        `json:"dbName,omitempty"`
	DbPassword        *string        `json:"dbPassword,omitempty"`
	DbPasswordUri     *string        `json:"dbPasswordUri,omitempty"`
	DbPort            *string        `json:"dbPort,omitempty"`
	DbUsername        *string        `json:"dbUsername,omitempty"`
	Hostname          *string        `json:"hostname,omitempty"`
	SapSid            *string        `json:"sapSid,omitempty"`
	SslCertificateUri *string        `json:"sslCertificateUri,omitempty"`
	SslPreference     *SslPreference `json:"sslPreference,omitempty"`
}

func (DB2ProviderInstanceProperties) MarshalJSON

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

type DeleteOperationResponse

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

type Error

type Error struct {
	Code       *string          `json:"code,omitempty"`
	Details    *[]Error         `json:"details,omitempty"`
	InnerError *ErrorInnerError `json:"innerError,omitempty"`
	Message    *string          `json:"message,omitempty"`
	Target     *string          `json:"target,omitempty"`
}

type ErrorAdditionalInfo

type ErrorAdditionalInfo struct {
	Info *interface{} `json:"info,omitempty"`
	Type *string      `json:"type,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 ErrorInnerError

type ErrorInnerError struct {
	InnerError *Error `json:"innerError,omitempty"`
}

type GetOperationResponse

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

type HanaDbProviderInstanceProperties

type HanaDbProviderInstanceProperties struct {
	DbName                   *string        `json:"dbName,omitempty"`
	DbPassword               *string        `json:"dbPassword,omitempty"`
	DbPasswordUri            *string        `json:"dbPasswordUri,omitempty"`
	DbUsername               *string        `json:"dbUsername,omitempty"`
	Hostname                 *string        `json:"hostname,omitempty"`
	InstanceNumber           *string        `json:"instanceNumber,omitempty"`
	SapSid                   *string        `json:"sapSid,omitempty"`
	SqlPort                  *string        `json:"sqlPort,omitempty"`
	SslCertificateUri        *string        `json:"sslCertificateUri,omitempty"`
	SslHostNameInCertificate *string        `json:"sslHostNameInCertificate,omitempty"`
	SslPreference            *SslPreference `json:"sslPreference,omitempty"`
}

func (HanaDbProviderInstanceProperties) MarshalJSON

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

type ListCompleteResult

type ListCompleteResult struct {
	Items []ProviderInstance
}

type ListOperationResponse

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

type MonitorId

type MonitorId struct {
	SubscriptionId    string
	ResourceGroupName string
	MonitorName       string
}

MonitorId is a struct representing the Resource ID for a Monitor

func NewMonitorID

func NewMonitorID(subscriptionId string, resourceGroupName string, monitorName string) MonitorId

NewMonitorID returns a new MonitorId struct

func ParseMonitorID

func ParseMonitorID(input string) (*MonitorId, error)

ParseMonitorID parses 'input' into a MonitorId

func ParseMonitorIDInsensitively

func ParseMonitorIDInsensitively(input string) (*MonitorId, error)

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

func (MonitorId) ID

func (id MonitorId) ID() string

ID returns the formatted Monitor ID

func (MonitorId) Segments

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

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

func (MonitorId) String

func (id MonitorId) String() string

String returns a human-readable description of this Monitor ID

type MsSqlServerProviderInstanceProperties

type MsSqlServerProviderInstanceProperties struct {
	DbPassword        *string        `json:"dbPassword,omitempty"`
	DbPasswordUri     *string        `json:"dbPasswordUri,omitempty"`
	DbPort            *string        `json:"dbPort,omitempty"`
	DbUsername        *string        `json:"dbUsername,omitempty"`
	Hostname          *string        `json:"hostname,omitempty"`
	SapSid            *string        `json:"sapSid,omitempty"`
	SslCertificateUri *string        `json:"sslCertificateUri,omitempty"`
	SslPreference     *SslPreference `json:"sslPreference,omitempty"`
}

func (MsSqlServerProviderInstanceProperties) MarshalJSON

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

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 PrometheusHaClusterProviderInstanceProperties

type PrometheusHaClusterProviderInstanceProperties struct {
	ClusterName       *string        `json:"clusterName,omitempty"`
	Hostname          *string        `json:"hostname,omitempty"`
	PrometheusUrl     *string        `json:"prometheusUrl,omitempty"`
	Sid               *string        `json:"sid,omitempty"`
	SslCertificateUri *string        `json:"sslCertificateUri,omitempty"`
	SslPreference     *SslPreference `json:"sslPreference,omitempty"`
}

func (PrometheusHaClusterProviderInstanceProperties) MarshalJSON

type PrometheusOSProviderInstanceProperties

type PrometheusOSProviderInstanceProperties struct {
	PrometheusUrl     *string        `json:"prometheusUrl,omitempty"`
	SapSid            *string        `json:"sapSid,omitempty"`
	SslCertificateUri *string        `json:"sslCertificateUri,omitempty"`
	SslPreference     *SslPreference `json:"sslPreference,omitempty"`
}

func (PrometheusOSProviderInstanceProperties) MarshalJSON

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

type ProviderInstance

type ProviderInstance struct {
	Id         *string                     `json:"id,omitempty"`
	Identity   *identity.UserAssignedMap   `json:"identity,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *ProviderInstanceProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type ProviderInstanceId

type ProviderInstanceId struct {
	SubscriptionId       string
	ResourceGroupName    string
	MonitorName          string
	ProviderInstanceName string
}

ProviderInstanceId is a struct representing the Resource ID for a Provider Instance

func NewProviderInstanceID

func NewProviderInstanceID(subscriptionId string, resourceGroupName string, monitorName string, providerInstanceName string) ProviderInstanceId

NewProviderInstanceID returns a new ProviderInstanceId struct

func ParseProviderInstanceID

func ParseProviderInstanceID(input string) (*ProviderInstanceId, error)

ParseProviderInstanceID parses 'input' into a ProviderInstanceId

func ParseProviderInstanceIDInsensitively

func ParseProviderInstanceIDInsensitively(input string) (*ProviderInstanceId, error)

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

func (ProviderInstanceId) ID

func (id ProviderInstanceId) ID() string

ID returns the formatted Provider Instance ID

func (ProviderInstanceId) Segments

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

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

func (ProviderInstanceId) String

func (id ProviderInstanceId) String() string

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

type ProviderInstanceOperationPredicate

type ProviderInstanceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ProviderInstanceOperationPredicate) Matches

type ProviderInstanceProperties

type ProviderInstanceProperties struct {
	Errors            *Error                            `json:"errors,omitempty"`
	ProviderSettings  ProviderSpecificProperties        `json:"providerSettings"`
	ProvisioningState *WorkloadMonitorProvisioningState `json:"provisioningState,omitempty"`
}

func (*ProviderInstanceProperties) UnmarshalJSON

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

type ProviderInstancesClient

type ProviderInstancesClient struct {
	Client *resourcemanager.Client
}

func NewProviderInstancesClientWithBaseURI

func NewProviderInstancesClientWithBaseURI(api environments.Api) (*ProviderInstancesClient, error)

func (ProviderInstancesClient) Create

Create ...

func (ProviderInstancesClient) CreateThenPoll

CreateThenPoll performs Create then polls until it's completed

func (ProviderInstancesClient) Delete

Delete ...

func (ProviderInstancesClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ProviderInstancesClient) Get

Get ...

func (ProviderInstancesClient) List

List ...

func (ProviderInstancesClient) ListComplete

ListComplete retrieves all the results into a single object

func (ProviderInstancesClient) ListCompleteMatchingPredicate

func (c ProviderInstancesClient) ListCompleteMatchingPredicate(ctx context.Context, id MonitorId, predicate ProviderInstanceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ProviderSpecificProperties

type ProviderSpecificProperties interface {
}

type SapNetWeaverProviderInstanceProperties

type SapNetWeaverProviderInstanceProperties struct {
	SapClientId        *string        `json:"sapClientId,omitempty"`
	SapHostFileEntries *[]string      `json:"sapHostFileEntries,omitempty"`
	SapHostname        *string        `json:"sapHostname,omitempty"`
	SapInstanceNr      *string        `json:"sapInstanceNr,omitempty"`
	SapPassword        *string        `json:"sapPassword,omitempty"`
	SapPasswordUri     *string        `json:"sapPasswordUri,omitempty"`
	SapPortNumber      *string        `json:"sapPortNumber,omitempty"`
	SapSid             *string        `json:"sapSid,omitempty"`
	SapUsername        *string        `json:"sapUsername,omitempty"`
	SslCertificateUri  *string        `json:"sslCertificateUri,omitempty"`
	SslPreference      *SslPreference `json:"sslPreference,omitempty"`
}

func (SapNetWeaverProviderInstanceProperties) MarshalJSON

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

type SslPreference

type SslPreference string
const (
	SslPreferenceDisabled          SslPreference = "Disabled"
	SslPreferenceRootCertificate   SslPreference = "RootCertificate"
	SslPreferenceServerCertificate SslPreference = "ServerCertificate"
)

type WorkloadMonitorProvisioningState

type WorkloadMonitorProvisioningState string
const (
	WorkloadMonitorProvisioningStateAccepted  WorkloadMonitorProvisioningState = "Accepted"
	WorkloadMonitorProvisioningStateCreating  WorkloadMonitorProvisioningState = "Creating"
	WorkloadMonitorProvisioningStateDeleting  WorkloadMonitorProvisioningState = "Deleting"
	WorkloadMonitorProvisioningStateFailed    WorkloadMonitorProvisioningState = "Failed"
	WorkloadMonitorProvisioningStateMigrating WorkloadMonitorProvisioningState = "Migrating"
	WorkloadMonitorProvisioningStateSucceeded WorkloadMonitorProvisioningState = "Succeeded"
	WorkloadMonitorProvisioningStateUpdating  WorkloadMonitorProvisioningState = "Updating"
)

Jump to

Keyboard shortcuts

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