managedapis

package
v0.20221129.1151133 Latest Latest
Warning

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

Go to latest
Published: Nov 29, 2022 License: MPL-2.0 Imports: 7 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/web/2016-06-01/managedapis Documentation

The managedapis SDK allows for interaction with the Azure Resource Manager Service web (API Version 2016-06-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/web/2016-06-01/managedapis"

Client Initialization

client := managedapis.NewManagedAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedAPIsClient.ManagedApisGet

ctx := context.TODO()
id := managedapis.NewManagedApiID("12345678-1234-9876-4563-123456789012", "locationValue", "apiValue")

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

Example Usage: ManagedAPIsClient.ManagedApisList

ctx := context.TODO()
id := managedapis.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

read, err := client.ManagedApisList(ctx, id)
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 PossibleValuesForApiType

func PossibleValuesForApiType() []string

func PossibleValuesForConnectionParameterType

func PossibleValuesForConnectionParameterType() []string

func PossibleValuesForWsdlImportMethod

func PossibleValuesForWsdlImportMethod() []string

func ValidateLocationID

func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)

ValidateLocationID checks that 'input' can be parsed as a Location ID

func ValidateManagedApiID

func ValidateManagedApiID(input interface{}, key string) (warnings []string, errors []error)

ValidateManagedApiID checks that 'input' can be parsed as a Managed Api ID

Types

type ApiOAuthSettings

type ApiOAuthSettings struct {
	ClientId         *string                               `json:"clientId,omitempty"`
	ClientSecret     *string                               `json:"clientSecret,omitempty"`
	CustomParameters *map[string]ApiOAuthSettingsParameter `json:"customParameters,omitempty"`
	IdentityProvider *string                               `json:"identityProvider,omitempty"`
	Properties       *interface{}                          `json:"properties,omitempty"`
	RedirectUrl      *string                               `json:"redirectUrl,omitempty"`
	Scopes           *[]string                             `json:"scopes,omitempty"`
}

type ApiOAuthSettingsParameter

type ApiOAuthSettingsParameter struct {
	Options      *interface{} `json:"options,omitempty"`
	UiDefinition *interface{} `json:"uiDefinition,omitempty"`
	Value        *string      `json:"value,omitempty"`
}

type ApiResourceBackendService

type ApiResourceBackendService struct {
	ServiceUrl *string `json:"serviceUrl,omitempty"`
}

type ApiResourceDefinitions

type ApiResourceDefinitions struct {
	ModifiedSwaggerUrl *string `json:"modifiedSwaggerUrl,omitempty"`
	OriginalSwaggerUrl *string `json:"originalSwaggerUrl,omitempty"`
}

type ApiResourceGeneralInformation

type ApiResourceGeneralInformation struct {
	Description   *string `json:"description,omitempty"`
	DisplayName   *string `json:"displayName,omitempty"`
	IconUrl       *string `json:"iconUrl,omitempty"`
	ReleaseTag    *string `json:"releaseTag,omitempty"`
	TermsOfUseUrl *string `json:"termsOfUseUrl,omitempty"`
}

type ApiResourceMetadata

type ApiResourceMetadata struct {
	ApiType          *ApiType           `json:"apiType,omitempty"`
	BrandColor       *string            `json:"brandColor,omitempty"`
	ConnectionType   *string            `json:"connectionType,omitempty"`
	HideKey          *string            `json:"hideKey,omitempty"`
	Source           *string            `json:"source,omitempty"`
	Tags             *map[string]string `json:"tags,omitempty"`
	WsdlImportMethod *WsdlImportMethod  `json:"wsdlImportMethod,omitempty"`
	WsdlService      *WsdlService       `json:"wsdlService,omitempty"`
}

type ApiResourcePolicies

type ApiResourcePolicies struct {
	Content     *string `json:"content,omitempty"`
	ContentLink *string `json:"contentLink,omitempty"`
}

type ApiResourceProperties

type ApiResourceProperties struct {
	ApiDefinitionUrl     *string                         `json:"apiDefinitionUrl,omitempty"`
	ApiDefinitions       *ApiResourceDefinitions         `json:"apiDefinitions,omitempty"`
	BackendService       *ApiResourceBackendService      `json:"backendService,omitempty"`
	Capabilities         *[]string                       `json:"capabilities,omitempty"`
	ConnectionParameters *map[string]ConnectionParameter `json:"connectionParameters,omitempty"`
	GeneralInformation   *ApiResourceGeneralInformation  `json:"generalInformation,omitempty"`
	Metadata             *ApiResourceMetadata            `json:"metadata,omitempty"`
	Name                 *string                         `json:"name,omitempty"`
	Policies             *ApiResourcePolicies            `json:"policies,omitempty"`
	RuntimeUrls          *[]string                       `json:"runtimeUrls,omitempty"`
	Swagger              *interface{}                    `json:"swagger,omitempty"`
}

type ApiType

type ApiType string
const (
	ApiTypeNotSpecified ApiType = "NotSpecified"
	ApiTypeRest         ApiType = "Rest"
	ApiTypeSoap         ApiType = "Soap"
)

type ConnectionParameter

type ConnectionParameter struct {
	OAuthSettings *ApiOAuthSettings        `json:"oAuthSettings,omitempty"`
	Type          *ConnectionParameterType `json:"type,omitempty"`
}

type ConnectionParameterType

type ConnectionParameterType string
const (
	ConnectionParameterTypeArray        ConnectionParameterType = "array"
	ConnectionParameterTypeBool         ConnectionParameterType = "bool"
	ConnectionParameterTypeConnection   ConnectionParameterType = "connection"
	ConnectionParameterTypeInt          ConnectionParameterType = "int"
	ConnectionParameterTypeOauthSetting ConnectionParameterType = "oauthSetting"
	ConnectionParameterTypeObject       ConnectionParameterType = "object"
	ConnectionParameterTypeSecureobject ConnectionParameterType = "secureobject"
	ConnectionParameterTypeSecurestring ConnectionParameterType = "securestring"
	ConnectionParameterTypeString       ConnectionParameterType = "string"
)

type LocationId

type LocationId struct {
	SubscriptionId string
	Location       string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, location string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

func (id LocationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ManagedAPIsClient

type ManagedAPIsClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewManagedAPIsClientWithBaseURI

func NewManagedAPIsClientWithBaseURI(endpoint string) ManagedAPIsClient

func (ManagedAPIsClient) ManagedApisGet

func (c ManagedAPIsClient) ManagedApisGet(ctx context.Context, id ManagedApiId) (result ManagedApisGetOperationResponse, err error)

ManagedApisGet ...

func (ManagedAPIsClient) ManagedApisList

func (c ManagedAPIsClient) ManagedApisList(ctx context.Context, id LocationId) (result ManagedApisListOperationResponse, err error)

ManagedApisList ...

type ManagedApiDefinition

type ManagedApiDefinition struct {
	Etag       *string                `json:"etag,omitempty"`
	Id         *string                `json:"id,omitempty"`
	Location   *string                `json:"location,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *ApiResourceProperties `json:"properties,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ManagedApiDefinitionCollection

type ManagedApiDefinitionCollection struct {
	Value *[]ManagedApiDefinition `json:"value,omitempty"`
}

type ManagedApiId

type ManagedApiId struct {
	SubscriptionId string
	Location       string
	ApiName        string
}

ManagedApiId is a struct representing the Resource ID for a Managed Api

func NewManagedApiID

func NewManagedApiID(subscriptionId string, location string, apiName string) ManagedApiId

NewManagedApiID returns a new ManagedApiId struct

func ParseManagedApiID

func ParseManagedApiID(input string) (*ManagedApiId, error)

ParseManagedApiID parses 'input' into a ManagedApiId

func ParseManagedApiIDInsensitively

func ParseManagedApiIDInsensitively(input string) (*ManagedApiId, error)

ParseManagedApiIDInsensitively parses 'input' case-insensitively into a ManagedApiId note: this method should only be used for API response data and not user input

func (ManagedApiId) ID

func (id ManagedApiId) ID() string

ID returns the formatted Managed Api ID

func (ManagedApiId) Segments

func (id ManagedApiId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Managed Api ID

func (ManagedApiId) String

func (id ManagedApiId) String() string

String returns a human-readable description of this Managed Api ID

type ManagedApisGetOperationResponse

type ManagedApisGetOperationResponse struct {
	HttpResponse *http.Response
	Model        *ManagedApiDefinition
}

type ManagedApisListOperationResponse

type ManagedApisListOperationResponse struct {
	HttpResponse *http.Response
	Model        *ManagedApiDefinitionCollection
}

type WsdlImportMethod

type WsdlImportMethod string
const (
	WsdlImportMethodNotSpecified    WsdlImportMethod = "NotSpecified"
	WsdlImportMethodSoapPassThrough WsdlImportMethod = "SoapPassThrough"
	WsdlImportMethodSoapToRest      WsdlImportMethod = "SoapToRest"
)

type WsdlService

type WsdlService struct {
	EndpointQualifiedNames *[]string `json:"endpointQualifiedNames,omitempty"`
	QualifiedName          string    `json:"qualifiedName"`
}

Jump to

Keyboard shortcuts

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