customapis

package
v0.20230807.1063129 Latest Latest
Warning

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

 Go to latest Published: Aug 7, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

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

Client Initialization

client := customapis.NewCustomAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CustomAPIsClient.CustomApisCreateOrUpdate

ctx := context.TODO()
id := customapis.NewCustomApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "customApiValue")

payload := customapis.CustomApiDefinition{
	// ...
}


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

Example Usage: CustomAPIsClient.CustomApisDelete

ctx := context.TODO()
id := customapis.NewCustomApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "customApiValue")

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

Example Usage: CustomAPIsClient.CustomApisExtractApiDefinitionFromWsdl

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

payload := customapis.WsdlDefinition{
	// ...
}


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

Example Usage: CustomAPIsClient.CustomApisGet

ctx := context.TODO()
id := customapis.NewCustomApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "customApiValue")

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

Example Usage: CustomAPIsClient.CustomApisList

ctx := context.TODO()
id := customapis.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: CustomAPIsClient.CustomApisListByResourceGroup

ctx := context.TODO()
id := customapis.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

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

Example Usage: CustomAPIsClient.CustomApisListWsdlInterfaces

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

payload := customapis.WsdlDefinition{
	// ...
}


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

Example Usage: CustomAPIsClient.CustomApisMove

ctx := context.TODO()
id := customapis.NewCustomApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "customApiValue")

payload := customapis.CustomApiReference{
	// ...
}


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

Example Usage: CustomAPIsClient.CustomApisUpdate

ctx := context.TODO()
id := customapis.NewCustomApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "customApiValue")

payload := customapis.CustomApiDefinition{
	// ...
}


read, err := client.CustomApisUpdate(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 PossibleValuesForApiType 

func PossibleValuesForApiType() []string

func PossibleValuesForConnectionParameterType 

func PossibleValuesForConnectionParameterType() []string

func PossibleValuesForWsdlImportMethod 

func PossibleValuesForWsdlImportMethod() []string

func ValidateCustomApiID 

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

ValidateCustomApiID checks that 'input' can be parsed as a Custom Api ID

func ValidateLocationID 

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

ValidateLocationID checks that 'input' can be parsed as a Location 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 ApiType 

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

func (*ApiType) UnmarshalJSON added in v0.20230725.1205316 

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

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

func (*ConnectionParameterType) UnmarshalJSON added in v0.20230725.1205316 

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

type CustomAPIsClient 

type CustomAPIsClient struct {
	Client *resourcemanager.Client
}

func NewCustomAPIsClientWithBaseURI 

func NewCustomAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*CustomAPIsClient, error)

func (CustomAPIsClient) CustomApisCreateOrUpdate 

func (c CustomAPIsClient) CustomApisCreateOrUpdate(ctx context.Context, id CustomApiId, input CustomApiDefinition) (result CustomApisCreateOrUpdateOperationResponse, err error)

CustomApisCreateOrUpdate ...

func (CustomAPIsClient) CustomApisDelete 

func (c CustomAPIsClient) CustomApisDelete(ctx context.Context, id CustomApiId) (result CustomApisDeleteOperationResponse, err error)

CustomApisDelete ...

func (CustomAPIsClient) CustomApisExtractApiDefinitionFromWsdl 

func (c CustomAPIsClient) CustomApisExtractApiDefinitionFromWsdl(ctx context.Context, id LocationId, input WsdlDefinition) (result CustomApisExtractApiDefinitionFromWsdlOperationResponse, err error)

CustomApisExtractApiDefinitionFromWsdl ...

func (CustomAPIsClient) CustomApisGet 

func (c CustomAPIsClient) CustomApisGet(ctx context.Context, id CustomApiId) (result CustomApisGetOperationResponse, err error)

CustomApisGet ...

func (CustomAPIsClient) CustomApisList 

func (c CustomAPIsClient) CustomApisList(ctx context.Context, id commonids.SubscriptionId, options CustomApisListOperationOptions) (result CustomApisListOperationResponse, err error)

CustomApisList ...

func (CustomAPIsClient) CustomApisListByResourceGroup 

func (c CustomAPIsClient) CustomApisListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options CustomApisListByResourceGroupOperationOptions) (result CustomApisListByResourceGroupOperationResponse, err error)

CustomApisListByResourceGroup ...

func (CustomAPIsClient) CustomApisListWsdlInterfaces 

func (c CustomAPIsClient) CustomApisListWsdlInterfaces(ctx context.Context, id LocationId, input WsdlDefinition) (result CustomApisListWsdlInterfacesOperationResponse, err error)

CustomApisListWsdlInterfaces ...

func (CustomAPIsClient) CustomApisMove 

func (c CustomAPIsClient) CustomApisMove(ctx context.Context, id CustomApiId, input CustomApiReference) (result CustomApisMoveOperationResponse, err error)

CustomApisMove ...

func (CustomAPIsClient) CustomApisUpdate 

func (c CustomAPIsClient) CustomApisUpdate(ctx context.Context, id CustomApiId, input CustomApiDefinition) (result CustomApisUpdateOperationResponse, err error)

CustomApisUpdate ...

type CustomApiDefinition 

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

type CustomApiDefinitionCollection 

type CustomApiDefinitionCollection struct {
	Value *[]CustomApiDefinition `json:"value,omitempty"`
}

type CustomApiId 

type CustomApiId struct {
	SubscriptionId    string
	ResourceGroupName string
	CustomApiName     string
}

CustomApiId is a struct representing the Resource ID for a Custom Api

func NewCustomApiID 

func NewCustomApiID(subscriptionId string, resourceGroupName string, customApiName string) CustomApiId

NewCustomApiID returns a new CustomApiId struct

func ParseCustomApiID 

func ParseCustomApiID(input string) (*CustomApiId, error)

ParseCustomApiID parses 'input' into a CustomApiId

func ParseCustomApiIDInsensitively 

func ParseCustomApiIDInsensitively(input string) (*CustomApiId, error)

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

func (CustomApiId) ID 

func (id CustomApiId) ID() string

ID returns the formatted Custom Api ID

func (CustomApiId) Segments 

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

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

func (CustomApiId) String 

func (id CustomApiId) String() string

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

type CustomApiPropertiesDefinition 

type CustomApiPropertiesDefinition struct {
	ApiDefinitions       *ApiResourceDefinitions         `json:"apiDefinitions,omitempty"`
	ApiType              *ApiType                        `json:"apiType,omitempty"`
	BackendService       *ApiResourceBackendService      `json:"backendService,omitempty"`
	BrandColor           *string                         `json:"brandColor,omitempty"`
	Capabilities         *[]string                       `json:"capabilities,omitempty"`
	ConnectionParameters *map[string]ConnectionParameter `json:"connectionParameters,omitempty"`
	Description          *string                         `json:"description,omitempty"`
	DisplayName          *string                         `json:"displayName,omitempty"`
	IconUri              *string                         `json:"iconUri,omitempty"`
	RuntimeUrls          *[]string                       `json:"runtimeUrls,omitempty"`
	Swagger              *interface{}                    `json:"swagger,omitempty"`
	WsdlDefinition       *WsdlDefinition                 `json:"wsdlDefinition,omitempty"`
}

type CustomApiReference 

type CustomApiReference struct {
	BrandColor  *string      `json:"brandColor,omitempty"`
	Description *string      `json:"description,omitempty"`
	DisplayName *string      `json:"displayName,omitempty"`
	IconUri     *string      `json:"iconUri,omitempty"`
	Id          *string      `json:"id,omitempty"`
	Name        *string      `json:"name,omitempty"`
	Swagger     *interface{} `json:"swagger,omitempty"`
	Type        *string      `json:"type,omitempty"`
}

type CustomApisCreateOrUpdateOperationResponse 

type CustomApisCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CustomApiDefinition
}

type CustomApisDeleteOperationResponse 

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

type CustomApisExtractApiDefinitionFromWsdlOperationResponse 

type CustomApisExtractApiDefinitionFromWsdlOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *interface{}
}

type CustomApisGetOperationResponse 

type CustomApisGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CustomApiDefinition
}

type CustomApisListByResourceGroupOperationOptions 

type CustomApisListByResourceGroupOperationOptions struct {
	Skiptoken *string
	Top       *int64
}

func DefaultCustomApisListByResourceGroupOperationOptions 

func DefaultCustomApisListByResourceGroupOperationOptions() CustomApisListByResourceGroupOperationOptions

func (CustomApisListByResourceGroupOperationOptions) ToHeaders added in v0.20230725.1205316 

func (o CustomApisListByResourceGroupOperationOptions) ToHeaders() *client.Headers

func (CustomApisListByResourceGroupOperationOptions) ToOData added in v0.20230725.1205316 

func (o CustomApisListByResourceGroupOperationOptions) ToOData() *odata.Query

func (CustomApisListByResourceGroupOperationOptions) ToQuery added in v0.20230725.1205316 

func (o CustomApisListByResourceGroupOperationOptions) ToQuery() *client.QueryParams

type CustomApisListByResourceGroupOperationResponse 

type CustomApisListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CustomApiDefinitionCollection
}

type CustomApisListOperationOptions 

type CustomApisListOperationOptions struct {
	Skiptoken *string
	Top       *int64
}

func DefaultCustomApisListOperationOptions 

func DefaultCustomApisListOperationOptions() CustomApisListOperationOptions

func (CustomApisListOperationOptions) ToHeaders added in v0.20230725.1205316 

func (o CustomApisListOperationOptions) ToHeaders() *client.Headers

func (CustomApisListOperationOptions) ToOData added in v0.20230725.1205316 

func (o CustomApisListOperationOptions) ToOData() *odata.Query

func (CustomApisListOperationOptions) ToQuery added in v0.20230725.1205316 

func (o CustomApisListOperationOptions) ToQuery() *client.QueryParams

type CustomApisListOperationResponse 

type CustomApisListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CustomApiDefinitionCollection
}

type CustomApisListWsdlInterfacesOperationResponse 

type CustomApisListWsdlInterfacesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WsdlServiceCollection
}

type CustomApisMoveOperationResponse 

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

type CustomApisUpdateOperationResponse 

type CustomApisUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CustomApiDefinition
}

type LocationId 

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID 

func NewLocationID(subscriptionId string, locationName 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 WsdlDefinition 

type WsdlDefinition struct {
	Content      *string           `json:"content,omitempty"`
	ImportMethod *WsdlImportMethod `json:"importMethod,omitempty"`
	Service      *WsdlService      `json:"service,omitempty"`
	Url          *string           `json:"url,omitempty"`
}

type WsdlImportMethod 

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

func (*WsdlImportMethod) UnmarshalJSON added in v0.20230725.1205316 

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

type WsdlService 

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

type WsdlServiceCollection 

type WsdlServiceCollection struct {
	Value *[]WsdlService `json:"value,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.