gatewaylistdebugcredentials

README

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

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

Client Initialization

client := gatewaylistdebugcredentials.NewGatewayListDebugCredentialsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GatewayListDebugCredentialsClient.GatewayListDebugCredentials

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

payload := gatewaylistdebugcredentials.GatewayListDebugCredentialsContract{
	// ...
}


read, err := client.GatewayListDebugCredentials(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 PossibleValuesForGatewayListDebugCredentialsContractPurpose() []string
• func ValidateGatewayID(input interface{}, key string) (warnings []string, errors []error)
• type GatewayDebugCredentialsContract
• 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 GatewayListDebugCredentialsClient
  • func NewGatewayListDebugCredentialsClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayListDebugCredentialsClient, error)
  • func (c GatewayListDebugCredentialsClient) GatewayListDebugCredentials(ctx context.Context, id GatewayId, input GatewayListDebugCredentialsContract) (result GatewayListDebugCredentialsOperationResponse, err error)
• type GatewayListDebugCredentialsContract
• type GatewayListDebugCredentialsContractPurpose
  • func (s *GatewayListDebugCredentialsContractPurpose) UnmarshalJSON(bytes []byte) error
• type GatewayListDebugCredentialsOperationResponse

Functions

func PossibleValuesForGatewayListDebugCredentialsContractPurpose

func PossibleValuesForGatewayListDebugCredentialsContractPurpose() []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 GatewayDebugCredentialsContract

type GatewayDebugCredentialsContract struct {
	Token *string `json:"token,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) 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 GatewayListDebugCredentialsClient

type GatewayListDebugCredentialsClient struct {
	Client *resourcemanager.Client
}

func NewGatewayListDebugCredentialsClientWithBaseURI

func NewGatewayListDebugCredentialsClientWithBaseURI(sdkApi sdkEnv.Api) (*GatewayListDebugCredentialsClient, error)

func (GatewayListDebugCredentialsClient) GatewayListDebugCredentials

func (c GatewayListDebugCredentialsClient) GatewayListDebugCredentials(ctx context.Context, id GatewayId, input GatewayListDebugCredentialsContract) (result GatewayListDebugCredentialsOperationResponse, err error)

GatewayListDebugCredentials ...

type GatewayListDebugCredentialsContract

type GatewayListDebugCredentialsContract struct {
	ApiId                  string                                       `json:"apiId"`
	CredentialsExpireAfter *string                                      `json:"credentialsExpireAfter,omitempty"`
	Purposes               []GatewayListDebugCredentialsContractPurpose `json:"purposes"`
}

type GatewayListDebugCredentialsContractPurpose

type GatewayListDebugCredentialsContractPurpose string

const (
	GatewayListDebugCredentialsContractPurposeTracing GatewayListDebugCredentialsContractPurpose = "tracing"
)

func (*GatewayListDebugCredentialsContractPurpose) UnmarshalJSON

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

type GatewayListDebugCredentialsOperationResponse

type GatewayListDebugCredentialsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GatewayDebugCredentialsContract
}