replicationappliances

package
v0.20231108.1152235 Latest Latest
Warning

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

Go to latest
Published: Nov 8, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

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

Client Initialization

client := replicationappliances.NewReplicationAppliancesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationAppliancesClient.List

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

// alternatively `client.List(ctx, id, replicationappliances.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, replicationappliances.DefaultListOperationOptions())
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 PossibleValuesForHealthErrorCustomerResolvability

func PossibleValuesForHealthErrorCustomerResolvability() []string

func PossibleValuesForProtectionHealth

func PossibleValuesForProtectionHealth() []string

func PossibleValuesForRcmComponentStatus

func PossibleValuesForRcmComponentStatus() []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 ApplianceSpecificDetails

type ApplianceSpecificDetails interface {
}

type DraDetails

type DraDetails struct {
	BiosId                    *string           `json:"biosId,omitempty"`
	ForwardProtectedItemCount *int64            `json:"forwardProtectedItemCount,omitempty"`
	Health                    *ProtectionHealth `json:"health,omitempty"`
	HealthErrors              *[]HealthError    `json:"healthErrors,omitempty"`
	Id                        *string           `json:"id,omitempty"`
	LastHeartbeatUtc          *string           `json:"lastHeartbeatUtc,omitempty"`
	Name                      *string           `json:"name,omitempty"`
	ReverseProtectedItemCount *int64            `json:"reverseProtectedItemCount,omitempty"`
	Version                   *string           `json:"version,omitempty"`
}

func (*DraDetails) GetLastHeartbeatUtcAsTime

func (o *DraDetails) GetLastHeartbeatUtcAsTime() (*time.Time, error)

func (*DraDetails) SetLastHeartbeatUtcAsTime

func (o *DraDetails) SetLastHeartbeatUtcAsTime(input time.Time)

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 HealthErrorCustomerResolvability

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

func (*HealthErrorCustomerResolvability) UnmarshalJSON added in v0.20230809.1081239

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

type InMageRcmApplianceDetails

type InMageRcmApplianceDetails struct {
	Dra                                *DraDetails                                          `json:"dra,omitempty"`
	FabricArmId                        *string                                              `json:"fabricArmId,omitempty"`
	Id                                 *string                                              `json:"id,omitempty"`
	MarsAgent                          *MarsAgentDetails                                    `json:"marsAgent,omitempty"`
	Name                               *string                                              `json:"name,omitempty"`
	ProcessServer                      *ProcessServerDetails                                `json:"processServer,omitempty"`
	PushInstaller                      *PushInstallerDetails                                `json:"pushInstaller,omitempty"`
	RcmProxy                           *RcmProxyDetails                                     `json:"rcmProxy,omitempty"`
	ReplicationAgent                   *ReplicationAgentDetails                             `json:"replicationAgent,omitempty"`
	ReprotectAgent                     *ReprotectAgentDetails                               `json:"reprotectAgent,omitempty"`
	SwitchProviderBlockingErrorDetails *[]InMageRcmFabricSwitchProviderBlockingErrorDetails `json:"switchProviderBlockingErrorDetails,omitempty"`
}

type InMageRcmApplianceSpecificDetails

type InMageRcmApplianceSpecificDetails struct {
	Appliances *[]InMageRcmApplianceDetails `json:"appliances,omitempty"`
}

func (InMageRcmApplianceSpecificDetails) MarshalJSON

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

type InMageRcmFabricSwitchProviderBlockingErrorDetails

type InMageRcmFabricSwitchProviderBlockingErrorDetails struct {
	ErrorCode              *string            `json:"errorCode,omitempty"`
	ErrorMessage           *string            `json:"errorMessage,omitempty"`
	ErrorMessageParameters *map[string]string `json:"errorMessageParameters,omitempty"`
	ErrorTags              *map[string]string `json:"errorTags,omitempty"`
	PossibleCauses         *string            `json:"possibleCauses,omitempty"`
	RecommendedAction      *string            `json:"recommendedAction,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 ListCompleteResult

type ListCompleteResult struct {
	Items []ReplicationAppliance
}

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders added in v0.20230809.1081239

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData added in v0.20230809.1081239

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery added in v0.20230809.1081239

type ListOperationResponse

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

type MarsAgentDetails

type MarsAgentDetails struct {
	BiosId           *string           `json:"biosId,omitempty"`
	FabricObjectId   *string           `json:"fabricObjectId,omitempty"`
	Fqdn             *string           `json:"fqdn,omitempty"`
	Health           *ProtectionHealth `json:"health,omitempty"`
	HealthErrors     *[]HealthError    `json:"healthErrors,omitempty"`
	Id               *string           `json:"id,omitempty"`
	LastHeartbeatUtc *string           `json:"lastHeartbeatUtc,omitempty"`
	Name             *string           `json:"name,omitempty"`
	Version          *string           `json:"version,omitempty"`
}

func (*MarsAgentDetails) GetLastHeartbeatUtcAsTime

func (o *MarsAgentDetails) GetLastHeartbeatUtcAsTime() (*time.Time, error)

func (*MarsAgentDetails) SetLastHeartbeatUtcAsTime

func (o *MarsAgentDetails) SetLastHeartbeatUtcAsTime(input time.Time)

type ProcessServerDetails

type ProcessServerDetails struct {
	AvailableMemoryInBytes             *int64              `json:"availableMemoryInBytes,omitempty"`
	AvailableSpaceInBytes              *int64              `json:"availableSpaceInBytes,omitempty"`
	BiosId                             *string             `json:"biosId,omitempty"`
	DiskUsageStatus                    *RcmComponentStatus `json:"diskUsageStatus,omitempty"`
	FabricObjectId                     *string             `json:"fabricObjectId,omitempty"`
	Fqdn                               *string             `json:"fqdn,omitempty"`
	FreeSpacePercentage                *float64            `json:"freeSpacePercentage,omitempty"`
	Health                             *ProtectionHealth   `json:"health,omitempty"`
	HealthErrors                       *[]HealthError      `json:"healthErrors,omitempty"`
	HistoricHealth                     *ProtectionHealth   `json:"historicHealth,omitempty"`
	IPAddresses                        *[]string           `json:"ipAddresses,omitempty"`
	Id                                 *string             `json:"id,omitempty"`
	LastHeartbeatUtc                   *string             `json:"lastHeartbeatUtc,omitempty"`
	MemoryUsagePercentage              *float64            `json:"memoryUsagePercentage,omitempty"`
	MemoryUsageStatus                  *RcmComponentStatus `json:"memoryUsageStatus,omitempty"`
	Name                               *string             `json:"name,omitempty"`
	ProcessorUsagePercentage           *float64            `json:"processorUsagePercentage,omitempty"`
	ProcessorUsageStatus               *RcmComponentStatus `json:"processorUsageStatus,omitempty"`
	ProtectedItemCount                 *int64              `json:"protectedItemCount,omitempty"`
	SystemLoad                         *int64              `json:"systemLoad,omitempty"`
	SystemLoadStatus                   *RcmComponentStatus `json:"systemLoadStatus,omitempty"`
	ThroughputInBytes                  *int64              `json:"throughputInBytes,omitempty"`
	ThroughputStatus                   *RcmComponentStatus `json:"throughputStatus,omitempty"`
	ThroughputUploadPendingDataInBytes *int64              `json:"throughputUploadPendingDataInBytes,omitempty"`
	TotalMemoryInBytes                 *int64              `json:"totalMemoryInBytes,omitempty"`
	TotalSpaceInBytes                  *int64              `json:"totalSpaceInBytes,omitempty"`
	UsedMemoryInBytes                  *int64              `json:"usedMemoryInBytes,omitempty"`
	UsedSpaceInBytes                   *int64              `json:"usedSpaceInBytes,omitempty"`
	Version                            *string             `json:"version,omitempty"`
}

func (*ProcessServerDetails) GetLastHeartbeatUtcAsTime

func (o *ProcessServerDetails) GetLastHeartbeatUtcAsTime() (*time.Time, error)

func (*ProcessServerDetails) SetLastHeartbeatUtcAsTime

func (o *ProcessServerDetails) SetLastHeartbeatUtcAsTime(input time.Time)

type ProtectionHealth

type ProtectionHealth string
const (
	ProtectionHealthCritical ProtectionHealth = "Critical"
	ProtectionHealthNone     ProtectionHealth = "None"
	ProtectionHealthNormal   ProtectionHealth = "Normal"
	ProtectionHealthWarning  ProtectionHealth = "Warning"
)

func (*ProtectionHealth) UnmarshalJSON added in v0.20230809.1081239

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

type PushInstallerDetails

type PushInstallerDetails struct {
	BiosId           *string           `json:"biosId,omitempty"`
	FabricObjectId   *string           `json:"fabricObjectId,omitempty"`
	Fqdn             *string           `json:"fqdn,omitempty"`
	Health           *ProtectionHealth `json:"health,omitempty"`
	HealthErrors     *[]HealthError    `json:"healthErrors,omitempty"`
	Id               *string           `json:"id,omitempty"`
	LastHeartbeatUtc *string           `json:"lastHeartbeatUtc,omitempty"`
	Name             *string           `json:"name,omitempty"`
	Version          *string           `json:"version,omitempty"`
}

func (*PushInstallerDetails) GetLastHeartbeatUtcAsTime

func (o *PushInstallerDetails) GetLastHeartbeatUtcAsTime() (*time.Time, error)

func (*PushInstallerDetails) SetLastHeartbeatUtcAsTime

func (o *PushInstallerDetails) SetLastHeartbeatUtcAsTime(input time.Time)

type RawApplianceSpecificDetailsImpl added in v0.20230807.1063129

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

RawApplianceSpecificDetailsImpl 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 RcmComponentStatus

type RcmComponentStatus string
const (
	RcmComponentStatusCritical RcmComponentStatus = "Critical"
	RcmComponentStatusHealthy  RcmComponentStatus = "Healthy"
	RcmComponentStatusUnknown  RcmComponentStatus = "Unknown"
	RcmComponentStatusWarning  RcmComponentStatus = "Warning"
)

func (*RcmComponentStatus) UnmarshalJSON added in v0.20230809.1081239

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

type RcmProxyDetails

type RcmProxyDetails struct {
	BiosId                   *string           `json:"biosId,omitempty"`
	ClientAuthenticationType *string           `json:"clientAuthenticationType,omitempty"`
	FabricObjectId           *string           `json:"fabricObjectId,omitempty"`
	Fqdn                     *string           `json:"fqdn,omitempty"`
	Health                   *ProtectionHealth `json:"health,omitempty"`
	HealthErrors             *[]HealthError    `json:"healthErrors,omitempty"`
	Id                       *string           `json:"id,omitempty"`
	LastHeartbeatUtc         *string           `json:"lastHeartbeatUtc,omitempty"`
	Name                     *string           `json:"name,omitempty"`
	Version                  *string           `json:"version,omitempty"`
}

func (*RcmProxyDetails) GetLastHeartbeatUtcAsTime

func (o *RcmProxyDetails) GetLastHeartbeatUtcAsTime() (*time.Time, error)

func (*RcmProxyDetails) SetLastHeartbeatUtcAsTime

func (o *RcmProxyDetails) SetLastHeartbeatUtcAsTime(input time.Time)

type ReplicationAgentDetails

type ReplicationAgentDetails struct {
	BiosId           *string           `json:"biosId,omitempty"`
	FabricObjectId   *string           `json:"fabricObjectId,omitempty"`
	Fqdn             *string           `json:"fqdn,omitempty"`
	Health           *ProtectionHealth `json:"health,omitempty"`
	HealthErrors     *[]HealthError    `json:"healthErrors,omitempty"`
	Id               *string           `json:"id,omitempty"`
	LastHeartbeatUtc *string           `json:"lastHeartbeatUtc,omitempty"`
	Name             *string           `json:"name,omitempty"`
	Version          *string           `json:"version,omitempty"`
}

func (*ReplicationAgentDetails) GetLastHeartbeatUtcAsTime

func (o *ReplicationAgentDetails) GetLastHeartbeatUtcAsTime() (*time.Time, error)

func (*ReplicationAgentDetails) SetLastHeartbeatUtcAsTime

func (o *ReplicationAgentDetails) SetLastHeartbeatUtcAsTime(input time.Time)

type ReplicationAppliance

type ReplicationAppliance struct {
	Properties *ReplicationApplianceProperties `json:"properties,omitempty"`
}

type ReplicationApplianceOperationPredicate

type ReplicationApplianceOperationPredicate struct {
}

func (ReplicationApplianceOperationPredicate) Matches

type ReplicationApplianceProperties

type ReplicationApplianceProperties struct {
	ProviderSpecificDetails ApplianceSpecificDetails `json:"providerSpecificDetails"`
}

func (*ReplicationApplianceProperties) UnmarshalJSON

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

type ReplicationAppliancesClient

type ReplicationAppliancesClient struct {
	Client *resourcemanager.Client
}

func NewReplicationAppliancesClientWithBaseURI

func NewReplicationAppliancesClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationAppliancesClient, error)

func (ReplicationAppliancesClient) List

List ...

func (ReplicationAppliancesClient) ListComplete

ListComplete retrieves all the results into a single object

func (ReplicationAppliancesClient) ListCompleteMatchingPredicate

func (c ReplicationAppliancesClient) ListCompleteMatchingPredicate(ctx context.Context, id VaultId, options ListOperationOptions, predicate ReplicationApplianceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ReprotectAgentDetails

type ReprotectAgentDetails struct {
	AccessibleDatastores *[]string         `json:"accessibleDatastores,omitempty"`
	BiosId               *string           `json:"biosId,omitempty"`
	FabricObjectId       *string           `json:"fabricObjectId,omitempty"`
	Fqdn                 *string           `json:"fqdn,omitempty"`
	Health               *ProtectionHealth `json:"health,omitempty"`
	HealthErrors         *[]HealthError    `json:"healthErrors,omitempty"`
	Id                   *string           `json:"id,omitempty"`
	LastDiscoveryInUtc   *string           `json:"lastDiscoveryInUtc,omitempty"`
	LastHeartbeatUtc     *string           `json:"lastHeartbeatUtc,omitempty"`
	Name                 *string           `json:"name,omitempty"`
	ProtectedItemCount   *int64            `json:"protectedItemCount,omitempty"`
	VcenterId            *string           `json:"vcenterId,omitempty"`
	Version              *string           `json:"version,omitempty"`
}

func (*ReprotectAgentDetails) GetLastDiscoveryInUtcAsTime

func (o *ReprotectAgentDetails) GetLastDiscoveryInUtcAsTime() (*time.Time, error)

func (*ReprotectAgentDetails) GetLastHeartbeatUtcAsTime

func (o *ReprotectAgentDetails) GetLastHeartbeatUtcAsTime() (*time.Time, error)

func (*ReprotectAgentDetails) SetLastDiscoveryInUtcAsTime

func (o *ReprotectAgentDetails) SetLastDiscoveryInUtcAsTime(input time.Time)

func (*ReprotectAgentDetails) SetLastHeartbeatUtcAsTime

func (o *ReprotectAgentDetails) SetLastHeartbeatUtcAsTime(input time.Time)

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

Jump to

Keyboard shortcuts

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