gatewaylistkeys

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2022-08-01/gatewaylistkeys Documentation

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

Client Initialization

client := gatewaylistkeys.NewGatewayListKeysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GatewayListKeysClient.GatewayListKeys

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

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

Documentation

Index

• func ValidateGatewayID(input interface{}, key string) (warnings []string, errors []error)
• type GatewayId
  • func NewGatewayID(subscriptionId string, resourceGroupName string, serviceName string, ...) GatewayId
  • func ParseGatewayID(input string) (*GatewayId, error)
  • func ParseGatewayIDInsensitively(input string) (*GatewayId, error)
  • func (id *GatewayId) FromParseResult(input resourceids.ParseResult) error
  • func (id GatewayId) ID() string
  • func (id GatewayId) Segments() []resourceids.Segment
  • func (id GatewayId) String() string
• type GatewayKeysContract
• type GatewayListKeysClient
  • func NewGatewayListKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayListKeysClient, error)
  • func (c GatewayListKeysClient) GatewayListKeys(ctx context.Context, id GatewayId) (result GatewayListKeysOperationResponse, err error)
• type GatewayListKeysOperationResponse

Functions

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 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

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 GatewayKeysContract

type GatewayKeysContract struct {
	Primary   *string `json:"primary,omitempty"`
	Secondary *string `json:"secondary,omitempty"`
}

type GatewayListKeysClient

type GatewayListKeysClient struct {
	Client *resourcemanager.Client
}

func NewGatewayListKeysClientWithBaseURI

func NewGatewayListKeysClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayListKeysClient, error)

func (GatewayListKeysClient) GatewayListKeys

func (c GatewayListKeysClient) GatewayListKeys(ctx context.Context, id GatewayId) (result GatewayListKeysOperationResponse, err error)

GatewayListKeys ...

type GatewayListKeysOperationResponse

type GatewayListKeysOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GatewayKeysContract
}