replicationprotectableitems

package
v0.20240923.1151247 Latest Latest
Warning

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

 Go to latest Published: Sep 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

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

Client Initialization

client := replicationprotectableitems.NewReplicationProtectableItemsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationProtectableItemsClient.Get

ctx := context.TODO()
id := replicationprotectableitems.NewReplicationProtectableItemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "resourceName", "fabricName", "protectionContainerName", "protectableItemName")

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: ReplicationProtectableItemsClient.ListByReplicationProtectionContainers

ctx := context.TODO()
id := replicationprotectableitems.NewReplicationProtectionContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "resourceName", "fabricName", "protectionContainerName")

// alternatively `client.ListByReplicationProtectionContainers(ctx, id, replicationprotectableitems.DefaultListByReplicationProtectionContainersOperationOptions())` can be used to do batched pagination
items, err := client.ListByReplicationProtectionContainersComplete(ctx, id, replicationprotectableitems.DefaultListByReplicationProtectionContainersOperationOptions())
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 PossibleValuesForPresenceStatus 

func PossibleValuesForPresenceStatus() []string

func ValidateReplicationProtectableItemID 

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

ValidateReplicationProtectableItemID checks that 'input' can be parsed as a Replication Protectable Item ID

func ValidateReplicationProtectionContainerID 

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

ValidateReplicationProtectionContainerID checks that 'input' can be parsed as a Replication Protection Container ID

Types

type BaseConfigurationSettingsImpl added in v0.20240920.1135249 

type BaseConfigurationSettingsImpl struct {
	InstanceType string `json:"instanceType"`
}

func (BaseConfigurationSettingsImpl) ConfigurationSettings added in v0.20240920.1135249 

func (s BaseConfigurationSettingsImpl) ConfigurationSettings() BaseConfigurationSettingsImpl

type ConfigurationSettings 

type ConfigurationSettings interface {
	ConfigurationSettings() BaseConfigurationSettingsImpl
}

func UnmarshalConfigurationSettingsImplementation added in v0.20240920.1135249 

func UnmarshalConfigurationSettingsImplementation(input []byte) (ConfigurationSettings, error)

type DiskDetails 

type DiskDetails struct {
	MaxSizeMB *int64  `json:"maxSizeMB,omitempty"`
	VhdId     *string `json:"vhdId,omitempty"`
	VhdName   *string `json:"vhdName,omitempty"`
	VhdType   *string `json:"vhdType,omitempty"`
}

type DiskVolumeDetails 

type DiskVolumeDetails struct {
	Label *string `json:"label,omitempty"`
	Name  *string `json:"name,omitempty"`
}

type GetOperationResponse 

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

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 

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

type HyperVVirtualMachineDetails 

type HyperVVirtualMachineDetails struct {
	DiskDetails            *[]DiskDetails  `json:"diskDetails,omitempty"`
	Generation             *string         `json:"generation,omitempty"`
	HasFibreChannelAdapter *PresenceStatus `json:"hasFibreChannelAdapter,omitempty"`
	HasPhysicalDisk        *PresenceStatus `json:"hasPhysicalDisk,omitempty"`
	HasSharedVhd           *PresenceStatus `json:"hasSharedVhd,omitempty"`
	HyperVHostId           *string         `json:"hyperVHostId,omitempty"`
	OsDetails              *OSDetails      `json:"osDetails,omitempty"`
	SourceItemId           *string         `json:"sourceItemId,omitempty"`

	InstanceType string `json:"instanceType"`
}

func (HyperVVirtualMachineDetails) ConfigurationSettings added in v0.20240920.1135249 

func (s HyperVVirtualMachineDetails) ConfigurationSettings() BaseConfigurationSettingsImpl

func (HyperVVirtualMachineDetails) MarshalJSON 

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

type InMageDiskDetails 

type InMageDiskDetails struct {
	DiskConfiguration *string              `json:"diskConfiguration,omitempty"`
	DiskId            *string              `json:"diskId,omitempty"`
	DiskName          *string              `json:"diskName,omitempty"`
	DiskSizeInMB      *string              `json:"diskSizeInMB,omitempty"`
	DiskType          *string              `json:"diskType,omitempty"`
	VolumeList        *[]DiskVolumeDetails `json:"volumeList,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 ListByReplicationProtectionContainersCompleteResult 

type ListByReplicationProtectionContainersCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ProtectableItem
}

type ListByReplicationProtectionContainersCustomPager added in v0.20240628.1153531 

type ListByReplicationProtectionContainersCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByReplicationProtectionContainersCustomPager) NextPageLink() *odata.Link

type ListByReplicationProtectionContainersOperationOptions 

type ListByReplicationProtectionContainersOperationOptions struct {
	Filter *string
	Take   *string
}

func DefaultListByReplicationProtectionContainersOperationOptions 

func DefaultListByReplicationProtectionContainersOperationOptions() ListByReplicationProtectionContainersOperationOptions

func (ListByReplicationProtectionContainersOperationOptions) ToHeaders 

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

func (ListByReplicationProtectionContainersOperationOptions) ToOData 

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

func (ListByReplicationProtectionContainersOperationOptions) ToQuery 

func (o ListByReplicationProtectionContainersOperationOptions) ToQuery() *client.QueryParams

type ListByReplicationProtectionContainersOperationResponse 

type ListByReplicationProtectionContainersOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ProtectableItem
}

type OSDetails 

type OSDetails struct {
	OSMajorVersion *string `json:"oSMajorVersion,omitempty"`
	OSMinorVersion *string `json:"oSMinorVersion,omitempty"`
	OSVersion      *string `json:"oSVersion,omitempty"`
	OsEdition      *string `json:"osEdition,omitempty"`
	OsType         *string `json:"osType,omitempty"`
	ProductType    *string `json:"productType,omitempty"`
}

type PresenceStatus 

type PresenceStatus string
const (
	PresenceStatusNotPresent PresenceStatus = "NotPresent"
	PresenceStatusPresent    PresenceStatus = "Present"
	PresenceStatusUnknown    PresenceStatus = "Unknown"
)

func (*PresenceStatus) UnmarshalJSON 

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

type ProtectableItem 

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

type ProtectableItemOperationPredicate 

type ProtectableItemOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ProtectableItemOperationPredicate) Matches 

func (p ProtectableItemOperationPredicate) Matches(input ProtectableItem) bool

type ProtectableItemProperties 

type ProtectableItemProperties struct {
	CustomDetails                 ConfigurationSettings `json:"customDetails"`
	FriendlyName                  *string               `json:"friendlyName,omitempty"`
	ProtectionReadinessErrors     *[]string             `json:"protectionReadinessErrors,omitempty"`
	ProtectionStatus              *string               `json:"protectionStatus,omitempty"`
	RecoveryServicesProviderId    *string               `json:"recoveryServicesProviderId,omitempty"`
	ReplicationProtectedItemId    *string               `json:"replicationProtectedItemId,omitempty"`
	SupportedReplicationProviders *[]string             `json:"supportedReplicationProviders,omitempty"`
}

func (*ProtectableItemProperties) UnmarshalJSON 

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

type RawConfigurationSettingsImpl 

type RawConfigurationSettingsImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawConfigurationSettingsImpl 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).

func (RawConfigurationSettingsImpl) ConfigurationSettings added in v0.20240920.1135249 

func (s RawConfigurationSettingsImpl) ConfigurationSettings() BaseConfigurationSettingsImpl

type ReplicationGroupDetails 

type ReplicationGroupDetails struct {
	InstanceType string `json:"instanceType"`
}

func (ReplicationGroupDetails) ConfigurationSettings added in v0.20240920.1135249 

func (s ReplicationGroupDetails) ConfigurationSettings() BaseConfigurationSettingsImpl

func (ReplicationGroupDetails) MarshalJSON 

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

type ReplicationProtectableItemId 

type ReplicationProtectableItemId struct {
	SubscriptionId                     string
	ResourceGroupName                  string
	VaultName                          string
	ReplicationFabricName              string
	ReplicationProtectionContainerName string
	ReplicationProtectableItemName     string
}

ReplicationProtectableItemId is a struct representing the Resource ID for a Replication Protectable Item

func NewReplicationProtectableItemID 

func NewReplicationProtectableItemID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationProtectionContainerName string, replicationProtectableItemName string) ReplicationProtectableItemId

NewReplicationProtectableItemID returns a new ReplicationProtectableItemId struct

func ParseReplicationProtectableItemID 

func ParseReplicationProtectableItemID(input string) (*ReplicationProtectableItemId, error)

ParseReplicationProtectableItemID parses 'input' into a ReplicationProtectableItemId

func ParseReplicationProtectableItemIDInsensitively 

func ParseReplicationProtectableItemIDInsensitively(input string) (*ReplicationProtectableItemId, error)

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

func (*ReplicationProtectableItemId) FromParseResult 

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

func (ReplicationProtectableItemId) ID 

func (id ReplicationProtectableItemId) ID() string

ID returns the formatted Replication Protectable Item ID

func (ReplicationProtectableItemId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Replication Protectable Item ID

func (ReplicationProtectableItemId) String 

func (id ReplicationProtectableItemId) String() string

String returns a human-readable description of this Replication Protectable Item ID

type ReplicationProtectableItemsClient 

type ReplicationProtectableItemsClient struct {
	Client *resourcemanager.Client
}

func NewReplicationProtectableItemsClientWithBaseURI 

func NewReplicationProtectableItemsClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationProtectableItemsClient, error)

func (ReplicationProtectableItemsClient) Get 

func (c ReplicationProtectableItemsClient) Get(ctx context.Context, id ReplicationProtectableItemId) (result GetOperationResponse, err error)

Get ...

func (ReplicationProtectableItemsClient) ListByReplicationProtectionContainers 

func (c ReplicationProtectableItemsClient) ListByReplicationProtectionContainers(ctx context.Context, id ReplicationProtectionContainerId, options ListByReplicationProtectionContainersOperationOptions) (result ListByReplicationProtectionContainersOperationResponse, err error)

ListByReplicationProtectionContainers ...

func (ReplicationProtectableItemsClient) ListByReplicationProtectionContainersComplete 

func (c ReplicationProtectableItemsClient) ListByReplicationProtectionContainersComplete(ctx context.Context, id ReplicationProtectionContainerId, options ListByReplicationProtectionContainersOperationOptions) (ListByReplicationProtectionContainersCompleteResult, error)

ListByReplicationProtectionContainersComplete retrieves all the results into a single object

func (ReplicationProtectableItemsClient) ListByReplicationProtectionContainersCompleteMatchingPredicate 

func (c ReplicationProtectableItemsClient) ListByReplicationProtectionContainersCompleteMatchingPredicate(ctx context.Context, id ReplicationProtectionContainerId, options ListByReplicationProtectionContainersOperationOptions, predicate ProtectableItemOperationPredicate) (result ListByReplicationProtectionContainersCompleteResult, err error)

ListByReplicationProtectionContainersCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ReplicationProtectionContainerId 

type ReplicationProtectionContainerId struct {
	SubscriptionId                     string
	ResourceGroupName                  string
	VaultName                          string
	ReplicationFabricName              string
	ReplicationProtectionContainerName string
}

ReplicationProtectionContainerId is a struct representing the Resource ID for a Replication Protection Container

func NewReplicationProtectionContainerID 

func NewReplicationProtectionContainerID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationProtectionContainerName string) ReplicationProtectionContainerId

NewReplicationProtectionContainerID returns a new ReplicationProtectionContainerId struct

func ParseReplicationProtectionContainerID 

func ParseReplicationProtectionContainerID(input string) (*ReplicationProtectionContainerId, error)

ParseReplicationProtectionContainerID parses 'input' into a ReplicationProtectionContainerId

func ParseReplicationProtectionContainerIDInsensitively 

func ParseReplicationProtectionContainerIDInsensitively(input string) (*ReplicationProtectionContainerId, error)

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

func (*ReplicationProtectionContainerId) FromParseResult 

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

func (ReplicationProtectionContainerId) ID 

func (id ReplicationProtectionContainerId) ID() string

ID returns the formatted Replication Protection Container ID

func (ReplicationProtectionContainerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Replication Protection Container ID

func (ReplicationProtectionContainerId) String 

func (id ReplicationProtectionContainerId) String() string

String returns a human-readable description of this Replication Protection Container ID

type VMmVirtualMachineDetails 

type VMmVirtualMachineDetails struct {
	InstanceType string `json:"instanceType"`
}

func (VMmVirtualMachineDetails) ConfigurationSettings added in v0.20240920.1135249 

func (s VMmVirtualMachineDetails) ConfigurationSettings() BaseConfigurationSettingsImpl

func (VMmVirtualMachineDetails) MarshalJSON 

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

type VMwareVirtualMachineDetails 

type VMwareVirtualMachineDetails struct {
	AgentGeneratedId        *string              `json:"agentGeneratedId,omitempty"`
	AgentInstalled          *string              `json:"agentInstalled,omitempty"`
	AgentVersion            *string              `json:"agentVersion,omitempty"`
	DiscoveryType           *string              `json:"discoveryType,omitempty"`
	DiskDetails             *[]InMageDiskDetails `json:"diskDetails,omitempty"`
	IPAddress               *string              `json:"ipAddress,omitempty"`
	OsType                  *string              `json:"osType,omitempty"`
	PoweredOn               *string              `json:"poweredOn,omitempty"`
	VCenterInfrastructureId *string              `json:"vCenterInfrastructureId,omitempty"`
	ValidationErrors        *[]HealthError       `json:"validationErrors,omitempty"`

	InstanceType string `json:"instanceType"`
}

func (VMwareVirtualMachineDetails) ConfigurationSettings added in v0.20240920.1135249 

func (s VMwareVirtualMachineDetails) ConfigurationSettings() BaseConfigurationSettingsImpl

func (VMwareVirtualMachineDetails) MarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.