integrationserviceenvironmentmanagedapi

package
v0.20231205.1181718 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/logic/2019-05-01/integrationserviceenvironmentmanagedapi Documentation

The integrationserviceenvironmentmanagedapi SDK allows for interaction with the Azure Resource Manager Service logic (API Version 2019-05-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/logic/2019-05-01/integrationserviceenvironmentmanagedapi"

Client Initialization

client := integrationserviceenvironmentmanagedapi.NewIntegrationServiceEnvironmentManagedApiClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: IntegrationServiceEnvironmentManagedApiClient.Delete

ctx := context.TODO()
id := integrationserviceenvironmentmanagedapi.NewManagedApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "integrationServiceEnvironmentValue", "managedApiValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: IntegrationServiceEnvironmentManagedApiClient.Get

ctx := context.TODO()
id := integrationserviceenvironmentmanagedapi.NewManagedApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "integrationServiceEnvironmentValue", "managedApiValue")

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

Example Usage: IntegrationServiceEnvironmentManagedApiClient.Put

ctx := context.TODO()
id := integrationserviceenvironmentmanagedapi.NewManagedApiID("12345678-1234-9876-4563-123456789012", "example-resource-group", "integrationServiceEnvironmentValue", "managedApiValue")

payload := integrationserviceenvironmentmanagedapi.IntegrationServiceEnvironmentManagedApi{
	// ...
}


if err := client.PutThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForApiDeploymentParameterVisibility 

func PossibleValuesForApiDeploymentParameterVisibility() []string

func PossibleValuesForApiTier 

func PossibleValuesForApiTier() []string

func PossibleValuesForApiType 

func PossibleValuesForApiType() []string

func PossibleValuesForWorkflowProvisioningState 

func PossibleValuesForWorkflowProvisioningState() []string

func PossibleValuesForWsdlImportMethod 

func PossibleValuesForWsdlImportMethod() []string

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 ApiDeploymentParameterMetadata 

type ApiDeploymentParameterMetadata struct {
	Description *string                           `json:"description,omitempty"`
	DisplayName *string                           `json:"displayName,omitempty"`
	IsRequired  *bool                             `json:"isRequired,omitempty"`
	Type        *string                           `json:"type,omitempty"`
	Visibility  *ApiDeploymentParameterVisibility `json:"visibility,omitempty"`
}

type ApiDeploymentParameterMetadataSet 

type ApiDeploymentParameterMetadataSet struct {
	PackageContentLink         *ApiDeploymentParameterMetadata `json:"packageContentLink,omitempty"`
	RedisCacheConnectionString *ApiDeploymentParameterMetadata `json:"redisCacheConnectionString,omitempty"`
}

type ApiDeploymentParameterVisibility 

type ApiDeploymentParameterVisibility string
const (
	ApiDeploymentParameterVisibilityDefault      ApiDeploymentParameterVisibility = "Default"
	ApiDeploymentParameterVisibilityInternal     ApiDeploymentParameterVisibility = "Internal"
	ApiDeploymentParameterVisibilityNotSpecified ApiDeploymentParameterVisibility = "NotSpecified"
)

func (*ApiDeploymentParameterVisibility) UnmarshalJSON added in v0.20230712.1163130 

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

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"`
	Tier          *ApiTier `json:"tier,omitempty"`
}

type ApiResourceMetadata 

type ApiResourceMetadata struct {
	ApiType              *ApiType                           `json:"ApiType,omitempty"`
	BrandColor           *string                            `json:"brandColor,omitempty"`
	ConnectionType       *string                            `json:"connectionType,omitempty"`
	DeploymentParameters *ApiDeploymentParameterMetadataSet `json:"deploymentParameters,omitempty"`
	HideKey              *string                            `json:"hideKey,omitempty"`
	ProvisioningState    *WorkflowProvisioningState         `json:"provisioningState,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 ApiTier 

type ApiTier string
const (
	ApiTierEnterprise   ApiTier = "Enterprise"
	ApiTierNotSpecified ApiTier = "NotSpecified"
	ApiTierPremium      ApiTier = "Premium"
	ApiTierStandard     ApiTier = "Standard"
)

func (*ApiTier) UnmarshalJSON added in v0.20230712.1163130 

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

type ApiType 

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

func (*ApiType) UnmarshalJSON added in v0.20230712.1163130 

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

type ContentHash 

type ContentHash struct {
	Algorithm *string `json:"algorithm,omitempty"`
	Value     *string `json:"value,omitempty"`
}
type ContentLink struct {
	ContentHash    *ContentHash `json:"contentHash,omitempty"`
	ContentSize    *int64       `json:"contentSize,omitempty"`
	ContentVersion *string      `json:"contentVersion,omitempty"`
	Metadata       *interface{} `json:"metadata,omitempty"`
	Uri            *string      `json:"uri,omitempty"`
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *IntegrationServiceEnvironmentManagedApi
}

type IntegrationServiceEnvironmentManagedApi 

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

type IntegrationServiceEnvironmentManagedApiClient 

type IntegrationServiceEnvironmentManagedApiClient struct {
	Client *resourcemanager.Client
}

func NewIntegrationServiceEnvironmentManagedApiClientWithBaseURI 

func NewIntegrationServiceEnvironmentManagedApiClientWithBaseURI(sdkApi sdkEnv.Api) (*IntegrationServiceEnvironmentManagedApiClient, error)

func (IntegrationServiceEnvironmentManagedApiClient) Delete 

func (c IntegrationServiceEnvironmentManagedApiClient) Delete(ctx context.Context, id ManagedApiId) (result DeleteOperationResponse, err error)

Delete ...

func (IntegrationServiceEnvironmentManagedApiClient) DeleteThenPoll 

func (c IntegrationServiceEnvironmentManagedApiClient) DeleteThenPoll(ctx context.Context, id ManagedApiId) error

DeleteThenPoll performs Delete then polls until it's completed

func (IntegrationServiceEnvironmentManagedApiClient) Get 

func (c IntegrationServiceEnvironmentManagedApiClient) Get(ctx context.Context, id ManagedApiId) (result GetOperationResponse, err error)

Get ...

func (IntegrationServiceEnvironmentManagedApiClient) Put 

func (c IntegrationServiceEnvironmentManagedApiClient) Put(ctx context.Context, id ManagedApiId, input IntegrationServiceEnvironmentManagedApi) (result PutOperationResponse, err error)

Put ...

func (IntegrationServiceEnvironmentManagedApiClient) PutThenPoll 

func (c IntegrationServiceEnvironmentManagedApiClient) PutThenPoll(ctx context.Context, id ManagedApiId, input IntegrationServiceEnvironmentManagedApi) error

PutThenPoll performs Put then polls until it's completed

type IntegrationServiceEnvironmentManagedApiDeploymentParameters 

type IntegrationServiceEnvironmentManagedApiDeploymentParameters struct {
	ContentLinkDefinition *ContentLink `json:"contentLinkDefinition,omitempty"`
}

type IntegrationServiceEnvironmentManagedApiProperties 

type IntegrationServiceEnvironmentManagedApiProperties struct {
	ApiDefinitionUrl              *string                                                      `json:"apiDefinitionUrl,omitempty"`
	ApiDefinitions                *ApiResourceDefinitions                                      `json:"apiDefinitions,omitempty"`
	BackendService                *ApiResourceBackendService                                   `json:"backendService,omitempty"`
	Capabilities                  *[]string                                                    `json:"capabilities,omitempty"`
	Category                      *ApiTier                                                     `json:"category,omitempty"`
	ConnectionParameters          *map[string]interface{}                                      `json:"connectionParameters,omitempty"`
	DeploymentParameters          *IntegrationServiceEnvironmentManagedApiDeploymentParameters `json:"deploymentParameters,omitempty"`
	GeneralInformation            *ApiResourceGeneralInformation                               `json:"generalInformation,omitempty"`
	IntegrationServiceEnvironment *ResourceReference                                           `json:"integrationServiceEnvironment,omitempty"`
	Metadata                      *ApiResourceMetadata                                         `json:"metadata,omitempty"`
	Name                          *string                                                      `json:"name,omitempty"`
	Policies                      *ApiResourcePolicies                                         `json:"policies,omitempty"`
	ProvisioningState             *WorkflowProvisioningState                                   `json:"provisioningState,omitempty"`
	RuntimeUrls                   *[]string                                                    `json:"runtimeUrls,omitempty"`
}

type ManagedApiId 

type ManagedApiId struct {
	SubscriptionId                    string
	ResourceGroup                     string
	IntegrationServiceEnvironmentName string
	ManagedApiName                    string
}

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

func NewManagedApiID 

func NewManagedApiID(subscriptionId string, resourceGroup string, integrationServiceEnvironmentName string, managedApiName 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) FromParseResult added in v0.20231127.1171502 

func (id *ManagedApiId) FromParseResult(input resourceids.ParseResult) error

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 PutOperationResponse 

type PutOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ResourceReference 

type ResourceReference struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type WorkflowProvisioningState 

type WorkflowProvisioningState string
const (
	WorkflowProvisioningStateAccepted      WorkflowProvisioningState = "Accepted"
	WorkflowProvisioningStateCanceled      WorkflowProvisioningState = "Canceled"
	WorkflowProvisioningStateCompleted     WorkflowProvisioningState = "Completed"
	WorkflowProvisioningStateCreated       WorkflowProvisioningState = "Created"
	WorkflowProvisioningStateCreating      WorkflowProvisioningState = "Creating"
	WorkflowProvisioningStateDeleted       WorkflowProvisioningState = "Deleted"
	WorkflowProvisioningStateDeleting      WorkflowProvisioningState = "Deleting"
	WorkflowProvisioningStateFailed        WorkflowProvisioningState = "Failed"
	WorkflowProvisioningStateInProgress    WorkflowProvisioningState = "InProgress"
	WorkflowProvisioningStateMoving        WorkflowProvisioningState = "Moving"
	WorkflowProvisioningStateNotSpecified  WorkflowProvisioningState = "NotSpecified"
	WorkflowProvisioningStatePending       WorkflowProvisioningState = "Pending"
	WorkflowProvisioningStateReady         WorkflowProvisioningState = "Ready"
	WorkflowProvisioningStateRegistered    WorkflowProvisioningState = "Registered"
	WorkflowProvisioningStateRegistering   WorkflowProvisioningState = "Registering"
	WorkflowProvisioningStateRenewing      WorkflowProvisioningState = "Renewing"
	WorkflowProvisioningStateRunning       WorkflowProvisioningState = "Running"
	WorkflowProvisioningStateSucceeded     WorkflowProvisioningState = "Succeeded"
	WorkflowProvisioningStateUnregistered  WorkflowProvisioningState = "Unregistered"
	WorkflowProvisioningStateUnregistering WorkflowProvisioningState = "Unregistering"
	WorkflowProvisioningStateUpdating      WorkflowProvisioningState = "Updating"
	WorkflowProvisioningStateWaiting       WorkflowProvisioningState = "Waiting"
)

func (*WorkflowProvisioningState) UnmarshalJSON added in v0.20230712.1163130 

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

type WsdlImportMethod 

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

func (*WsdlImportMethod) UnmarshalJSON added in v0.20230712.1163130 

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

type WsdlService 

type WsdlService struct {
	EndpointQualifiedNames *[]string `json:"EndpointQualifiedNames,omitempty"`
	QualifiedName          *string   `json:"qualifiedName,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.