serverlessruntimes

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/informatica/2024-05-08/serverlessruntimes Documentation

The serverlessruntimes SDK allows for interaction with Azure Resource Manager informatica (API Version 2024-05-08).

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/informatica/2024-05-08/serverlessruntimes"

Client Initialization

client := serverlessruntimes.NewServerlessRuntimesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerlessRuntimesClient.CheckDependencies

ctx := context.TODO()
id := serverlessruntimes.NewServerlessRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName", "serverlessRuntimeName")

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

Example Usage: ServerlessRuntimesClient.CreateOrUpdate

ctx := context.TODO()
id := serverlessruntimes.NewServerlessRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName", "serverlessRuntimeName")

payload := serverlessruntimes.InformaticaServerlessRuntimeResource{
	// ...
}


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

Example Usage: ServerlessRuntimesClient.Delete

ctx := context.TODO()
id := serverlessruntimes.NewServerlessRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName", "serverlessRuntimeName")

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

Example Usage: ServerlessRuntimesClient.Get

ctx := context.TODO()
id := serverlessruntimes.NewServerlessRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName", "serverlessRuntimeName")

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: ServerlessRuntimesClient.ListByInformaticaOrganizationResource

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

// alternatively `client.ListByInformaticaOrganizationResource(ctx, id)` can be used to do batched pagination
items, err := client.ListByInformaticaOrganizationResourceComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ServerlessRuntimesClient.ServerlessResourceById

ctx := context.TODO()
id := serverlessruntimes.NewServerlessRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName", "serverlessRuntimeName")

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

Example Usage: ServerlessRuntimesClient.StartFailedServerlessRuntime

ctx := context.TODO()
id := serverlessruntimes.NewServerlessRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName", "serverlessRuntimeName")

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

Example Usage: ServerlessRuntimesClient.Update

ctx := context.TODO()
id := serverlessruntimes.NewServerlessRuntimeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "organizationName", "serverlessRuntimeName")

payload := serverlessruntimes.InformaticaServerlessRuntimeResourceUpdate{
	// ...
}


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

func PossibleValuesForApplicationType() []string

func PossibleValuesForPlatformType 

func PossibleValuesForPlatformType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateOrganizationID 

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

ValidateOrganizationID checks that 'input' can be parsed as a Organization ID

func ValidateServerlessRuntimeID 

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

ValidateServerlessRuntimeID checks that 'input' can be parsed as a Serverless Runtime ID

Types

type AdvancedCustomProperties 

type AdvancedCustomProperties struct {
	Key   *string `json:"key,omitempty"`
	Value *string `json:"value,omitempty"`
}

type ApplicationConfigs 

type ApplicationConfigs struct {
	Customized   string `json:"customized"`
	DefaultValue string `json:"defaultValue"`
	Name         string `json:"name"`
	Platform     string `json:"platform"`
	Type         string `json:"type"`
	Value        string `json:"value"`
}

type ApplicationType 

type ApplicationType string
const (
	ApplicationTypeCDI  ApplicationType = "CDI"
	ApplicationTypeCDIE ApplicationType = "CDIE"
)

func (*ApplicationType) UnmarshalJSON 

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

type CdiConfigProps 

type CdiConfigProps struct {
	ApplicationConfigs []ApplicationConfigs `json:"applicationConfigs"`
	EngineName         string               `json:"engineName"`
	EngineVersion      string               `json:"engineVersion"`
}

type CheckDependenciesOperationResponse 

type CheckDependenciesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckDependenciesResponse
}

type CheckDependenciesResponse 

type CheckDependenciesResponse struct {
	Count      int64                         `json:"count"`
	Id         string                        `json:"id"`
	References []ServerlessRuntimeDependency `json:"references"`
}

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InformaticaServerlessRuntimeResource
}

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        *InformaticaServerlessRuntimeResource
}

type InformaticaServerlessRuntimeProperties 

type InformaticaServerlessRuntimeProperties struct {
	AdvancedCustomProperties               *[]AdvancedCustomProperties             `json:"advancedCustomProperties,omitempty"`
	ApplicationType                        *ApplicationType                        `json:"applicationType,omitempty"`
	ComputeUnits                           *string                                 `json:"computeUnits,omitempty"`
	Description                            *string                                 `json:"description,omitempty"`
	ExecutionTimeout                       *string                                 `json:"executionTimeout,omitempty"`
	Platform                               *PlatformType                           `json:"platform,omitempty"`
	ProvisioningState                      *ProvisioningState                      `json:"provisioningState,omitempty"`
	ServerlessAccountLocation              string                                  `json:"serverlessAccountLocation"`
	ServerlessRuntimeConfig                *ServerlessRuntimeConfigProperties      `json:"serverlessRuntimeConfig,omitempty"`
	ServerlessRuntimeNetworkProfile        *ServerlessRuntimeNetworkProfile        `json:"serverlessRuntimeNetworkProfile,omitempty"`
	ServerlessRuntimeTags                  *[]ServerlessRuntimeTag                 `json:"serverlessRuntimeTags,omitempty"`
	ServerlessRuntimeUserContextProperties *ServerlessRuntimeUserContextProperties `json:"serverlessRuntimeUserContextProperties,omitempty"`
	SupplementaryFileLocation              *string                                 `json:"supplementaryFileLocation,omitempty"`
}

type InformaticaServerlessRuntimeResource 

type InformaticaServerlessRuntimeResource struct {
	Id         *string                                 `json:"id,omitempty"`
	Name       *string                                 `json:"name,omitempty"`
	Properties *InformaticaServerlessRuntimeProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                  `json:"systemData,omitempty"`
	Type       *string                                 `json:"type,omitempty"`
}

type InformaticaServerlessRuntimeResourceOperationPredicate 

type InformaticaServerlessRuntimeResourceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (InformaticaServerlessRuntimeResourceOperationPredicate) Matches 

func (p InformaticaServerlessRuntimeResourceOperationPredicate) Matches(input InformaticaServerlessRuntimeResource) bool

type InformaticaServerlessRuntimeResourceUpdate 

type InformaticaServerlessRuntimeResourceUpdate struct {
	Properties *ServerlessRuntimePropertiesCustomUpdate `json:"properties,omitempty"`
}

type ListByInformaticaOrganizationResourceCompleteResult 

type ListByInformaticaOrganizationResourceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []InformaticaServerlessRuntimeResource
}

type ListByInformaticaOrganizationResourceCustomPager 

type ListByInformaticaOrganizationResourceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByInformaticaOrganizationResourceCustomPager) NextPageLink() *odata.Link

type ListByInformaticaOrganizationResourceOperationResponse 

type ListByInformaticaOrganizationResourceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]InformaticaServerlessRuntimeResource
}

type NetworkInterfaceConfiguration 

type NetworkInterfaceConfiguration struct {
	SubnetId         string  `json:"subnetId"`
	VnetId           string  `json:"vnetId"`
	VnetResourceGuid *string `json:"vnetResourceGuid,omitempty"`
}

type NetworkInterfaceConfigurationUpdate 

type NetworkInterfaceConfigurationUpdate struct {
	SubnetId         *string `json:"subnetId,omitempty"`
	VnetId           *string `json:"vnetId,omitempty"`
	VnetResourceGuid *string `json:"vnetResourceGuid,omitempty"`
}

type OrganizationId 

type OrganizationId struct {
	SubscriptionId    string
	ResourceGroupName string
	OrganizationName  string
}

OrganizationId is a struct representing the Resource ID for a Organization

func NewOrganizationID 

func NewOrganizationID(subscriptionId string, resourceGroupName string, organizationName string) OrganizationId

NewOrganizationID returns a new OrganizationId struct

func ParseOrganizationID 

func ParseOrganizationID(input string) (*OrganizationId, error)

ParseOrganizationID parses 'input' into a OrganizationId

func ParseOrganizationIDInsensitively 

func ParseOrganizationIDInsensitively(input string) (*OrganizationId, error)

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

func (*OrganizationId) FromParseResult 

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

func (OrganizationId) ID 

func (id OrganizationId) ID() string

ID returns the formatted Organization ID

func (OrganizationId) Segments 

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

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

func (OrganizationId) String 

func (id OrganizationId) String() string

String returns a human-readable description of this Organization ID

type PlatformType 

type PlatformType string
const (
	PlatformTypeAZURE PlatformType = "AZURE"
)

func (*PlatformType) UnmarshalJSON 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type ServerlessResourceByIdOperationResponse 

type ServerlessResourceByIdOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InformaticaServerlessRuntimeResource
}

type ServerlessRuntimeConfigProperties 

type ServerlessRuntimeConfigProperties struct {
	CdiConfigProps  *[]CdiConfigProps `json:"cdiConfigProps,omitempty"`
	CdieConfigProps *[]CdiConfigProps `json:"cdieConfigProps,omitempty"`
}

type ServerlessRuntimeConfigPropertiesUpdate 

type ServerlessRuntimeConfigPropertiesUpdate struct {
	CdiConfigProps  *[]CdiConfigProps `json:"cdiConfigProps,omitempty"`
	CdieConfigProps *[]CdiConfigProps `json:"cdieConfigProps,omitempty"`
}

type ServerlessRuntimeDependency 

type ServerlessRuntimeDependency struct {
	AppContextId    string `json:"appContextId"`
	Description     string `json:"description"`
	DocumentType    string `json:"documentType"`
	Id              string `json:"id"`
	LastUpdatedTime string `json:"lastUpdatedTime"`
	Path            string `json:"path"`
}

type ServerlessRuntimeId 

type ServerlessRuntimeId struct {
	SubscriptionId        string
	ResourceGroupName     string
	OrganizationName      string
	ServerlessRuntimeName string
}

ServerlessRuntimeId is a struct representing the Resource ID for a Serverless Runtime

func NewServerlessRuntimeID 

func NewServerlessRuntimeID(subscriptionId string, resourceGroupName string, organizationName string, serverlessRuntimeName string) ServerlessRuntimeId

NewServerlessRuntimeID returns a new ServerlessRuntimeId struct

func ParseServerlessRuntimeID 

func ParseServerlessRuntimeID(input string) (*ServerlessRuntimeId, error)

ParseServerlessRuntimeID parses 'input' into a ServerlessRuntimeId

func ParseServerlessRuntimeIDInsensitively 

func ParseServerlessRuntimeIDInsensitively(input string) (*ServerlessRuntimeId, error)

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

func (*ServerlessRuntimeId) FromParseResult 

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

func (ServerlessRuntimeId) ID 

func (id ServerlessRuntimeId) ID() string

ID returns the formatted Serverless Runtime ID

func (ServerlessRuntimeId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Serverless Runtime ID

func (ServerlessRuntimeId) String 

func (id ServerlessRuntimeId) String() string

String returns a human-readable description of this Serverless Runtime ID

type ServerlessRuntimeNetworkProfile 

type ServerlessRuntimeNetworkProfile struct {
	NetworkInterfaceConfiguration NetworkInterfaceConfiguration `json:"networkInterfaceConfiguration"`
}

type ServerlessRuntimeNetworkProfileUpdate 

type ServerlessRuntimeNetworkProfileUpdate struct {
	NetworkInterfaceConfiguration *NetworkInterfaceConfigurationUpdate `json:"networkInterfaceConfiguration,omitempty"`
}

type ServerlessRuntimePropertiesCustomUpdate 

type ServerlessRuntimePropertiesCustomUpdate struct {
	AdvancedCustomProperties               *[]AdvancedCustomProperties                   `json:"advancedCustomProperties,omitempty"`
	ApplicationType                        *ApplicationType                              `json:"applicationType,omitempty"`
	ComputeUnits                           *string                                       `json:"computeUnits,omitempty"`
	Description                            *string                                       `json:"description,omitempty"`
	ExecutionTimeout                       *string                                       `json:"executionTimeout,omitempty"`
	Platform                               *PlatformType                                 `json:"platform,omitempty"`
	ServerlessAccountLocation              *string                                       `json:"serverlessAccountLocation,omitempty"`
	ServerlessRuntimeConfig                *ServerlessRuntimeConfigPropertiesUpdate      `json:"serverlessRuntimeConfig,omitempty"`
	ServerlessRuntimeNetworkProfile        *ServerlessRuntimeNetworkProfileUpdate        `json:"serverlessRuntimeNetworkProfile,omitempty"`
	ServerlessRuntimeTags                  *[]ServerlessRuntimeTag                       `json:"serverlessRuntimeTags,omitempty"`
	ServerlessRuntimeUserContextProperties *ServerlessRuntimeUserContextPropertiesUpdate `json:"serverlessRuntimeUserContextProperties,omitempty"`
	SupplementaryFileLocation              *string                                       `json:"supplementaryFileLocation,omitempty"`
}

type ServerlessRuntimeTag 

type ServerlessRuntimeTag struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type ServerlessRuntimeUserContextProperties 

type ServerlessRuntimeUserContextProperties struct {
	UserContextToken string `json:"userContextToken"`
}

type ServerlessRuntimeUserContextPropertiesUpdate 

type ServerlessRuntimeUserContextPropertiesUpdate struct {
	UserContextToken *string `json:"userContextToken,omitempty"`
}

type ServerlessRuntimesClient 

type ServerlessRuntimesClient struct {
	Client *resourcemanager.Client
}

func NewServerlessRuntimesClientWithBaseURI 

func NewServerlessRuntimesClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerlessRuntimesClient, error)

func (ServerlessRuntimesClient) CheckDependencies 

func (c ServerlessRuntimesClient) CheckDependencies(ctx context.Context, id ServerlessRuntimeId) (result CheckDependenciesOperationResponse, err error)

CheckDependencies ...

func (ServerlessRuntimesClient) CreateOrUpdate 

func (c ServerlessRuntimesClient) CreateOrUpdate(ctx context.Context, id ServerlessRuntimeId, input InformaticaServerlessRuntimeResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServerlessRuntimesClient) CreateOrUpdateThenPoll 

func (c ServerlessRuntimesClient) CreateOrUpdateThenPoll(ctx context.Context, id ServerlessRuntimeId, input InformaticaServerlessRuntimeResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServerlessRuntimesClient) Delete 

func (c ServerlessRuntimesClient) Delete(ctx context.Context, id ServerlessRuntimeId) (result DeleteOperationResponse, err error)

Delete ...

func (ServerlessRuntimesClient) DeleteThenPoll 

func (c ServerlessRuntimesClient) DeleteThenPoll(ctx context.Context, id ServerlessRuntimeId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ServerlessRuntimesClient) Get 

func (c ServerlessRuntimesClient) Get(ctx context.Context, id ServerlessRuntimeId) (result GetOperationResponse, err error)

Get ...

func (ServerlessRuntimesClient) ListByInformaticaOrganizationResource 

func (c ServerlessRuntimesClient) ListByInformaticaOrganizationResource(ctx context.Context, id OrganizationId) (result ListByInformaticaOrganizationResourceOperationResponse, err error)

ListByInformaticaOrganizationResource ...

func (ServerlessRuntimesClient) ListByInformaticaOrganizationResourceComplete 

func (c ServerlessRuntimesClient) ListByInformaticaOrganizationResourceComplete(ctx context.Context, id OrganizationId) (ListByInformaticaOrganizationResourceCompleteResult, error)

ListByInformaticaOrganizationResourceComplete retrieves all the results into a single object

func (ServerlessRuntimesClient) ListByInformaticaOrganizationResourceCompleteMatchingPredicate 

func (c ServerlessRuntimesClient) ListByInformaticaOrganizationResourceCompleteMatchingPredicate(ctx context.Context, id OrganizationId, predicate InformaticaServerlessRuntimeResourceOperationPredicate) (result ListByInformaticaOrganizationResourceCompleteResult, err error)

ListByInformaticaOrganizationResourceCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServerlessRuntimesClient) ServerlessResourceById 

func (c ServerlessRuntimesClient) ServerlessResourceById(ctx context.Context, id ServerlessRuntimeId) (result ServerlessResourceByIdOperationResponse, err error)

ServerlessResourceById ...

func (ServerlessRuntimesClient) StartFailedServerlessRuntime 

func (c ServerlessRuntimesClient) StartFailedServerlessRuntime(ctx context.Context, id ServerlessRuntimeId) (result StartFailedServerlessRuntimeOperationResponse, err error)

StartFailedServerlessRuntime ...

func (ServerlessRuntimesClient) Update 

func (c ServerlessRuntimesClient) Update(ctx context.Context, id ServerlessRuntimeId, input InformaticaServerlessRuntimeResourceUpdate) (result UpdateOperationResponse, err error)

Update ...

type StartFailedServerlessRuntimeOperationResponse 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *InformaticaServerlessRuntimeResource
}

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.