apigatewayconfigconnection

package
v0.20241205.1102105 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/apigatewayconfigconnection Documentation

The apigatewayconfigconnection SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2024-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-sdk/resource-manager/apimanagement/2024-05-01/apigatewayconfigconnection"

Client Initialization

client := apigatewayconfigconnection.NewApiGatewayConfigConnectionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiGatewayConfigConnectionClient.CreateOrUpdate

ctx := context.TODO()
id := apigatewayconfigconnection.NewConfigConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "gatewayName", "configConnectionName")

payload := apigatewayconfigconnection.ApiManagementGatewayConfigConnectionResource{
	// ...
}


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

Example Usage: ApiGatewayConfigConnectionClient.Delete

ctx := context.TODO()
id := apigatewayconfigconnection.NewConfigConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "gatewayName", "configConnectionName")

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

Example Usage: ApiGatewayConfigConnectionClient.Get

ctx := context.TODO()
id := apigatewayconfigconnection.NewConfigConnectionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "gatewayName", "configConnectionName")

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: ApiGatewayConfigConnectionClient.ListByGateway

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateConfigConnectionID

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

ValidateConfigConnectionID checks that 'input' can be parsed as a Config Connection ID

func ValidateGatewayID

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

ValidateGatewayID checks that 'input' can be parsed as a Gateway ID

Types

type ApiGatewayConfigConnectionClient

type ApiGatewayConfigConnectionClient struct {
	Client *resourcemanager.Client
}

func NewApiGatewayConfigConnectionClientWithBaseURI

func NewApiGatewayConfigConnectionClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiGatewayConfigConnectionClient, error)

func (ApiGatewayConfigConnectionClient) CreateOrUpdate

CreateOrUpdate ...

func (ApiGatewayConfigConnectionClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ApiGatewayConfigConnectionClient) Delete

Delete ...

func (ApiGatewayConfigConnectionClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ApiGatewayConfigConnectionClient) Get

Get ...

func (ApiGatewayConfigConnectionClient) ListByGateway

ListByGateway ...

func (ApiGatewayConfigConnectionClient) ListByGatewayComplete

ListByGatewayComplete retrieves all the results into a single object

func (ApiGatewayConfigConnectionClient) ListByGatewayCompleteMatchingPredicate

ListByGatewayCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ApiManagementGatewayConfigConnectionResource

type ApiManagementGatewayConfigConnectionResource struct {
	Etag       *string                               `json:"etag,omitempty"`
	Id         *string                               `json:"id,omitempty"`
	Name       *string                               `json:"name,omitempty"`
	Properties GatewayConfigConnectionBaseProperties `json:"properties"`
	Type       *string                               `json:"type,omitempty"`
}

type ApiManagementGatewayConfigConnectionResourceOperationPredicate

type ApiManagementGatewayConfigConnectionResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (ApiManagementGatewayConfigConnectionResourceOperationPredicate) Matches

type ConfigConnectionId

type ConfigConnectionId struct {
	SubscriptionId       string
	ResourceGroupName    string
	GatewayName          string
	ConfigConnectionName string
}

ConfigConnectionId is a struct representing the Resource ID for a Config Connection

func NewConfigConnectionID

func NewConfigConnectionID(subscriptionId string, resourceGroupName string, gatewayName string, configConnectionName string) ConfigConnectionId

NewConfigConnectionID returns a new ConfigConnectionId struct

func ParseConfigConnectionID

func ParseConfigConnectionID(input string) (*ConfigConnectionId, error)

ParseConfigConnectionID parses 'input' into a ConfigConnectionId

func ParseConfigConnectionIDInsensitively

func ParseConfigConnectionIDInsensitively(input string) (*ConfigConnectionId, error)

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

func (*ConfigConnectionId) FromParseResult

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

func (ConfigConnectionId) ID

func (id ConfigConnectionId) ID() string

ID returns the formatted Config Connection ID

func (ConfigConnectionId) Segments

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

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

func (ConfigConnectionId) String

func (id ConfigConnectionId) String() string

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

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiManagementGatewayConfigConnectionResource
}

type DeleteOperationOptions

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders

func (o DeleteOperationOptions) ToHeaders() *client.Headers

func (DeleteOperationOptions) ToOData

func (o DeleteOperationOptions) ToOData() *odata.Query

func (DeleteOperationOptions) ToQuery

type DeleteOperationResponse

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

type GatewayConfigConnectionBaseProperties

type GatewayConfigConnectionBaseProperties struct {
	DefaultHostname   *string   `json:"defaultHostname,omitempty"`
	Hostnames         *[]string `json:"hostnames,omitempty"`
	ProvisioningState *string   `json:"provisioningState,omitempty"`
	SourceId          *string   `json:"sourceId,omitempty"`
}

type GatewayId

type GatewayId struct {
	SubscriptionId    string
	ResourceGroupName string
	GatewayName       string
}

GatewayId is a struct representing the Resource ID for a Gateway

func NewGatewayID

func NewGatewayID(subscriptionId string, resourceGroupName string, gatewayName string) GatewayId

NewGatewayID returns a new GatewayId struct

func ParseGatewayID

func ParseGatewayID(input string) (*GatewayId, error)

ParseGatewayID parses 'input' into a GatewayId

func ParseGatewayIDInsensitively

func ParseGatewayIDInsensitively(input string) (*GatewayId, error)

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

func (*GatewayId) FromParseResult

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

func (GatewayId) ID

func (id GatewayId) ID() string

ID returns the formatted Gateway ID

func (GatewayId) Segments

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

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

func (GatewayId) String

func (id GatewayId) String() string

String returns a human-readable description of this Gateway ID

type GetOperationResponse

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

type ListByGatewayCompleteResult

type ListByGatewayCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiManagementGatewayConfigConnectionResource
}

type ListByGatewayCustomPager

type ListByGatewayCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByGatewayCustomPager) NextPageLink() *odata.Link

type ListByGatewayOperationResponse

type ListByGatewayOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiManagementGatewayConfigConnectionResource
}

Jump to

Keyboard shortcuts

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