gatewayhostnameconfiguration

package
v0.20231127.1171502 Latest Latest
Warning

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

 Go to latest Published: Nov 27, 2023 License: MPL-2.0 Imports: 9 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2021-08-01/gatewayhostnameconfiguration Documentation

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

Client Initialization

client := gatewayhostnameconfiguration.NewGatewayHostnameConfigurationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GatewayHostnameConfigurationClient.CreateOrUpdate

ctx := context.TODO()
id := gatewayhostnameconfiguration.NewHostnameConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "gatewayIdValue", "hcIdValue")

payload := gatewayhostnameconfiguration.GatewayHostnameConfigurationContract{
	// ...
}


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

Example Usage: GatewayHostnameConfigurationClient.Delete

ctx := context.TODO()
id := gatewayhostnameconfiguration.NewHostnameConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "gatewayIdValue", "hcIdValue")

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

Example Usage: GatewayHostnameConfigurationClient.Get

ctx := context.TODO()
id := gatewayhostnameconfiguration.NewHostnameConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "gatewayIdValue", "hcIdValue")

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: GatewayHostnameConfigurationClient.GetEntityTag

ctx := context.TODO()
id := gatewayhostnameconfiguration.NewHostnameConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue", "gatewayIdValue", "hcIdValue")

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

Example Usage: GatewayHostnameConfigurationClient.ListByService

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

// alternatively `client.ListByService(ctx, id, gatewayhostnameconfiguration.DefaultListByServiceOperationOptions())` can be used to do batched pagination
items, err := client.ListByServiceComplete(ctx, id, gatewayhostnameconfiguration.DefaultListByServiceOperationOptions())
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 ValidateGatewayID 

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

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

func ValidateHostnameConfigurationID 

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

ValidateHostnameConfigurationID checks that 'input' can be parsed as a Hostname Configuration ID

Types

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders added in v0.20230801.1071415 

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

func (CreateOrUpdateOperationOptions) ToOData added in v0.20230801.1071415 

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

func (CreateOrUpdateOperationOptions) ToQuery added in v0.20230801.1071415 

func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CreateOrUpdateOperationResponse 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders added in v0.20230801.1071415 

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

func (DeleteOperationOptions) ToOData added in v0.20230801.1071415 

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

func (DeleteOperationOptions) ToQuery added in v0.20230801.1071415 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

type DeleteOperationResponse 

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

type GatewayHostnameConfigurationClient 

type GatewayHostnameConfigurationClient struct {
	Client *resourcemanager.Client
}

func NewGatewayHostnameConfigurationClientWithBaseURI 

func NewGatewayHostnameConfigurationClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayHostnameConfigurationClient, error)

func (GatewayHostnameConfigurationClient) CreateOrUpdate 

func (c GatewayHostnameConfigurationClient) CreateOrUpdate(ctx context.Context, id HostnameConfigurationId, input GatewayHostnameConfigurationContract, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (GatewayHostnameConfigurationClient) Delete 

func (c GatewayHostnameConfigurationClient) Delete(ctx context.Context, id HostnameConfigurationId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (GatewayHostnameConfigurationClient) Get 

func (c GatewayHostnameConfigurationClient) Get(ctx context.Context, id HostnameConfigurationId) (result GetOperationResponse, err error)

Get ...

func (GatewayHostnameConfigurationClient) GetEntityTag 

func (c GatewayHostnameConfigurationClient) GetEntityTag(ctx context.Context, id HostnameConfigurationId) (result GetEntityTagOperationResponse, err error)

GetEntityTag ...

func (GatewayHostnameConfigurationClient) ListByService 

func (c GatewayHostnameConfigurationClient) ListByService(ctx context.Context, id GatewayId, options ListByServiceOperationOptions) (result ListByServiceOperationResponse, err error)

ListByService ...

func (GatewayHostnameConfigurationClient) ListByServiceComplete 

func (c GatewayHostnameConfigurationClient) ListByServiceComplete(ctx context.Context, id GatewayId, options ListByServiceOperationOptions) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (GatewayHostnameConfigurationClient) ListByServiceCompleteMatchingPredicate 

func (c GatewayHostnameConfigurationClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id GatewayId, options ListByServiceOperationOptions, predicate GatewayHostnameConfigurationContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GatewayHostnameConfigurationContract 

type GatewayHostnameConfigurationContract struct {
	Id         *string                                         `json:"id,omitempty"`
	Name       *string                                         `json:"name,omitempty"`
	Properties *GatewayHostnameConfigurationContractProperties `json:"properties,omitempty"`
	Type       *string                                         `json:"type,omitempty"`
}

type GatewayHostnameConfigurationContractOperationPredicate 

type GatewayHostnameConfigurationContractOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (GatewayHostnameConfigurationContractOperationPredicate) Matches 

func (p GatewayHostnameConfigurationContractOperationPredicate) Matches(input GatewayHostnameConfigurationContract) bool

type GatewayHostnameConfigurationContractProperties 

type GatewayHostnameConfigurationContractProperties struct {
	CertificateId              *string `json:"certificateId,omitempty"`
	HTTP2Enabled               *bool   `json:"http2Enabled,omitempty"`
	Hostname                   *string `json:"hostname,omitempty"`
	NegotiateClientCertificate *bool   `json:"negotiateClientCertificate,omitempty"`
	Tls10Enabled               *bool   `json:"tls10Enabled,omitempty"`
	Tls11Enabled               *bool   `json:"tls11Enabled,omitempty"`
}

type GatewayId 

type GatewayId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	GatewayId         string
}

GatewayId is a struct representing the Resource ID for a Gateway

func NewGatewayID 

func NewGatewayID(subscriptionId string, resourceGroupName string, serviceName string, gatewayId 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 added in v0.20231127.1171502 

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 GetEntityTagOperationResponse 

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

type GetOperationResponse 

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

type HostnameConfigurationId 

type HostnameConfigurationId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	GatewayId         string
	HcId              string
}

HostnameConfigurationId is a struct representing the Resource ID for a Hostname Configuration

func NewHostnameConfigurationID 

func NewHostnameConfigurationID(subscriptionId string, resourceGroupName string, serviceName string, gatewayId string, hcId string) HostnameConfigurationId

NewHostnameConfigurationID returns a new HostnameConfigurationId struct

func ParseHostnameConfigurationID 

func ParseHostnameConfigurationID(input string) (*HostnameConfigurationId, error)

ParseHostnameConfigurationID parses 'input' into a HostnameConfigurationId

func ParseHostnameConfigurationIDInsensitively 

func ParseHostnameConfigurationIDInsensitively(input string) (*HostnameConfigurationId, error)

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

func (*HostnameConfigurationId) FromParseResult added in v0.20231127.1171502 

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

func (HostnameConfigurationId) ID 

func (id HostnameConfigurationId) ID() string

ID returns the formatted Hostname Configuration ID

func (HostnameConfigurationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Hostname Configuration ID

func (HostnameConfigurationId) String 

func (id HostnameConfigurationId) String() string

String returns a human-readable description of this Hostname Configuration ID

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	Items []GatewayHostnameConfigurationContract
}

type ListByServiceOperationOptions 

type ListByServiceOperationOptions struct {
	Filter *string
	Skip   *int64
	Top    *int64
}

func DefaultListByServiceOperationOptions 

func DefaultListByServiceOperationOptions() ListByServiceOperationOptions

func (ListByServiceOperationOptions) ToHeaders added in v0.20230801.1071415 

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

func (ListByServiceOperationOptions) ToOData added in v0.20230801.1071415 

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

func (ListByServiceOperationOptions) ToQuery added in v0.20230801.1071415 

func (o ListByServiceOperationOptions) ToQuery() *client.QueryParams

type ListByServiceOperationResponse 

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GatewayHostnameConfigurationContract
}

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.