replicationvaulthealth

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicessiterecovery/2023-02-01/replicationvaulthealth Documentation

The replicationvaulthealth SDK allows for interaction with the Azure Resource Manager Service recoveryservicessiterecovery (API Version 2023-02-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/recoveryservicessiterecovery/2023-02-01/replicationvaulthealth"

Client Initialization

client := replicationvaulthealth.NewReplicationVaultHealthClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationVaultHealthClient.Get

ctx := context.TODO()
id := replicationvaulthealth.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

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: ReplicationVaultHealthClient.Refresh

ctx := context.TODO()
id := replicationvaulthealth.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

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

Documentation

Index

• func PossibleValuesForHealthErrorCategory() []string
• func PossibleValuesForHealthErrorCustomerResolvability() []string
• func PossibleValuesForSeverity() []string
• func ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationResponse
• type HealthError
  • func (o *HealthError) GetCreationTimeUtcAsTime() (*time.Time, error)
  • func (o *HealthError) SetCreationTimeUtcAsTime(input time.Time)
• type HealthErrorCategory
• type HealthErrorCustomerResolvability
• type HealthErrorSummary
• type InnerHealthError
  • func (o *InnerHealthError) GetCreationTimeUtcAsTime() (*time.Time, error)
  • func (o *InnerHealthError) SetCreationTimeUtcAsTime(input time.Time)
• type RefreshOperationResponse
• type ReplicationVaultHealthClient
  • func NewReplicationVaultHealthClientWithBaseURI(endpoint string) ReplicationVaultHealthClient
  • func (c ReplicationVaultHealthClient) Get(ctx context.Context, id VaultId) (result GetOperationResponse, err error)
  • func (c ReplicationVaultHealthClient) Refresh(ctx context.Context, id VaultId) (result RefreshOperationResponse, err error)
  • func (c ReplicationVaultHealthClient) RefreshThenPoll(ctx context.Context, id VaultId) error
• type ResourceHealthSummary
• type Severity
• type VaultHealthDetails
• type VaultHealthProperties
• type VaultId
  • func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId
  • func ParseVaultID(input string) (*VaultId, error)
  • func ParseVaultIDInsensitively(input string) (*VaultId, error)
  • func (id VaultId) ID() string
  • func (id VaultId) Segments() []resourceids.Segment
  • func (id VaultId) String() string

Functions

func PossibleValuesForHealthErrorCategory

func PossibleValuesForHealthErrorCategory() []string

func PossibleValuesForHealthErrorCustomerResolvability

func PossibleValuesForHealthErrorCustomerResolvability() []string

func PossibleValuesForSeverity

func PossibleValuesForSeverity() []string

func ValidateVaultID

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *VaultHealthDetails
}

type HealthError

type HealthError struct {
	CreationTimeUtc              *string                           `json:"creationTimeUtc,omitempty"`
	CustomerResolvability        *HealthErrorCustomerResolvability `json:"customerResolvability,omitempty"`
	EntityId                     *string                           `json:"entityId,omitempty"`
	ErrorCategory                *string                           `json:"errorCategory,omitempty"`
	ErrorCode                    *string                           `json:"errorCode,omitempty"`
	ErrorId                      *string                           `json:"errorId,omitempty"`
	ErrorLevel                   *string                           `json:"errorLevel,omitempty"`
	ErrorMessage                 *string                           `json:"errorMessage,omitempty"`
	ErrorSource                  *string                           `json:"errorSource,omitempty"`
	ErrorType                    *string                           `json:"errorType,omitempty"`
	InnerHealthErrors            *[]InnerHealthError               `json:"innerHealthErrors,omitempty"`
	PossibleCauses               *string                           `json:"possibleCauses,omitempty"`
	RecommendedAction            *string                           `json:"recommendedAction,omitempty"`
	RecoveryProviderErrorMessage *string                           `json:"recoveryProviderErrorMessage,omitempty"`
	SummaryMessage               *string                           `json:"summaryMessage,omitempty"`
}

func (*HealthError) GetCreationTimeUtcAsTime

func (o *HealthError) GetCreationTimeUtcAsTime() (*time.Time, error)

func (*HealthError) SetCreationTimeUtcAsTime

func (o *HealthError) SetCreationTimeUtcAsTime(input time.Time)

type HealthErrorCategory

type HealthErrorCategory string

const (
	HealthErrorCategoryAgentAutoUpdateArtifactDeleted     HealthErrorCategory = "AgentAutoUpdateArtifactDeleted"
	HealthErrorCategoryAgentAutoUpdateInfra               HealthErrorCategory = "AgentAutoUpdateInfra"
	HealthErrorCategoryAgentAutoUpdateRunAsAccount        HealthErrorCategory = "AgentAutoUpdateRunAsAccount"
	HealthErrorCategoryAgentAutoUpdateRunAsAccountExpired HealthErrorCategory = "AgentAutoUpdateRunAsAccountExpired"
	HealthErrorCategoryAgentAutoUpdateRunAsAccountExpiry  HealthErrorCategory = "AgentAutoUpdateRunAsAccountExpiry"
	HealthErrorCategoryConfiguration                      HealthErrorCategory = "Configuration"
	HealthErrorCategoryFabricInfrastructure               HealthErrorCategory = "FabricInfrastructure"
	HealthErrorCategoryNone                               HealthErrorCategory = "None"
	HealthErrorCategoryReplication                        HealthErrorCategory = "Replication"
	HealthErrorCategoryTestFailover                       HealthErrorCategory = "TestFailover"
	HealthErrorCategoryVersionExpiry                      HealthErrorCategory = "VersionExpiry"
)

type HealthErrorCustomerResolvability

type HealthErrorCustomerResolvability string

const (
	HealthErrorCustomerResolvabilityAllowed    HealthErrorCustomerResolvability = "Allowed"
	HealthErrorCustomerResolvabilityNotAllowed HealthErrorCustomerResolvability = "NotAllowed"
)

type HealthErrorSummary

type HealthErrorSummary struct {
	AffectedResourceCorrelationIds *[]string            `json:"affectedResourceCorrelationIds,omitempty"`
	AffectedResourceSubtype        *string              `json:"affectedResourceSubtype,omitempty"`
	AffectedResourceType           *string              `json:"affectedResourceType,omitempty"`
	Category                       *HealthErrorCategory `json:"category,omitempty"`
	Severity                       *Severity            `json:"severity,omitempty"`
	SummaryCode                    *string              `json:"summaryCode,omitempty"`
	SummaryMessage                 *string              `json:"summaryMessage,omitempty"`
}

type InnerHealthError

type InnerHealthError struct {
	CreationTimeUtc              *string                           `json:"creationTimeUtc,omitempty"`
	CustomerResolvability        *HealthErrorCustomerResolvability `json:"customerResolvability,omitempty"`
	EntityId                     *string                           `json:"entityId,omitempty"`
	ErrorCategory                *string                           `json:"errorCategory,omitempty"`
	ErrorCode                    *string                           `json:"errorCode,omitempty"`
	ErrorId                      *string                           `json:"errorId,omitempty"`
	ErrorLevel                   *string                           `json:"errorLevel,omitempty"`
	ErrorMessage                 *string                           `json:"errorMessage,omitempty"`
	ErrorSource                  *string                           `json:"errorSource,omitempty"`
	ErrorType                    *string                           `json:"errorType,omitempty"`
	PossibleCauses               *string                           `json:"possibleCauses,omitempty"`
	RecommendedAction            *string                           `json:"recommendedAction,omitempty"`
	RecoveryProviderErrorMessage *string                           `json:"recoveryProviderErrorMessage,omitempty"`
	SummaryMessage               *string                           `json:"summaryMessage,omitempty"`
}

func (*InnerHealthError) GetCreationTimeUtcAsTime

func (o *InnerHealthError) GetCreationTimeUtcAsTime() (*time.Time, error)

func (*InnerHealthError) SetCreationTimeUtcAsTime

func (o *InnerHealthError) SetCreationTimeUtcAsTime(input time.Time)

type RefreshOperationResponse

type RefreshOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type ReplicationVaultHealthClient

type ReplicationVaultHealthClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewReplicationVaultHealthClientWithBaseURI

func NewReplicationVaultHealthClientWithBaseURI(endpoint string) ReplicationVaultHealthClient

func (ReplicationVaultHealthClient) Get

func (c ReplicationVaultHealthClient) Get(ctx context.Context, id VaultId) (result GetOperationResponse, err error)

Get ...

func (ReplicationVaultHealthClient) Refresh

func (c ReplicationVaultHealthClient) Refresh(ctx context.Context, id VaultId) (result RefreshOperationResponse, err error)

Refresh ...

func (ReplicationVaultHealthClient) RefreshThenPoll

func (c ReplicationVaultHealthClient) RefreshThenPoll(ctx context.Context, id VaultId) error

RefreshThenPoll performs Refresh then polls until it's completed

type ResourceHealthSummary

type ResourceHealthSummary struct {
	CategorizedResourceCounts *map[string]int64     `json:"categorizedResourceCounts,omitempty"`
	Issues                    *[]HealthErrorSummary `json:"issues,omitempty"`
	ResourceCount             *int64                `json:"resourceCount,omitempty"`
}

type Severity

type Severity string

const (
	SeverityError   Severity = "Error"
	SeverityInfo    Severity = "Info"
	SeverityNONE    Severity = "NONE"
	SeverityWarning Severity = "Warning"
)

type VaultHealthDetails

type VaultHealthDetails struct {
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *VaultHealthProperties `json:"properties,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type VaultHealthProperties

type VaultHealthProperties struct {
	ContainersHealth     *ResourceHealthSummary `json:"containersHealth,omitempty"`
	FabricsHealth        *ResourceHealthSummary `json:"fabricsHealth,omitempty"`
	ProtectedItemsHealth *ResourceHealthSummary `json:"protectedItemsHealth,omitempty"`
	VaultErrors          *[]HealthError         `json:"vaultErrors,omitempty"`
}

type VaultId

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (VaultId) ID

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments

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

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

func (VaultId) String

func (id VaultId) String() string

String returns a human-readable description of this Vault ID