storagesyncservicesresource

package
v0.20240529.1155048 Latest Latest
Warning

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

Go to latest
Published: May 29, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README ¶

github.com/hashicorp/go-azure-sdk/resource-manager/storagesync/2022-09-01/storagesyncservicesresource Documentation

The storagesyncservicesresource SDK allows for interaction with the Azure Resource Manager Service storagesync (API Version 2022-09-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/storagesync/2022-09-01/storagesyncservicesresource"

Client Initialization

client := storagesyncservicesresource.NewStorageSyncServicesResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StorageSyncServicesResourceClient.StorageSyncServicesCreate

ctx := context.TODO()
id := storagesyncservicesresource.NewStorageSyncServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue")

payload := storagesyncservicesresource.StorageSyncServiceCreateParameters{
	// ...
}


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

Example Usage: StorageSyncServicesResourceClient.StorageSyncServicesDelete

ctx := context.TODO()
id := storagesyncservicesresource.NewStorageSyncServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue")

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

Example Usage: StorageSyncServicesResourceClient.StorageSyncServicesGet

ctx := context.TODO()
id := storagesyncservicesresource.NewStorageSyncServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue")

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

Example Usage: StorageSyncServicesResourceClient.StorageSyncServicesListByResourceGroup

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

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

Example Usage: StorageSyncServicesResourceClient.StorageSyncServicesListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: StorageSyncServicesResourceClient.StorageSyncServicesUpdate

ctx := context.TODO()
id := storagesyncservicesresource.NewStorageSyncServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageSyncServiceValue")

payload := storagesyncservicesresource.StorageSyncServiceUpdateParameters{
	// ...
}


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

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func PossibleValuesForIncomingTrafficPolicy ¶

func PossibleValuesForIncomingTrafficPolicy() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState ¶

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus ¶

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func ValidateStorageSyncServiceID ¶

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

ValidateStorageSyncServiceID checks that 'input' can be parsed as a Storage Sync Service ID

Types ¶

type IncomingTrafficPolicy ¶

type IncomingTrafficPolicy string
const (
	IncomingTrafficPolicyAllowAllTraffic          IncomingTrafficPolicy = "AllowAllTraffic"
	IncomingTrafficPolicyAllowVirtualNetworksOnly IncomingTrafficPolicy = "AllowVirtualNetworksOnly"
)

func (*IncomingTrafficPolicy) UnmarshalJSON ¶

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

type PrivateEndpoint ¶

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection ¶

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

type PrivateEndpointConnectionProperties ¶

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                                   `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState ¶

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON ¶

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

type PrivateEndpointServiceConnectionStatus ¶

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON ¶

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

type PrivateLinkServiceConnectionState ¶

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                                 `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

type StorageSyncService ¶

type StorageSyncService struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                                   `json:"location"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *StorageSyncServiceProperties            `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                   `json:"systemData,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type StorageSyncServiceArray ¶

type StorageSyncServiceArray struct {
	Value *[]StorageSyncService `json:"value,omitempty"`
}

type StorageSyncServiceCreateParameters ¶

type StorageSyncServiceCreateParameters struct {
	Id         *string                                       `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap      `json:"identity,omitempty"`
	Location   string                                        `json:"location"`
	Name       *string                                       `json:"name,omitempty"`
	Properties *StorageSyncServiceCreateParametersProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                        `json:"systemData,omitempty"`
	Tags       *map[string]string                            `json:"tags,omitempty"`
	Type       *string                                       `json:"type,omitempty"`
}

type StorageSyncServiceCreateParametersProperties ¶

type StorageSyncServiceCreateParametersProperties struct {
	IncomingTrafficPolicy *IncomingTrafficPolicy `json:"incomingTrafficPolicy,omitempty"`
	UseIdentity           *bool                  `json:"useIdentity,omitempty"`
}

type StorageSyncServiceId ¶

type StorageSyncServiceId struct {
	SubscriptionId         string
	ResourceGroupName      string
	StorageSyncServiceName string
}

StorageSyncServiceId is a struct representing the Resource ID for a Storage Sync Service

func NewStorageSyncServiceID ¶

func NewStorageSyncServiceID(subscriptionId string, resourceGroupName string, storageSyncServiceName string) StorageSyncServiceId

NewStorageSyncServiceID returns a new StorageSyncServiceId struct

func ParseStorageSyncServiceID ¶

func ParseStorageSyncServiceID(input string) (*StorageSyncServiceId, error)

ParseStorageSyncServiceID parses 'input' into a StorageSyncServiceId

func ParseStorageSyncServiceIDInsensitively ¶

func ParseStorageSyncServiceIDInsensitively(input string) (*StorageSyncServiceId, error)

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

func (*StorageSyncServiceId) FromParseResult ¶

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

func (StorageSyncServiceId) ID ¶

func (id StorageSyncServiceId) ID() string

ID returns the formatted Storage Sync Service ID

func (StorageSyncServiceId) Segments ¶

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

Segments returns a slice of Resource ID Segments which comprise this Storage Sync Service ID

func (StorageSyncServiceId) String ¶

func (id StorageSyncServiceId) String() string

String returns a human-readable description of this Storage Sync Service ID

type StorageSyncServiceProperties ¶

type StorageSyncServiceProperties struct {
	IncomingTrafficPolicy      *IncomingTrafficPolicy       `json:"incomingTrafficPolicy,omitempty"`
	LastOperationName          *string                      `json:"lastOperationName,omitempty"`
	LastWorkflowId             *string                      `json:"lastWorkflowId,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnection `json:"privateEndpointConnections,omitempty"`
	ProvisioningState          *string                      `json:"provisioningState,omitempty"`
	StorageSyncServiceStatus   *int64                       `json:"storageSyncServiceStatus,omitempty"`
	StorageSyncServiceUid      *string                      `json:"storageSyncServiceUid,omitempty"`
	UseIdentity                *bool                        `json:"useIdentity,omitempty"`
}

type StorageSyncServiceUpdateParameters ¶

type StorageSyncServiceUpdateParameters struct {
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Properties *StorageSyncServiceUpdateProperties      `json:"properties,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
}

type StorageSyncServiceUpdateProperties ¶

type StorageSyncServiceUpdateProperties struct {
	IncomingTrafficPolicy *IncomingTrafficPolicy `json:"incomingTrafficPolicy,omitempty"`
	UseIdentity           *bool                  `json:"useIdentity,omitempty"`
}

type StorageSyncServicesCreateOperationResponse ¶

type StorageSyncServicesCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageSyncService
}

type StorageSyncServicesDeleteOperationResponse ¶

type StorageSyncServicesDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type StorageSyncServicesGetOperationResponse ¶

type StorageSyncServicesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageSyncService
}

type StorageSyncServicesListByResourceGroupOperationResponse ¶

type StorageSyncServicesListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageSyncServiceArray
}

type StorageSyncServicesListBySubscriptionOperationResponse ¶

type StorageSyncServicesListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageSyncServiceArray
}

type StorageSyncServicesResourceClient ¶

type StorageSyncServicesResourceClient struct {
	Client *resourcemanager.Client
}

func NewStorageSyncServicesResourceClientWithBaseURI ¶

func NewStorageSyncServicesResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*StorageSyncServicesResourceClient, error)

func (StorageSyncServicesResourceClient) StorageSyncServicesCreate ¶

StorageSyncServicesCreate ...

func (StorageSyncServicesResourceClient) StorageSyncServicesCreateThenPoll ¶

StorageSyncServicesCreateThenPoll performs StorageSyncServicesCreate then polls until it's completed

func (StorageSyncServicesResourceClient) StorageSyncServicesDelete ¶

StorageSyncServicesDelete ...

func (StorageSyncServicesResourceClient) StorageSyncServicesDeleteThenPoll ¶

func (c StorageSyncServicesResourceClient) StorageSyncServicesDeleteThenPoll(ctx context.Context, id StorageSyncServiceId) error

StorageSyncServicesDeleteThenPoll performs StorageSyncServicesDelete then polls until it's completed

func (StorageSyncServicesResourceClient) StorageSyncServicesGet ¶

StorageSyncServicesGet ...

func (StorageSyncServicesResourceClient) StorageSyncServicesListByResourceGroup ¶

StorageSyncServicesListByResourceGroup ...

func (StorageSyncServicesResourceClient) StorageSyncServicesListBySubscription ¶

StorageSyncServicesListBySubscription ...

func (StorageSyncServicesResourceClient) StorageSyncServicesUpdate ¶

StorageSyncServicesUpdate ...

func (StorageSyncServicesResourceClient) StorageSyncServicesUpdateThenPoll ¶

StorageSyncServicesUpdateThenPoll performs StorageSyncServicesUpdate then polls until it's completed

type StorageSyncServicesUpdateOperationResponse ¶

type StorageSyncServicesUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageSyncService
}

Jump to

Keyboard shortcuts

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