replicationrecoveryservicesproviders

package
v0.20230725.1160316 Latest Latest
Warning

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

Go to latest
Published: Jul 25, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

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

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

Client Initialization

client := replicationrecoveryservicesproviders.NewReplicationRecoveryServicesProvidersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationRecoveryServicesProvidersClient.Create

ctx := context.TODO()
id := replicationrecoveryservicesproviders.NewReplicationRecoveryServicesProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationRecoveryServicesProviderValue")

payload := replicationrecoveryservicesproviders.AddRecoveryServicesProviderInput{
	// ...
}


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

Example Usage: ReplicationRecoveryServicesProvidersClient.Delete

ctx := context.TODO()
id := replicationrecoveryservicesproviders.NewReplicationRecoveryServicesProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationRecoveryServicesProviderValue")

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

Example Usage: ReplicationRecoveryServicesProvidersClient.Get

ctx := context.TODO()
id := replicationrecoveryservicesproviders.NewReplicationRecoveryServicesProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationRecoveryServicesProviderValue")

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

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

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

Example Usage: ReplicationRecoveryServicesProvidersClient.ListByReplicationFabrics

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

// alternatively `client.ListByReplicationFabrics(ctx, id)` can be used to do batched pagination
items, err := client.ListByReplicationFabricsComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ReplicationRecoveryServicesProvidersClient.Purge

ctx := context.TODO()
id := replicationrecoveryservicesproviders.NewReplicationRecoveryServicesProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationRecoveryServicesProviderValue")

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

Example Usage: ReplicationRecoveryServicesProvidersClient.RefreshProvider

ctx := context.TODO()
id := replicationrecoveryservicesproviders.NewReplicationRecoveryServicesProviderID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue", "replicationFabricValue", "replicationRecoveryServicesProviderValue")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAgentVersionStatus

func PossibleValuesForAgentVersionStatus() []string

func PossibleValuesForHealthErrorCustomerResolvability

func PossibleValuesForHealthErrorCustomerResolvability() []string

func ValidateReplicationFabricID

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

ValidateReplicationFabricID checks that 'input' can be parsed as a Replication Fabric ID

func ValidateReplicationRecoveryServicesProviderID

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

ValidateReplicationRecoveryServicesProviderID checks that 'input' can be parsed as a Replication Recovery Services Provider ID

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 AddRecoveryServicesProviderInput

type AddRecoveryServicesProviderInput struct {
	Properties AddRecoveryServicesProviderInputProperties `json:"properties"`
}

type AddRecoveryServicesProviderInputProperties

type AddRecoveryServicesProviderInputProperties struct {
	AuthenticationIdentityInput          IdentityProviderInput  `json:"authenticationIdentityInput"`
	BiosId                               *string                `json:"biosId,omitempty"`
	DataPlaneAuthenticationIdentityInput *IdentityProviderInput `json:"dataPlaneAuthenticationIdentityInput,omitempty"`
	MachineId                            *string                `json:"machineId,omitempty"`
	MachineName                          string                 `json:"machineName"`
	ResourceAccessIdentityInput          IdentityProviderInput  `json:"resourceAccessIdentityInput"`
}

type AgentVersionStatus

type AgentVersionStatus string
const (
	AgentVersionStatusDeprecated             AgentVersionStatus = "Deprecated"
	AgentVersionStatusNotSupported           AgentVersionStatus = "NotSupported"
	AgentVersionStatusSecurityUpdateRequired AgentVersionStatus = "SecurityUpdateRequired"
	AgentVersionStatusSupported              AgentVersionStatus = "Supported"
	AgentVersionStatusUpdateRequired         AgentVersionStatus = "UpdateRequired"
)

type CreateOperationResponse

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

type DeleteOperationResponse

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

type GetOperationResponse

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

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

type IdentityProviderDetails

type IdentityProviderDetails struct {
	AadAuthority  *string `json:"aadAuthority,omitempty"`
	ApplicationId *string `json:"applicationId,omitempty"`
	Audience      *string `json:"audience,omitempty"`
	ObjectId      *string `json:"objectId,omitempty"`
	TenantId      *string `json:"tenantId,omitempty"`
}

type IdentityProviderInput

type IdentityProviderInput struct {
	AadAuthority  string `json:"aadAuthority"`
	ApplicationId string `json:"applicationId"`
	Audience      string `json:"audience"`
	ObjectId      string `json:"objectId"`
	TenantId      string `json:"tenantId"`
}

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 ListByReplicationFabricsCompleteResult

type ListByReplicationFabricsCompleteResult struct {
	Items []RecoveryServicesProvider
}

type ListByReplicationFabricsOperationResponse

type ListByReplicationFabricsOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]RecoveryServicesProvider
	// contains filtered or unexported fields
}

func (ListByReplicationFabricsOperationResponse) HasMore

func (ListByReplicationFabricsOperationResponse) LoadMore

type ListCompleteResult

type ListCompleteResult struct {
	Items []RecoveryServicesProvider
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]RecoveryServicesProvider
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

type PurgeOperationResponse

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

type RecoveryServicesProvider

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

type RecoveryServicesProviderOperationPredicate

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

func (RecoveryServicesProviderOperationPredicate) Matches

type RecoveryServicesProviderProperties

type RecoveryServicesProviderProperties struct {
	AllowedScenarios                       *[]string                `json:"allowedScenarios,omitempty"`
	AuthenticationIdentityDetails          *IdentityProviderDetails `json:"authenticationIdentityDetails,omitempty"`
	BiosId                                 *string                  `json:"biosId,omitempty"`
	ConnectionStatus                       *string                  `json:"connectionStatus,omitempty"`
	DataPlaneAuthenticationIdentityDetails *IdentityProviderDetails `json:"dataPlaneAuthenticationIdentityDetails,omitempty"`
	DraIdentifier                          *string                  `json:"draIdentifier,omitempty"`
	FabricFriendlyName                     *string                  `json:"fabricFriendlyName,omitempty"`
	FabricType                             *string                  `json:"fabricType,omitempty"`
	FriendlyName                           *string                  `json:"friendlyName,omitempty"`
	HealthErrorDetails                     *[]HealthError           `json:"healthErrorDetails,omitempty"`
	LastHeartBeat                          *string                  `json:"lastHeartBeat,omitempty"`
	MachineId                              *string                  `json:"machineId,omitempty"`
	MachineName                            *string                  `json:"machineName,omitempty"`
	ProtectedItemCount                     *int64                   `json:"protectedItemCount,omitempty"`
	ProviderVersion                        *string                  `json:"providerVersion,omitempty"`
	ProviderVersionDetails                 *VersionDetails          `json:"providerVersionDetails,omitempty"`
	ProviderVersionExpiryDate              *string                  `json:"providerVersionExpiryDate,omitempty"`
	ProviderVersionState                   *string                  `json:"providerVersionState,omitempty"`
	ResourceAccessIdentityDetails          *IdentityProviderDetails `json:"resourceAccessIdentityDetails,omitempty"`
	ServerVersion                          *string                  `json:"serverVersion,omitempty"`
}

func (*RecoveryServicesProviderProperties) GetLastHeartBeatAsTime

func (o *RecoveryServicesProviderProperties) GetLastHeartBeatAsTime() (*time.Time, error)

func (*RecoveryServicesProviderProperties) GetProviderVersionExpiryDateAsTime

func (o *RecoveryServicesProviderProperties) GetProviderVersionExpiryDateAsTime() (*time.Time, error)

func (*RecoveryServicesProviderProperties) SetLastHeartBeatAsTime

func (o *RecoveryServicesProviderProperties) SetLastHeartBeatAsTime(input time.Time)

func (*RecoveryServicesProviderProperties) SetProviderVersionExpiryDateAsTime

func (o *RecoveryServicesProviderProperties) SetProviderVersionExpiryDateAsTime(input time.Time)

type RefreshProviderOperationResponse

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

type ReplicationFabricId

type ReplicationFabricId struct {
	SubscriptionId        string
	ResourceGroupName     string
	VaultName             string
	ReplicationFabricName string
}

ReplicationFabricId is a struct representing the Resource ID for a Replication Fabric

func NewReplicationFabricID

func NewReplicationFabricID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string) ReplicationFabricId

NewReplicationFabricID returns a new ReplicationFabricId struct

func ParseReplicationFabricID

func ParseReplicationFabricID(input string) (*ReplicationFabricId, error)

ParseReplicationFabricID parses 'input' into a ReplicationFabricId

func ParseReplicationFabricIDInsensitively

func ParseReplicationFabricIDInsensitively(input string) (*ReplicationFabricId, error)

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

func (ReplicationFabricId) ID

func (id ReplicationFabricId) ID() string

ID returns the formatted Replication Fabric ID

func (ReplicationFabricId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Replication Fabric ID

func (ReplicationFabricId) String

func (id ReplicationFabricId) String() string

String returns a human-readable description of this Replication Fabric ID

type ReplicationRecoveryServicesProviderId

type ReplicationRecoveryServicesProviderId struct {
	SubscriptionId                          string
	ResourceGroupName                       string
	VaultName                               string
	ReplicationFabricName                   string
	ReplicationRecoveryServicesProviderName string
}

ReplicationRecoveryServicesProviderId is a struct representing the Resource ID for a Replication Recovery Services Provider

func NewReplicationRecoveryServicesProviderID

func NewReplicationRecoveryServicesProviderID(subscriptionId string, resourceGroupName string, vaultName string, replicationFabricName string, replicationRecoveryServicesProviderName string) ReplicationRecoveryServicesProviderId

NewReplicationRecoveryServicesProviderID returns a new ReplicationRecoveryServicesProviderId struct

func ParseReplicationRecoveryServicesProviderID

func ParseReplicationRecoveryServicesProviderID(input string) (*ReplicationRecoveryServicesProviderId, error)

ParseReplicationRecoveryServicesProviderID parses 'input' into a ReplicationRecoveryServicesProviderId

func ParseReplicationRecoveryServicesProviderIDInsensitively

func ParseReplicationRecoveryServicesProviderIDInsensitively(input string) (*ReplicationRecoveryServicesProviderId, error)

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

func (ReplicationRecoveryServicesProviderId) ID

ID returns the formatted Replication Recovery Services Provider ID

func (ReplicationRecoveryServicesProviderId) Segments

Segments returns a slice of Resource ID Segments which comprise this Replication Recovery Services Provider ID

func (ReplicationRecoveryServicesProviderId) String

String returns a human-readable description of this Replication Recovery Services Provider ID

type ReplicationRecoveryServicesProvidersClient

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

func NewReplicationRecoveryServicesProvidersClientWithBaseURI

func NewReplicationRecoveryServicesProvidersClientWithBaseURI(endpoint string) ReplicationRecoveryServicesProvidersClient

func (ReplicationRecoveryServicesProvidersClient) Create

Create ...

func (ReplicationRecoveryServicesProvidersClient) CreateThenPoll

CreateThenPoll performs Create then polls until it's completed

func (ReplicationRecoveryServicesProvidersClient) Delete

Delete ...

func (ReplicationRecoveryServicesProvidersClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ReplicationRecoveryServicesProvidersClient) Get

Get ...

func (ReplicationRecoveryServicesProvidersClient) List

List ...

func (ReplicationRecoveryServicesProvidersClient) ListByReplicationFabrics

ListByReplicationFabrics ...

func (ReplicationRecoveryServicesProvidersClient) ListByReplicationFabricsComplete

ListByReplicationFabricsComplete retrieves all of the results into a single object

func (ReplicationRecoveryServicesProvidersClient) ListByReplicationFabricsCompleteMatchingPredicate

ListByReplicationFabricsCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ReplicationRecoveryServicesProvidersClient) ListComplete

ListComplete retrieves all of the results into a single object

func (ReplicationRecoveryServicesProvidersClient) ListCompleteMatchingPredicate

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (ReplicationRecoveryServicesProvidersClient) Purge

Purge ...

func (ReplicationRecoveryServicesProvidersClient) PurgeThenPoll

PurgeThenPoll performs Purge then polls until it's completed

func (ReplicationRecoveryServicesProvidersClient) RefreshProvider

RefreshProvider ...

func (ReplicationRecoveryServicesProvidersClient) RefreshProviderThenPoll

RefreshProviderThenPoll performs RefreshProvider then polls until it's completed

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

type VersionDetails

type VersionDetails struct {
	ExpiryDate *string             `json:"expiryDate,omitempty"`
	Status     *AgentVersionStatus `json:"status,omitempty"`
	Version    *string             `json:"version,omitempty"`
}

func (*VersionDetails) GetExpiryDateAsTime

func (o *VersionDetails) GetExpiryDateAsTime() (*time.Time, error)

func (*VersionDetails) SetExpiryDateAsTime

func (o *VersionDetails) SetExpiryDateAsTime(input time.Time)

Jump to

Keyboard shortcuts

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