wcfrelays

package
v0.20230201.1125454 Latest Latest
Warning

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

Go to latest
Published: Feb 1, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/relay/2021-11-01/wcfrelays Documentation

The wcfrelays SDK allows for interaction with the Azure Resource Manager Service relay (API Version 2021-11-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/relay/2021-11-01/wcfrelays"

Client Initialization

client := wcfrelays.NewWCFRelaysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WCFRelaysClient.CreateOrUpdate

ctx := context.TODO()
id := wcfrelays.NewWcfRelayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue")

payload := wcfrelays.WcfRelay{
	// ...
}


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: WCFRelaysClient.CreateOrUpdateAuthorizationRule

ctx := context.TODO()
id := wcfrelays.NewWcfRelayAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue", "authorizationRuleValue")

payload := wcfrelays.AuthorizationRule{
	// ...
}


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

Example Usage: WCFRelaysClient.Delete

ctx := context.TODO()
id := wcfrelays.NewWcfRelayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue")

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: WCFRelaysClient.DeleteAuthorizationRule

ctx := context.TODO()
id := wcfrelays.NewWcfRelayAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue", "authorizationRuleValue")

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

Example Usage: WCFRelaysClient.Get

ctx := context.TODO()
id := wcfrelays.NewWcfRelayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue")

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: WCFRelaysClient.GetAuthorizationRule

ctx := context.TODO()
id := wcfrelays.NewWcfRelayAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue", "authorizationRuleValue")

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

Example Usage: WCFRelaysClient.ListAuthorizationRules

ctx := context.TODO()
id := wcfrelays.NewWcfRelayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue")

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

Example Usage: WCFRelaysClient.ListByNamespace

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

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

Example Usage: WCFRelaysClient.ListKeys

ctx := context.TODO()
id := wcfrelays.NewWcfRelayAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue", "authorizationRuleValue")

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: WCFRelaysClient.RegenerateKeys

ctx := context.TODO()
id := wcfrelays.NewWcfRelayAuthorizationRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "namespaceValue", "wcfRelayValue", "authorizationRuleValue")

payload := wcfrelays.RegenerateAccessKeyParameters{
	// ...
}


read, err := client.RegenerateKeys(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 PossibleValuesForAccessRights

func PossibleValuesForAccessRights() []string

func PossibleValuesForKeyType

func PossibleValuesForKeyType() []string

func PossibleValuesForRelaytype

func PossibleValuesForRelaytype() []string

func ValidateNamespaceID

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

ValidateNamespaceID checks that 'input' can be parsed as a Namespace ID

func ValidateWcfRelayAuthorizationRuleID

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

ValidateWcfRelayAuthorizationRuleID checks that 'input' can be parsed as a Wcf Relay Authorization Rule ID

func ValidateWcfRelayID

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

ValidateWcfRelayID checks that 'input' can be parsed as a Wcf Relay ID

Types

type AccessKeys

type AccessKeys struct {
	KeyName                   *string `json:"keyName,omitempty"`
	PrimaryConnectionString   *string `json:"primaryConnectionString,omitempty"`
	PrimaryKey                *string `json:"primaryKey,omitempty"`
	SecondaryConnectionString *string `json:"secondaryConnectionString,omitempty"`
	SecondaryKey              *string `json:"secondaryKey,omitempty"`
}

type AccessRights

type AccessRights string
const (
	AccessRightsListen AccessRights = "Listen"
	AccessRightsManage AccessRights = "Manage"
	AccessRightsSend   AccessRights = "Send"
)

type AuthorizationRule

type AuthorizationRule struct {
	Id         *string                      `json:"id,omitempty"`
	Location   *string                      `json:"location,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *AuthorizationRuleProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData       `json:"systemData,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

type AuthorizationRuleOperationPredicate

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

func (AuthorizationRuleOperationPredicate) Matches

type AuthorizationRuleProperties

type AuthorizationRuleProperties struct {
	Rights []AccessRights `json:"rights"`
}

type CreateOrUpdateAuthorizationRuleOperationResponse

type CreateOrUpdateAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	Model        *AuthorizationRule
}

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *WcfRelay
}

type DeleteAuthorizationRuleOperationResponse

type DeleteAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	HttpResponse *http.Response
}

type GetAuthorizationRuleOperationResponse

type GetAuthorizationRuleOperationResponse struct {
	HttpResponse *http.Response
	Model        *AuthorizationRule
}

type GetOperationResponse

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

type KeyType

type KeyType string
const (
	KeyTypePrimaryKey   KeyType = "PrimaryKey"
	KeyTypeSecondaryKey KeyType = "SecondaryKey"
)

type ListAuthorizationRulesCompleteResult

type ListAuthorizationRulesCompleteResult struct {
	Items []AuthorizationRule
}

type ListAuthorizationRulesOperationResponse

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

func (ListAuthorizationRulesOperationResponse) HasMore

func (ListAuthorizationRulesOperationResponse) LoadMore

type ListByNamespaceCompleteResult

type ListByNamespaceCompleteResult struct {
	Items []WcfRelay
}

type ListByNamespaceOperationResponse

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

func (ListByNamespaceOperationResponse) HasMore

func (ListByNamespaceOperationResponse) LoadMore

type ListKeysOperationResponse

type ListKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessKeys
}

type NamespaceId

type NamespaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
}

NamespaceId is a struct representing the Resource ID for a Namespace

func NewNamespaceID

func NewNamespaceID(subscriptionId string, resourceGroupName string, namespaceName string) NamespaceId

NewNamespaceID returns a new NamespaceId struct

func ParseNamespaceID

func ParseNamespaceID(input string) (*NamespaceId, error)

ParseNamespaceID parses 'input' into a NamespaceId

func ParseNamespaceIDInsensitively

func ParseNamespaceIDInsensitively(input string) (*NamespaceId, error)

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

func (NamespaceId) ID

func (id NamespaceId) ID() string

ID returns the formatted Namespace ID

func (NamespaceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Namespace ID

func (NamespaceId) String

func (id NamespaceId) String() string

String returns a human-readable description of this Namespace ID

type RegenerateAccessKeyParameters

type RegenerateAccessKeyParameters struct {
	Key     *string `json:"key,omitempty"`
	KeyType KeyType `json:"keyType"`
}

type RegenerateKeysOperationResponse

type RegenerateKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *AccessKeys
}

type Relaytype

type Relaytype string
const (
	RelaytypeHTTP   Relaytype = "Http"
	RelaytypeNetTcp Relaytype = "NetTcp"
)

type WCFRelaysClient

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

func NewWCFRelaysClientWithBaseURI

func NewWCFRelaysClientWithBaseURI(endpoint string) WCFRelaysClient

func (WCFRelaysClient) CreateOrUpdate

func (c WCFRelaysClient) CreateOrUpdate(ctx context.Context, id WcfRelayId, input WcfRelay) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (WCFRelaysClient) CreateOrUpdateAuthorizationRule

CreateOrUpdateAuthorizationRule ...

func (WCFRelaysClient) Delete

func (c WCFRelaysClient) Delete(ctx context.Context, id WcfRelayId) (result DeleteOperationResponse, err error)

Delete ...

func (WCFRelaysClient) DeleteAuthorizationRule

DeleteAuthorizationRule ...

func (WCFRelaysClient) Get

func (c WCFRelaysClient) Get(ctx context.Context, id WcfRelayId) (result GetOperationResponse, err error)

Get ...

func (WCFRelaysClient) GetAuthorizationRule

GetAuthorizationRule ...

func (WCFRelaysClient) ListAuthorizationRules

func (c WCFRelaysClient) ListAuthorizationRules(ctx context.Context, id WcfRelayId) (resp ListAuthorizationRulesOperationResponse, err error)

ListAuthorizationRules ...

func (WCFRelaysClient) ListAuthorizationRulesComplete

func (c WCFRelaysClient) ListAuthorizationRulesComplete(ctx context.Context, id WcfRelayId) (ListAuthorizationRulesCompleteResult, error)

ListAuthorizationRulesComplete retrieves all of the results into a single object

func (WCFRelaysClient) ListAuthorizationRulesCompleteMatchingPredicate

func (c WCFRelaysClient) ListAuthorizationRulesCompleteMatchingPredicate(ctx context.Context, id WcfRelayId, predicate AuthorizationRuleOperationPredicate) (resp ListAuthorizationRulesCompleteResult, err error)

ListAuthorizationRulesCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (WCFRelaysClient) ListByNamespace

func (c WCFRelaysClient) ListByNamespace(ctx context.Context, id NamespaceId) (resp ListByNamespaceOperationResponse, err error)

ListByNamespace ...

func (WCFRelaysClient) ListByNamespaceComplete

func (c WCFRelaysClient) ListByNamespaceComplete(ctx context.Context, id NamespaceId) (ListByNamespaceCompleteResult, error)

ListByNamespaceComplete retrieves all of the results into a single object

func (WCFRelaysClient) ListByNamespaceCompleteMatchingPredicate

func (c WCFRelaysClient) ListByNamespaceCompleteMatchingPredicate(ctx context.Context, id NamespaceId, predicate WcfRelayOperationPredicate) (resp ListByNamespaceCompleteResult, err error)

ListByNamespaceCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (WCFRelaysClient) ListKeys

ListKeys ...

func (WCFRelaysClient) RegenerateKeys

RegenerateKeys ...

type WcfRelay

type WcfRelay struct {
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *WcfRelayProperties    `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type WcfRelayAuthorizationRuleId

type WcfRelayAuthorizationRuleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	NamespaceName         string
	WcfRelayName          string
	AuthorizationRuleName string
}

WcfRelayAuthorizationRuleId is a struct representing the Resource ID for a Wcf Relay Authorization Rule

func NewWcfRelayAuthorizationRuleID

func NewWcfRelayAuthorizationRuleID(subscriptionId string, resourceGroupName string, namespaceName string, wcfRelayName string, authorizationRuleName string) WcfRelayAuthorizationRuleId

NewWcfRelayAuthorizationRuleID returns a new WcfRelayAuthorizationRuleId struct

func ParseWcfRelayAuthorizationRuleID

func ParseWcfRelayAuthorizationRuleID(input string) (*WcfRelayAuthorizationRuleId, error)

ParseWcfRelayAuthorizationRuleID parses 'input' into a WcfRelayAuthorizationRuleId

func ParseWcfRelayAuthorizationRuleIDInsensitively

func ParseWcfRelayAuthorizationRuleIDInsensitively(input string) (*WcfRelayAuthorizationRuleId, error)

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

func (WcfRelayAuthorizationRuleId) ID

ID returns the formatted Wcf Relay Authorization Rule ID

func (WcfRelayAuthorizationRuleId) Segments

Segments returns a slice of Resource ID Segments which comprise this Wcf Relay Authorization Rule ID

func (WcfRelayAuthorizationRuleId) String

func (id WcfRelayAuthorizationRuleId) String() string

String returns a human-readable description of this Wcf Relay Authorization Rule ID

type WcfRelayId

type WcfRelayId struct {
	SubscriptionId    string
	ResourceGroupName string
	NamespaceName     string
	WcfRelayName      string
}

WcfRelayId is a struct representing the Resource ID for a Wcf Relay

func NewWcfRelayID

func NewWcfRelayID(subscriptionId string, resourceGroupName string, namespaceName string, wcfRelayName string) WcfRelayId

NewWcfRelayID returns a new WcfRelayId struct

func ParseWcfRelayID

func ParseWcfRelayID(input string) (*WcfRelayId, error)

ParseWcfRelayID parses 'input' into a WcfRelayId

func ParseWcfRelayIDInsensitively

func ParseWcfRelayIDInsensitively(input string) (*WcfRelayId, error)

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

func (WcfRelayId) ID

func (id WcfRelayId) ID() string

ID returns the formatted Wcf Relay ID

func (WcfRelayId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Wcf Relay ID

func (WcfRelayId) String

func (id WcfRelayId) String() string

String returns a human-readable description of this Wcf Relay ID

type WcfRelayOperationPredicate

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

func (WcfRelayOperationPredicate) Matches

func (p WcfRelayOperationPredicate) Matches(input WcfRelay) bool

type WcfRelayProperties

type WcfRelayProperties struct {
	CreatedAt                   *string    `json:"createdAt,omitempty"`
	IsDynamic                   *bool      `json:"isDynamic,omitempty"`
	ListenerCount               *int64     `json:"listenerCount,omitempty"`
	RelayType                   *Relaytype `json:"relayType,omitempty"`
	RequiresClientAuthorization *bool      `json:"requiresClientAuthorization,omitempty"`
	RequiresTransportSecurity   *bool      `json:"requiresTransportSecurity,omitempty"`
	UpdatedAt                   *string    `json:"updatedAt,omitempty"`
	UserMetadata                *string    `json:"userMetadata,omitempty"`
}

func (*WcfRelayProperties) GetCreatedAtAsTime

func (o *WcfRelayProperties) GetCreatedAtAsTime() (*time.Time, error)

func (*WcfRelayProperties) GetUpdatedAtAsTime

func (o *WcfRelayProperties) GetUpdatedAtAsTime() (*time.Time, error)

func (*WcfRelayProperties) SetCreatedAtAsTime

func (o *WcfRelayProperties) SetCreatedAtAsTime(input time.Time)

func (*WcfRelayProperties) SetUpdatedAtAsTime

func (o *WcfRelayProperties) SetUpdatedAtAsTime(input time.Time)

Jump to

Keyboard shortcuts

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