deploymentinfo

README

github.com/hashicorp/go-azure-sdk/resource-manager/elastic/2024-03-01/deploymentinfo Documentation

The deploymentinfo SDK allows for interaction with the Azure Resource Manager Service elastic (API Version 2024-03-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/elastic/2024-03-01/deploymentinfo"

Client Initialization

client := deploymentinfo.NewDeploymentInfoClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DeploymentInfoClient.ExternalUserCreateOrUpdate

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

payload := deploymentinfo.ExternalUserInfo{
	// ...
}


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

Example Usage: DeploymentInfoClient.List

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

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

Documentation

Index

• func PossibleValuesForElasticDeploymentStatus() []string
• func ValidateMonitorID(input interface{}, key string) (warnings []string, errors []error)
• type DeploymentInfoClient
  • func NewDeploymentInfoClientWithBaseURI(sdkApi sdkEnv.Api) (*DeploymentInfoClient, error)
  • func (c DeploymentInfoClient) ExternalUserCreateOrUpdate(ctx context.Context, id MonitorId, input ExternalUserInfo) (result ExternalUserCreateOrUpdateOperationResponse, err error)
  • func (c DeploymentInfoClient) List(ctx context.Context, id MonitorId) (result ListOperationResponse, err error)
• type DeploymentInfoResponse
• type ElasticDeploymentStatus
  • func (s *ElasticDeploymentStatus) UnmarshalJSON(bytes []byte) error
• type ExternalUserCreateOrUpdateOperationResponse
• type ExternalUserCreationResponse
• type ExternalUserInfo
• type ListOperationResponse
• type MarketplaceSaaSInfo
• type MarketplaceSaaSInfoMarketplaceSubscription
• type MonitorId
  • func NewMonitorID(subscriptionId string, resourceGroupName string, monitorName string) MonitorId
  • func ParseMonitorID(input string) (*MonitorId, error)
  • func ParseMonitorIDInsensitively(input string) (*MonitorId, error)
  • func (id *MonitorId) FromParseResult(input resourceids.ParseResult) error
  • func (id MonitorId) ID() string
  • func (id MonitorId) Segments() []resourceids.Segment
  • func (id MonitorId) String() string

Functions

func PossibleValuesForElasticDeploymentStatus

func PossibleValuesForElasticDeploymentStatus() []string

func ValidateMonitorID

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

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

Types

type DeploymentInfoClient

type DeploymentInfoClient struct {
	Client *resourcemanager.Client
}

func NewDeploymentInfoClientWithBaseURI

func NewDeploymentInfoClientWithBaseURI(sdkApi sdkEnv.Api) (*DeploymentInfoClient, error)

func (DeploymentInfoClient) ExternalUserCreateOrUpdate

func (c DeploymentInfoClient) ExternalUserCreateOrUpdate(ctx context.Context, id MonitorId, input ExternalUserInfo) (result ExternalUserCreateOrUpdateOperationResponse, err error)

ExternalUserCreateOrUpdate ...

func (DeploymentInfoClient) List

func (c DeploymentInfoClient) List(ctx context.Context, id MonitorId) (result ListOperationResponse, err error)

List ...

type DeploymentInfoResponse

type DeploymentInfoResponse struct {
	DeploymentUrl         *string                  `json:"deploymentUrl,omitempty"`
	DiskCapacity          *string                  `json:"diskCapacity,omitempty"`
	ElasticsearchEndPoint *string                  `json:"elasticsearchEndPoint,omitempty"`
	MarketplaceSaasInfo   *MarketplaceSaaSInfo     `json:"marketplaceSaasInfo,omitempty"`
	MemoryCapacity        *string                  `json:"memoryCapacity,omitempty"`
	Status                *ElasticDeploymentStatus `json:"status,omitempty"`
	Version               *string                  `json:"version,omitempty"`
}

type ElasticDeploymentStatus

type ElasticDeploymentStatus string

const (
	ElasticDeploymentStatusHealthy   ElasticDeploymentStatus = "Healthy"
	ElasticDeploymentStatusUnhealthy ElasticDeploymentStatus = "Unhealthy"
)

func (*ElasticDeploymentStatus) UnmarshalJSON

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

type ExternalUserCreateOrUpdateOperationResponse

type ExternalUserCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExternalUserCreationResponse
}

type ExternalUserCreationResponse

type ExternalUserCreationResponse struct {
	Created *bool `json:"created,omitempty"`
}

type ExternalUserInfo

type ExternalUserInfo struct {
	EmailId  *string   `json:"emailId,omitempty"`
	FullName *string   `json:"fullName,omitempty"`
	Password *string   `json:"password,omitempty"`
	Roles    *[]string `json:"roles,omitempty"`
	UserName *string   `json:"userName,omitempty"`
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DeploymentInfoResponse
}

type MarketplaceSaaSInfo

type MarketplaceSaaSInfo struct {
	BilledAzureSubscriptionId *string                                     `json:"billedAzureSubscriptionId,omitempty"`
	MarketplaceName           *string                                     `json:"marketplaceName,omitempty"`
	MarketplaceResourceId     *string                                     `json:"marketplaceResourceId,omitempty"`
	MarketplaceStatus         *string                                     `json:"marketplaceStatus,omitempty"`
	MarketplaceSubscription   *MarketplaceSaaSInfoMarketplaceSubscription `json:"marketplaceSubscription,omitempty"`
	Subscribed                *bool                                       `json:"subscribed,omitempty"`
}

type MarketplaceSaaSInfoMarketplaceSubscription

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

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) FromParseResult

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

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