replicationusages

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservices/2024-04-01/replicationusages Documentation

The replicationusages SDK allows for interaction with Azure Resource Manager recoveryservices (API Version 2024-04-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/recoveryservices/2024-04-01/replicationusages"

Client Initialization

client := replicationusages.NewReplicationUsagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ReplicationUsagesClient.List

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

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 ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type JobsSummary
• type ListOperationResponse
• type MonitoringSummary
• type ReplicationUsage
• type ReplicationUsageList
• type ReplicationUsagesClient
  • func NewReplicationUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationUsagesClient, error)
  • func (c ReplicationUsagesClient) List(ctx context.Context, id VaultId) (result ListOperationResponse, err error)
• 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) FromParseResult(input resourceids.ParseResult) error
  • func (id VaultId) ID() string
  • func (id VaultId) Segments() []resourceids.Segment
  • func (id VaultId) String() string

Functions

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 JobsSummary

type JobsSummary struct {
	FailedJobs     *int64 `json:"failedJobs,omitempty"`
	InProgressJobs *int64 `json:"inProgressJobs,omitempty"`
	SuspendedJobs  *int64 `json:"suspendedJobs,omitempty"`
}

type ListOperationResponse

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

type MonitoringSummary

type MonitoringSummary struct {
	DeprecatedProviderCount  *int64 `json:"deprecatedProviderCount,omitempty"`
	EventsCount              *int64 `json:"eventsCount,omitempty"`
	SupportedProviderCount   *int64 `json:"supportedProviderCount,omitempty"`
	UnHealthyProviderCount   *int64 `json:"unHealthyProviderCount,omitempty"`
	UnHealthyVMCount         *int64 `json:"unHealthyVmCount,omitempty"`
	UnsupportedProviderCount *int64 `json:"unsupportedProviderCount,omitempty"`
}

type ReplicationUsage

type ReplicationUsage struct {
	JobsSummary                      *JobsSummary       `json:"jobsSummary,omitempty"`
	MonitoringSummary                *MonitoringSummary `json:"monitoringSummary,omitempty"`
	ProtectedItemCount               *int64             `json:"protectedItemCount,omitempty"`
	RecoveryPlanCount                *int64             `json:"recoveryPlanCount,omitempty"`
	RecoveryServicesProviderAuthType *int64             `json:"recoveryServicesProviderAuthType,omitempty"`
	RegisteredServersCount           *int64             `json:"registeredServersCount,omitempty"`
}

type ReplicationUsageList

type ReplicationUsageList struct {
	Value *[]ReplicationUsage `json:"value,omitempty"`
}

type ReplicationUsagesClient

type ReplicationUsagesClient struct {
	Client *resourcemanager.Client
}

func NewReplicationUsagesClientWithBaseURI

func NewReplicationUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*ReplicationUsagesClient, error)

func (ReplicationUsagesClient) List

func (c ReplicationUsagesClient) List(ctx context.Context, id VaultId) (result ListOperationResponse, err error)

List ...

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

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

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