gatewaygeneratetoken

package
v0.20240819.1075239 Latest Latest
Warning

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

Go to latest
Published: Aug 19, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

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

The gatewaygeneratetoken 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/gatewaygeneratetoken"

Client Initialization

client := gatewaygeneratetoken.NewGatewayGenerateTokenClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GatewayGenerateTokenClient.GatewayGenerateToken

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

payload := gatewaygeneratetoken.GatewayTokenRequestContract{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 GatewayGenerateTokenClient

type GatewayGenerateTokenClient struct {
	Client *resourcemanager.Client
}

func NewGatewayGenerateTokenClientWithBaseURI

func NewGatewayGenerateTokenClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayGenerateTokenClient, error)

func (GatewayGenerateTokenClient) GatewayGenerateToken

GatewayGenerateToken ...

type GatewayGenerateTokenOperationResponse

type GatewayGenerateTokenOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GatewayTokenContract
}

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 GatewayTokenContract

type GatewayTokenContract struct {
	Value *string `json:"value,omitempty"`
}

type GatewayTokenRequestContract

type GatewayTokenRequestContract struct {
	Expiry  string  `json:"expiry"`
	KeyType KeyType `json:"keyType"`
}

func (*GatewayTokenRequestContract) GetExpiryAsTime

func (o *GatewayTokenRequestContract) GetExpiryAsTime() (*time.Time, error)

func (*GatewayTokenRequestContract) SetExpiryAsTime

func (o *GatewayTokenRequestContract) SetExpiryAsTime(input time.Time)

type KeyType

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

func (*KeyType) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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