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 ¶
- func ValidateConfigConnectionID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateGatewayID(input interface{}, key string) (warnings []string, errors []error)
- type ApiGatewayConfigConnectionClient
- func (c ApiGatewayConfigConnectionClient) CreateOrUpdate(ctx context.Context, id ConfigConnectionId, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c ApiGatewayConfigConnectionClient) CreateOrUpdateThenPoll(ctx context.Context, id ConfigConnectionId, ...) error
- func (c ApiGatewayConfigConnectionClient) Delete(ctx context.Context, id ConfigConnectionId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
- func (c ApiGatewayConfigConnectionClient) DeleteThenPoll(ctx context.Context, id ConfigConnectionId, options DeleteOperationOptions) error
- func (c ApiGatewayConfigConnectionClient) Get(ctx context.Context, id ConfigConnectionId) (result GetOperationResponse, err error)
- func (c ApiGatewayConfigConnectionClient) ListByGateway(ctx context.Context, id GatewayId) (result ListByGatewayOperationResponse, err error)
- func (c ApiGatewayConfigConnectionClient) ListByGatewayComplete(ctx context.Context, id GatewayId) (ListByGatewayCompleteResult, error)
- func (c ApiGatewayConfigConnectionClient) ListByGatewayCompleteMatchingPredicate(ctx context.Context, id GatewayId, ...) (result ListByGatewayCompleteResult, err error)
- type ApiManagementGatewayConfigConnectionResource
- type ApiManagementGatewayConfigConnectionResourceOperationPredicate
- type ConfigConnectionId
- type CreateOrUpdateOperationResponse
- type DeleteOperationOptions
- type DeleteOperationResponse
- type GatewayConfigConnectionBaseProperties
- type GatewayId
- type GetOperationResponse
- type ListByGatewayCompleteResult
- type ListByGatewayCustomPager
- type ListByGatewayOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateConfigConnectionID ¶
ValidateConfigConnectionID checks that 'input' can be parsed as a Config Connection ID
func ValidateGatewayID ¶
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 ¶
func (c ApiGatewayConfigConnectionClient) CreateOrUpdate(ctx context.Context, id ConfigConnectionId, input ApiManagementGatewayConfigConnectionResource) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (ApiGatewayConfigConnectionClient) CreateOrUpdateThenPoll ¶
func (c ApiGatewayConfigConnectionClient) CreateOrUpdateThenPoll(ctx context.Context, id ConfigConnectionId, input ApiManagementGatewayConfigConnectionResource) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (ApiGatewayConfigConnectionClient) Delete ¶
func (c ApiGatewayConfigConnectionClient) Delete(ctx context.Context, id ConfigConnectionId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)
Delete ...
func (ApiGatewayConfigConnectionClient) DeleteThenPoll ¶
func (c ApiGatewayConfigConnectionClient) DeleteThenPoll(ctx context.Context, id ConfigConnectionId, options DeleteOperationOptions) error
DeleteThenPoll performs Delete then polls until it's completed
func (ApiGatewayConfigConnectionClient) Get ¶
func (c ApiGatewayConfigConnectionClient) Get(ctx context.Context, id ConfigConnectionId) (result GetOperationResponse, err error)
Get ...
func (ApiGatewayConfigConnectionClient) ListByGateway ¶
func (c ApiGatewayConfigConnectionClient) ListByGateway(ctx context.Context, id GatewayId) (result ListByGatewayOperationResponse, err error)
ListByGateway ...
func (ApiGatewayConfigConnectionClient) ListByGatewayComplete ¶
func (c ApiGatewayConfigConnectionClient) ListByGatewayComplete(ctx context.Context, id GatewayId) (ListByGatewayCompleteResult, error)
ListByGatewayComplete retrieves all the results into a single object
func (ApiGatewayConfigConnectionClient) ListByGatewayCompleteMatchingPredicate ¶
func (c ApiGatewayConfigConnectionClient) ListByGatewayCompleteMatchingPredicate(ctx context.Context, id GatewayId, predicate ApiManagementGatewayConfigConnectionResourceOperationPredicate) (result ListByGatewayCompleteResult, err error)
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 }
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 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 ¶
func (o DeleteOperationOptions) ToQuery() *client.QueryParams
type DeleteOperationResponse ¶
type GatewayId ¶
GatewayId is a struct representing the Resource ID for a Gateway
func NewGatewayID ¶
NewGatewayID returns a new GatewayId struct
func ParseGatewayID ¶
ParseGatewayID parses 'input' into a GatewayId
func ParseGatewayIDInsensitively ¶
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) Segments ¶
func (id GatewayId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise 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 ¶
func (*ListByGatewayCustomPager) NextPageLink ¶
func (p *ListByGatewayCustomPager) NextPageLink() *odata.Link
type ListByGatewayOperationResponse ¶
type ListByGatewayOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]ApiManagementGatewayConfigConnectionResource }