objectreplicationpolicies

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/objectreplicationpolicies Documentation

The objectreplicationpolicies SDK allows for interaction with the Azure Resource Manager Service storage (API Version 2023-05-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/objectreplicationpolicies"

Client Initialization

client := objectreplicationpolicies.NewObjectReplicationPoliciesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ObjectReplicationPoliciesClient.CreateOrUpdate

ctx := context.TODO()
id := objectreplicationpolicies.NewObjectReplicationPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "objectReplicationPolicyIdValue")

payload := objectreplicationpolicies.ObjectReplicationPolicy{
	// ...
}


read, err := client.CreateOrUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ObjectReplicationPoliciesClient.Delete

ctx := context.TODO()
id := objectreplicationpolicies.NewObjectReplicationPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "objectReplicationPolicyIdValue")

read, err := client.Delete(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ObjectReplicationPoliciesClient.Get

ctx := context.TODO()
id := objectreplicationpolicies.NewObjectReplicationPolicyID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue", "objectReplicationPolicyIdValue")

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

ctx := context.TODO()
id := commonids.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountValue")

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 ValidateObjectReplicationPolicyID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DeleteOperationResponse
• type GetOperationResponse
• type ListOperationResponse
• type ObjectReplicationPolicies
• type ObjectReplicationPoliciesClient
  • func NewObjectReplicationPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ObjectReplicationPoliciesClient, error)
  • func (c ObjectReplicationPoliciesClient) CreateOrUpdate(ctx context.Context, id ObjectReplicationPolicyId, ...) (result CreateOrUpdateOperationResponse, err error)
  • func (c ObjectReplicationPoliciesClient) Delete(ctx context.Context, id ObjectReplicationPolicyId) (result DeleteOperationResponse, err error)
  • func (c ObjectReplicationPoliciesClient) Get(ctx context.Context, id ObjectReplicationPolicyId) (result GetOperationResponse, err error)
  • func (c ObjectReplicationPoliciesClient) List(ctx context.Context, id commonids.StorageAccountId) (result ListOperationResponse, err error)
• type ObjectReplicationPolicy
• type ObjectReplicationPolicyFilter
• type ObjectReplicationPolicyId
  • func NewObjectReplicationPolicyID(subscriptionId string, resourceGroupName string, storageAccountName string, ...) ObjectReplicationPolicyId
  • func ParseObjectReplicationPolicyID(input string) (*ObjectReplicationPolicyId, error)
  • func ParseObjectReplicationPolicyIDInsensitively(input string) (*ObjectReplicationPolicyId, error)
  • func (id *ObjectReplicationPolicyId) FromParseResult(input resourceids.ParseResult) error
  • func (id ObjectReplicationPolicyId) ID() string
  • func (id ObjectReplicationPolicyId) Segments() []resourceids.Segment
  • func (id ObjectReplicationPolicyId) String() string
• type ObjectReplicationPolicyProperties
  • func (o *ObjectReplicationPolicyProperties) GetEnabledTimeAsTime() (*time.Time, error)
  • func (o *ObjectReplicationPolicyProperties) SetEnabledTimeAsTime(input time.Time)
• type ObjectReplicationPolicyRule

Functions

func ValidateObjectReplicationPolicyID

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

ValidateObjectReplicationPolicyID checks that 'input' can be parsed as a Object Replication Policy ID

Types

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ObjectReplicationPolicy
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

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

type ListOperationResponse

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

type ObjectReplicationPolicies

type ObjectReplicationPolicies struct {
	Value *[]ObjectReplicationPolicy `json:"value,omitempty"`
}

type ObjectReplicationPoliciesClient

type ObjectReplicationPoliciesClient struct {
	Client *resourcemanager.Client
}

func NewObjectReplicationPoliciesClientWithBaseURI

func NewObjectReplicationPoliciesClientWithBaseURI(sdkApi sdkEnv.Api) (*ObjectReplicationPoliciesClient, error)

func (ObjectReplicationPoliciesClient) CreateOrUpdate

func (c ObjectReplicationPoliciesClient) CreateOrUpdate(ctx context.Context, id ObjectReplicationPolicyId, input ObjectReplicationPolicy) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ObjectReplicationPoliciesClient) Delete

func (c ObjectReplicationPoliciesClient) Delete(ctx context.Context, id ObjectReplicationPolicyId) (result DeleteOperationResponse, err error)

Delete ...

func (ObjectReplicationPoliciesClient) Get

func (c ObjectReplicationPoliciesClient) Get(ctx context.Context, id ObjectReplicationPolicyId) (result GetOperationResponse, err error)

Get ...

func (ObjectReplicationPoliciesClient) List

func (c ObjectReplicationPoliciesClient) List(ctx context.Context, id commonids.StorageAccountId) (result ListOperationResponse, err error)

List ...

type ObjectReplicationPolicy

type ObjectReplicationPolicy struct {
	Id         *string                            `json:"id,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties *ObjectReplicationPolicyProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type ObjectReplicationPolicyFilter

type ObjectReplicationPolicyFilter struct {
	MinCreationTime *string   `json:"minCreationTime,omitempty"`
	PrefixMatch     *[]string `json:"prefixMatch,omitempty"`
}

type ObjectReplicationPolicyId

type ObjectReplicationPolicyId struct {
	SubscriptionId            string
	ResourceGroupName         string
	StorageAccountName        string
	ObjectReplicationPolicyId string
}

ObjectReplicationPolicyId is a struct representing the Resource ID for a Object Replication Policy

func NewObjectReplicationPolicyID

func NewObjectReplicationPolicyID(subscriptionId string, resourceGroupName string, storageAccountName string, objectReplicationPolicyId string) ObjectReplicationPolicyId

NewObjectReplicationPolicyID returns a new ObjectReplicationPolicyId struct

func ParseObjectReplicationPolicyID

func ParseObjectReplicationPolicyID(input string) (*ObjectReplicationPolicyId, error)

ParseObjectReplicationPolicyID parses 'input' into a ObjectReplicationPolicyId

func ParseObjectReplicationPolicyIDInsensitively

func ParseObjectReplicationPolicyIDInsensitively(input string) (*ObjectReplicationPolicyId, error)

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

func (*ObjectReplicationPolicyId) FromParseResult

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

func (ObjectReplicationPolicyId) ID

func (id ObjectReplicationPolicyId) ID() string

ID returns the formatted Object Replication Policy ID

func (ObjectReplicationPolicyId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Object Replication Policy ID

func (ObjectReplicationPolicyId) String

func (id ObjectReplicationPolicyId) String() string

String returns a human-readable description of this Object Replication Policy ID

type ObjectReplicationPolicyProperties

type ObjectReplicationPolicyProperties struct {
	DestinationAccount string                         `json:"destinationAccount"`
	EnabledTime        *string                        `json:"enabledTime,omitempty"`
	PolicyId           *string                        `json:"policyId,omitempty"`
	Rules              *[]ObjectReplicationPolicyRule `json:"rules,omitempty"`
	SourceAccount      string                         `json:"sourceAccount"`
}

func (*ObjectReplicationPolicyProperties) GetEnabledTimeAsTime

func (o *ObjectReplicationPolicyProperties) GetEnabledTimeAsTime() (*time.Time, error)

func (*ObjectReplicationPolicyProperties) SetEnabledTimeAsTime

func (o *ObjectReplicationPolicyProperties) SetEnabledTimeAsTime(input time.Time)

type ObjectReplicationPolicyRule

type ObjectReplicationPolicyRule struct {
	DestinationContainer string                         `json:"destinationContainer"`
	Filters              *ObjectReplicationPolicyFilter `json:"filters,omitempty"`
	RuleId               *string                        `json:"ruleId,omitempty"`
	SourceContainer      string                         `json:"sourceContainer"`
}