gatewayregeneratekey

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-03-01-preview/gatewayregeneratekey Documentation

The gatewayregeneratekey SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2023-03-01-preview).

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/2023-03-01-preview/gatewayregeneratekey"

Client Initialization

client := gatewayregeneratekey.NewGatewayRegenerateKeyClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GatewayRegenerateKeyClient.GatewayRegenerateKey

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

payload := gatewayregeneratekey.GatewayKeyRegenerationRequestContract{
	// ...
}


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

Documentation

Index

• func PossibleValuesForKeyType() []string
• 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) ID() string
  • func (id GatewayId) Segments() []resourceids.Segment
  • func (id GatewayId) String() string
• type GatewayKeyRegenerationRequestContract
• type GatewayRegenerateKeyClient
  • func NewGatewayRegenerateKeyClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayRegenerateKeyClient, error)
  • func (c GatewayRegenerateKeyClient) GatewayRegenerateKey(ctx context.Context, id GatewayId, input GatewayKeyRegenerationRequestContract) (result GatewayRegenerateKeyOperationResponse, err error)
• type GatewayRegenerateKeyOperationResponse
• type KeyType
  • func (s *KeyType) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForKeyType

func PossibleValuesForKeyType() []string

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

type GatewayKeyRegenerationRequestContract struct {
	KeyType KeyType `json:"keyType"`
}

type GatewayRegenerateKeyClient

type GatewayRegenerateKeyClient struct {
	Client *resourcemanager.Client
}

func NewGatewayRegenerateKeyClientWithBaseURI

func NewGatewayRegenerateKeyClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayRegenerateKeyClient, error)

func (GatewayRegenerateKeyClient) GatewayRegenerateKey

func (c GatewayRegenerateKeyClient) GatewayRegenerateKey(ctx context.Context, id GatewayId, input GatewayKeyRegenerationRequestContract) (result GatewayRegenerateKeyOperationResponse, err error)

GatewayRegenerateKey ...

type GatewayRegenerateKeyOperationResponse

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

type KeyType

type KeyType string

const (
	KeyTypePrimary   KeyType = "primary"
	KeyTypeSecondary KeyType = "secondary"
)

func (*KeyType) UnmarshalJSON

func (s *KeyType) UnmarshalJSON(bytes []byte) error