connectiongateways

package
v0.20240903.1111904 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2016-06-01/connectiongateways Documentation

The connectiongateways SDK allows for interaction with the Azure Resource Manager Service web (API Version 2016-06-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/web/2016-06-01/connectiongateways"

Client Initialization

client := connectiongateways.NewConnectionGatewaysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ConnectionGatewaysClient.ConnectionGatewayInstallationsGet

ctx := context.TODO()
id := connectiongateways.NewConnectionGatewayInstallationID("12345678-1234-9876-4563-123456789012", "locationValue", "gatewayIdValue")

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

Example Usage: ConnectionGatewaysClient.ConnectionGatewayInstallationsList

ctx := context.TODO()
id := connectiongateways.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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

Example Usage: ConnectionGatewaysClient.ConnectionGatewaysCreateOrUpdate

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

payload := connectiongateways.ConnectionGatewayDefinition{
	// ...
}


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

Example Usage: ConnectionGatewaysClient.ConnectionGatewaysDelete

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

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

Example Usage: ConnectionGatewaysClient.ConnectionGatewaysGet

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

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

Example Usage: ConnectionGatewaysClient.ConnectionGatewaysList

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

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

Example Usage: ConnectionGatewaysClient.ConnectionGatewaysListByResourceGroup

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

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

Example Usage: ConnectionGatewaysClient.ConnectionGatewaysUpdate

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

payload := connectiongateways.ConnectionGatewayDefinition{
	// ...
}


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

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

ValidateConnectionGatewayID checks that 'input' can be parsed as a Connection Gateway ID

func ValidateConnectionGatewayInstallationID 

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

ValidateConnectionGatewayInstallationID checks that 'input' can be parsed as a Connection Gateway Installation ID

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type ConnectionGatewayDefinition 

type ConnectionGatewayDefinition struct {
	Etag       *string                                `json:"etag,omitempty"`
	Id         *string                                `json:"id,omitempty"`
	Location   *string                                `json:"location,omitempty"`
	Name       *string                                `json:"name,omitempty"`
	Properties *ConnectionGatewayDefinitionProperties `json:"properties,omitempty"`
	Tags       *map[string]string                     `json:"tags,omitempty"`
	Type       *string                                `json:"type,omitempty"`
}

type ConnectionGatewayDefinitionCollection 

type ConnectionGatewayDefinitionCollection struct {
	Value *[]ConnectionGatewayDefinition `json:"value,omitempty"`
}

type ConnectionGatewayDefinitionProperties 

type ConnectionGatewayDefinitionProperties struct {
	BackendUri                    *string                     `json:"backendUri,omitempty"`
	ConnectionGatewayInstallation *ConnectionGatewayReference `json:"connectionGatewayInstallation,omitempty"`
	ContactInformation            *[]string                   `json:"contactInformation,omitempty"`
	Description                   *string                     `json:"description,omitempty"`
	DisplayName                   *string                     `json:"displayName,omitempty"`
	MachineName                   *string                     `json:"machineName,omitempty"`
	Status                        *interface{}                `json:"status,omitempty"`
}

type ConnectionGatewayId 

type ConnectionGatewayId struct {
	SubscriptionId        string
	ResourceGroupName     string
	ConnectionGatewayName string
}

ConnectionGatewayId is a struct representing the Resource ID for a Connection Gateway

func NewConnectionGatewayID 

func NewConnectionGatewayID(subscriptionId string, resourceGroupName string, connectionGatewayName string) ConnectionGatewayId

NewConnectionGatewayID returns a new ConnectionGatewayId struct

func ParseConnectionGatewayID 

func ParseConnectionGatewayID(input string) (*ConnectionGatewayId, error)

ParseConnectionGatewayID parses 'input' into a ConnectionGatewayId

func ParseConnectionGatewayIDInsensitively 

func ParseConnectionGatewayIDInsensitively(input string) (*ConnectionGatewayId, error)

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

func (*ConnectionGatewayId) FromParseResult 

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

func (ConnectionGatewayId) ID 

func (id ConnectionGatewayId) ID() string

ID returns the formatted Connection Gateway ID

func (ConnectionGatewayId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Connection Gateway ID

func (ConnectionGatewayId) String 

func (id ConnectionGatewayId) String() string

String returns a human-readable description of this Connection Gateway ID

type ConnectionGatewayInstallationDefinition 

type ConnectionGatewayInstallationDefinition struct {
	Etag       *string                                            `json:"etag,omitempty"`
	Id         *string                                            `json:"id,omitempty"`
	Location   *string                                            `json:"location,omitempty"`
	Name       *string                                            `json:"name,omitempty"`
	Properties *ConnectionGatewayInstallationDefinitionProperties `json:"properties,omitempty"`
	Tags       *map[string]string                                 `json:"tags,omitempty"`
	Type       *string                                            `json:"type,omitempty"`
}

type ConnectionGatewayInstallationDefinitionCollection 

type ConnectionGatewayInstallationDefinitionCollection struct {
	Value *[]ConnectionGatewayInstallationDefinition `json:"value,omitempty"`
}

type ConnectionGatewayInstallationDefinitionProperties 

type ConnectionGatewayInstallationDefinitionProperties struct {
	BackendUri         *string                     `json:"backendUri,omitempty"`
	ConnectionGateway  *ConnectionGatewayReference `json:"connectionGateway,omitempty"`
	ContactInformation *[]string                   `json:"contactInformation,omitempty"`
	Description        *string                     `json:"description,omitempty"`
	DisplayName        *string                     `json:"displayName,omitempty"`
	MachineName        *string                     `json:"machineName,omitempty"`
	Status             *interface{}                `json:"status,omitempty"`
}

type ConnectionGatewayInstallationId 

type ConnectionGatewayInstallationId struct {
	SubscriptionId string
	LocationName   string
	GatewayId      string
}

ConnectionGatewayInstallationId is a struct representing the Resource ID for a Connection Gateway Installation

func NewConnectionGatewayInstallationID 

func NewConnectionGatewayInstallationID(subscriptionId string, locationName string, gatewayId string) ConnectionGatewayInstallationId

NewConnectionGatewayInstallationID returns a new ConnectionGatewayInstallationId struct

func ParseConnectionGatewayInstallationID 

func ParseConnectionGatewayInstallationID(input string) (*ConnectionGatewayInstallationId, error)

ParseConnectionGatewayInstallationID parses 'input' into a ConnectionGatewayInstallationId

func ParseConnectionGatewayInstallationIDInsensitively 

func ParseConnectionGatewayInstallationIDInsensitively(input string) (*ConnectionGatewayInstallationId, error)

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

func (*ConnectionGatewayInstallationId) FromParseResult 

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

func (ConnectionGatewayInstallationId) ID 

func (id ConnectionGatewayInstallationId) ID() string

ID returns the formatted Connection Gateway Installation ID

func (ConnectionGatewayInstallationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Connection Gateway Installation ID

func (ConnectionGatewayInstallationId) String 

func (id ConnectionGatewayInstallationId) String() string

String returns a human-readable description of this Connection Gateway Installation ID

type ConnectionGatewayInstallationsGetOperationResponse 

type ConnectionGatewayInstallationsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionGatewayInstallationDefinition
}

type ConnectionGatewayInstallationsListOperationResponse 

type ConnectionGatewayInstallationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionGatewayInstallationDefinitionCollection
}

type ConnectionGatewayReference 

type ConnectionGatewayReference struct {
	Id       *string `json:"id,omitempty"`
	Location *string `json:"location,omitempty"`
	Name     *string `json:"name,omitempty"`
	Type     *string `json:"type,omitempty"`
}

type ConnectionGatewaysClient 

type ConnectionGatewaysClient struct {
	Client *resourcemanager.Client
}

func NewConnectionGatewaysClientWithBaseURI 

func NewConnectionGatewaysClientWithBaseURI(sdkApi sdkEnv.Api) (*ConnectionGatewaysClient, error)

func (ConnectionGatewaysClient) ConnectionGatewayInstallationsGet 

func (c ConnectionGatewaysClient) ConnectionGatewayInstallationsGet(ctx context.Context, id ConnectionGatewayInstallationId) (result ConnectionGatewayInstallationsGetOperationResponse, err error)

ConnectionGatewayInstallationsGet ...

func (ConnectionGatewaysClient) ConnectionGatewayInstallationsList 

func (c ConnectionGatewaysClient) ConnectionGatewayInstallationsList(ctx context.Context, id LocationId) (result ConnectionGatewayInstallationsListOperationResponse, err error)

ConnectionGatewayInstallationsList ...

func (ConnectionGatewaysClient) ConnectionGatewaysCreateOrUpdate 

func (c ConnectionGatewaysClient) ConnectionGatewaysCreateOrUpdate(ctx context.Context, id ConnectionGatewayId, input ConnectionGatewayDefinition) (result ConnectionGatewaysCreateOrUpdateOperationResponse, err error)

ConnectionGatewaysCreateOrUpdate ...

func (ConnectionGatewaysClient) ConnectionGatewaysDelete 

func (c ConnectionGatewaysClient) ConnectionGatewaysDelete(ctx context.Context, id ConnectionGatewayId) (result ConnectionGatewaysDeleteOperationResponse, err error)

ConnectionGatewaysDelete ...

func (ConnectionGatewaysClient) ConnectionGatewaysGet 

func (c ConnectionGatewaysClient) ConnectionGatewaysGet(ctx context.Context, id ConnectionGatewayId) (result ConnectionGatewaysGetOperationResponse, err error)

ConnectionGatewaysGet ...

func (ConnectionGatewaysClient) ConnectionGatewaysList 

func (c ConnectionGatewaysClient) ConnectionGatewaysList(ctx context.Context, id commonids.SubscriptionId) (result ConnectionGatewaysListOperationResponse, err error)

ConnectionGatewaysList ...

func (ConnectionGatewaysClient) ConnectionGatewaysListByResourceGroup 

func (c ConnectionGatewaysClient) ConnectionGatewaysListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ConnectionGatewaysListByResourceGroupOperationResponse, err error)

ConnectionGatewaysListByResourceGroup ...

func (ConnectionGatewaysClient) ConnectionGatewaysUpdate 

func (c ConnectionGatewaysClient) ConnectionGatewaysUpdate(ctx context.Context, id ConnectionGatewayId, input ConnectionGatewayDefinition) (result ConnectionGatewaysUpdateOperationResponse, err error)

ConnectionGatewaysUpdate ...

type ConnectionGatewaysCreateOrUpdateOperationResponse 

type ConnectionGatewaysCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionGatewayDefinition
}

type ConnectionGatewaysDeleteOperationResponse 

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

type ConnectionGatewaysGetOperationResponse 

type ConnectionGatewaysGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionGatewayDefinition
}

type ConnectionGatewaysListByResourceGroupOperationResponse 

type ConnectionGatewaysListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionGatewayDefinitionCollection
}

type ConnectionGatewaysListOperationResponse 

type ConnectionGatewaysListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionGatewayDefinitionCollection
}

type ConnectionGatewaysUpdateOperationResponse 

type ConnectionGatewaysUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ConnectionGatewayDefinition
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID 

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively 

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult 

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

func (LocationId) ID 

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments 

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

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

func (LocationId) String 

func (id LocationId) String() string

String returns a human-readable description of this Location ID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.