fluidrelayservers

package
v0.20231019.1113326 Latest Latest
Warning

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

Go to latest
Published: Oct 19, 2023 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/fluidrelay/2022-05-26/fluidrelayservers Documentation

The fluidrelayservers SDK allows for interaction with the Azure Resource Manager Service fluidrelay (API Version 2022-05-26).

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/fluidrelay/2022-05-26/fluidrelayservers"

Client Initialization

client := fluidrelayservers.NewFluidRelayServersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FluidRelayServersClient.CreateOrUpdate

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

payload := fluidrelayservers.FluidRelayServer{
	// ...
}


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: FluidRelayServersClient.Delete

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

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: FluidRelayServersClient.Get

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

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: FluidRelayServersClient.GetKeys

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

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

Example Usage: FluidRelayServersClient.ListByResourceGroup

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

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

Example Usage: FluidRelayServersClient.ListBySubscription

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

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

Example Usage: FluidRelayServersClient.ListKeys

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

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

Example Usage: FluidRelayServersClient.RegenerateKey

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

payload := fluidrelayservers.RegenerateKeyRequest{
	// ...
}


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

Example Usage: FluidRelayServersClient.Update

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

payload := fluidrelayservers.FluidRelayServerUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCmkIdentityType

func PossibleValuesForCmkIdentityType() []string

func PossibleValuesForKeyName

func PossibleValuesForKeyName() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForStorageSKU

func PossibleValuesForStorageSKU() []string

func ValidateFluidRelayServerID

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

ValidateFluidRelayServerID checks that 'input' can be parsed as a Fluid Relay Server ID

Types

type CmkIdentityType

type CmkIdentityType string
const (
	CmkIdentityTypeSystemAssigned CmkIdentityType = "SystemAssigned"
	CmkIdentityTypeUserAssigned   CmkIdentityType = "UserAssigned"
)

func (*CmkIdentityType) UnmarshalJSON added in v0.20230712.1163130

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

type CreateOrUpdateOperationResponse

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

type CustomerManagedKeyEncryptionProperties

type CustomerManagedKeyEncryptionProperties struct {
	KeyEncryptionKeyIdentity *CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity `json:"keyEncryptionKeyIdentity,omitempty"`
	KeyEncryptionKeyUrl      *string                                                         `json:"keyEncryptionKeyUrl,omitempty"`
}

type CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity

type CustomerManagedKeyEncryptionPropertiesKeyEncryptionKeyIdentity struct {
	IdentityType                   *CmkIdentityType `json:"identityType,omitempty"`
	UserAssignedIdentityResourceId *string          `json:"userAssignedIdentityResourceId,omitempty"`
}

type DeleteOperationResponse

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

type EncryptionProperties

type EncryptionProperties struct {
	CustomerManagedKeyEncryption *CustomerManagedKeyEncryptionProperties `json:"customerManagedKeyEncryption,omitempty"`
}

type FluidRelayEndpoints

type FluidRelayEndpoints struct {
	OrdererEndpoints *[]string `json:"ordererEndpoints,omitempty"`
	ServiceEndpoints *[]string `json:"serviceEndpoints,omitempty"`
	StorageEndpoints *[]string `json:"storageEndpoints,omitempty"`
}

type FluidRelayServer

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

type FluidRelayServerId

type FluidRelayServerId struct {
	SubscriptionId       string
	ResourceGroup        string
	FluidRelayServerName string
}

FluidRelayServerId is a struct representing the Resource ID for a Fluid Relay Server

func NewFluidRelayServerID

func NewFluidRelayServerID(subscriptionId string, resourceGroup string, fluidRelayServerName string) FluidRelayServerId

NewFluidRelayServerID returns a new FluidRelayServerId struct

func ParseFluidRelayServerID

func ParseFluidRelayServerID(input string) (*FluidRelayServerId, error)

ParseFluidRelayServerID parses 'input' into a FluidRelayServerId

func ParseFluidRelayServerIDInsensitively

func ParseFluidRelayServerIDInsensitively(input string) (*FluidRelayServerId, error)

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

func (FluidRelayServerId) ID

func (id FluidRelayServerId) ID() string

ID returns the formatted Fluid Relay Server ID

func (FluidRelayServerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Fluid Relay Server ID

func (FluidRelayServerId) String

func (id FluidRelayServerId) String() string

String returns a human-readable description of this Fluid Relay Server ID

type FluidRelayServerKeys

type FluidRelayServerKeys struct {
	Key1 *string `json:"key1,omitempty"`
	Key2 *string `json:"key2,omitempty"`
}

type FluidRelayServerOperationPredicate

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

func (FluidRelayServerOperationPredicate) Matches

type FluidRelayServerProperties

type FluidRelayServerProperties struct {
	Encryption          *EncryptionProperties `json:"encryption,omitempty"`
	FluidRelayEndpoints *FluidRelayEndpoints  `json:"fluidRelayEndpoints,omitempty"`
	FrsTenantId         *string               `json:"frsTenantId,omitempty"`
	ProvisioningState   *ProvisioningState    `json:"provisioningState,omitempty"`
	Storagesku          *StorageSKU           `json:"storagesku,omitempty"`
}

type FluidRelayServerUpdate

type FluidRelayServerUpdate struct {
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Properties *FluidRelayServerUpdateProperties  `json:"properties,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
}

type FluidRelayServerUpdateProperties

type FluidRelayServerUpdateProperties struct {
	Encryption *EncryptionProperties `json:"encryption,omitempty"`
}

type FluidRelayServersClient

type FluidRelayServersClient struct {
	Client *resourcemanager.Client
}

func NewFluidRelayServersClientWithBaseURI

func NewFluidRelayServersClientWithBaseURI(sdkApi sdkEnv.Api) (*FluidRelayServersClient, error)

func (FluidRelayServersClient) CreateOrUpdate

CreateOrUpdate ...

func (FluidRelayServersClient) Delete

Delete ...

func (FluidRelayServersClient) Get

Get ...

func (FluidRelayServersClient) GetKeys

GetKeys ...

func (FluidRelayServersClient) ListByResourceGroup

ListByResourceGroup ...

func (FluidRelayServersClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (FluidRelayServersClient) ListByResourceGroupCompleteMatchingPredicate

func (c FluidRelayServersClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate FluidRelayServerOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FluidRelayServersClient) ListBySubscription

ListBySubscription ...

func (FluidRelayServersClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (FluidRelayServersClient) ListBySubscriptionCompleteMatchingPredicate

func (c FluidRelayServersClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate FluidRelayServerOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FluidRelayServersClient) ListKeys

ListKeys ...

func (FluidRelayServersClient) RegenerateKey

RegenerateKey ...

func (FluidRelayServersClient) Update

Update ...

type GetKeysOperationResponse

type GetKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FluidRelayServerKeys
}

type GetOperationResponse

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

type KeyName

type KeyName string
const (
	KeyNameKeyOne KeyName = "key1"
	KeyNameKeyTwo KeyName = "key2"
)

func (*KeyName) UnmarshalJSON added in v0.20230712.1163130

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []FluidRelayServer
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]FluidRelayServer
}

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	Items []FluidRelayServer
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]FluidRelayServer
}

type ListKeysOperationResponse

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FluidRelayServerKeys
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON added in v0.20230712.1163130

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

type RegenerateKeyOperationResponse

type RegenerateKeyOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FluidRelayServerKeys
}

type RegenerateKeyRequest

type RegenerateKeyRequest struct {
	KeyName KeyName `json:"keyName"`
}

type StorageSKU

type StorageSKU string
const (
	StorageSKUBasic    StorageSKU = "basic"
	StorageSKUStandard StorageSKU = "standard"
)

func (*StorageSKU) UnmarshalJSON added in v0.20230712.1163130

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FluidRelayServer
}

Jump to

Keyboard shortcuts

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