apimanagementworkspacelinks

package
v0.20241009.1142232 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2024 License: MPL-2.0 Imports: 10 Imported by: 1

README

The apimanagementworkspacelinks SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2024-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/apimanagement/2024-05-01/apimanagementworkspacelinks"

Client Initialization

client := apimanagementworkspacelinks.NewApiManagementWorkspaceLinksClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiManagementWorkspaceLinksClient.ApiManagementWorkspaceLinkGet

ctx := context.TODO()
id := apimanagementworkspacelinks.NewWorkspaceLinkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceName", "workspaceId")

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

Example Usage: ApiManagementWorkspaceLinksClient.ListByService

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateServiceID 

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

func ValidateWorkspaceLinkID 

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

ValidateWorkspaceLinkID checks that 'input' can be parsed as a Workspace Link ID

Types

type ApiManagementWorkspaceLinkGetOperationResponse 

type ApiManagementWorkspaceLinkGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ApiManagementWorkspaceLinksResource
}

type ApiManagementWorkspaceLinksClient 

type ApiManagementWorkspaceLinksClient struct {
	Client *resourcemanager.Client
}

func NewApiManagementWorkspaceLinksClientWithBaseURI 

func NewApiManagementWorkspaceLinksClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiManagementWorkspaceLinksClient, error)

func (ApiManagementWorkspaceLinksClient) ApiManagementWorkspaceLinkGet 

func (c ApiManagementWorkspaceLinksClient) ApiManagementWorkspaceLinkGet(ctx context.Context, id WorkspaceLinkId) (result ApiManagementWorkspaceLinkGetOperationResponse, err error)

ApiManagementWorkspaceLinkGet ...

func (ApiManagementWorkspaceLinksClient) ListByService 

func (c ApiManagementWorkspaceLinksClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)

ListByService ...

func (ApiManagementWorkspaceLinksClient) ListByServiceComplete 

func (c ApiManagementWorkspaceLinksClient) ListByServiceComplete(ctx context.Context, id ServiceId) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (ApiManagementWorkspaceLinksClient) ListByServiceCompleteMatchingPredicate 

func (c ApiManagementWorkspaceLinksClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, predicate ApiManagementWorkspaceLinksResourceOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ApiManagementWorkspaceLinksResource 

type ApiManagementWorkspaceLinksResource struct {
	Etag       *string                      `json:"etag,omitempty"`
	Id         *string                      `json:"id,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties WorkspaceLinksBaseProperties `json:"properties"`
	Type       *string                      `json:"type,omitempty"`
}

type ApiManagementWorkspaceLinksResourceOperationPredicate 

type ApiManagementWorkspaceLinksResourceOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (ApiManagementWorkspaceLinksResourceOperationPredicate) Matches 

func (p ApiManagementWorkspaceLinksResourceOperationPredicate) Matches(input ApiManagementWorkspaceLinksResource) bool

type ListByServiceCompleteResult 

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiManagementWorkspaceLinksResource
}

type ListByServiceCustomPager 

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

type ListByServiceOperationResponse 

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiManagementWorkspaceLinksResource
}

type ServiceId 

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID 

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID 

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively 

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult 

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

func (ServiceId) ID 

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments 

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

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

func (ServiceId) String 

func (id ServiceId) String() string

String returns a human-readable description of this Service ID

type WorkspaceLinkId 

type WorkspaceLinkId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
	WorkspaceId       string
}

WorkspaceLinkId is a struct representing the Resource ID for a Workspace Link

func NewWorkspaceLinkID 

func NewWorkspaceLinkID(subscriptionId string, resourceGroupName string, serviceName string, workspaceId string) WorkspaceLinkId

NewWorkspaceLinkID returns a new WorkspaceLinkId struct

func ParseWorkspaceLinkID 

func ParseWorkspaceLinkID(input string) (*WorkspaceLinkId, error)

ParseWorkspaceLinkID parses 'input' into a WorkspaceLinkId

func ParseWorkspaceLinkIDInsensitively 

func ParseWorkspaceLinkIDInsensitively(input string) (*WorkspaceLinkId, error)

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

func (*WorkspaceLinkId) FromParseResult 

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

func (WorkspaceLinkId) ID 

func (id WorkspaceLinkId) ID() string

ID returns the formatted Workspace Link ID

func (WorkspaceLinkId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Workspace Link ID

func (WorkspaceLinkId) String 

func (id WorkspaceLinkId) String() string

String returns a human-readable description of this Workspace Link ID

type WorkspaceLinksBaseProperties 

type WorkspaceLinksBaseProperties struct {
	Gateways    *[]WorkspaceLinksGateway `json:"gateways,omitempty"`
	WorkspaceId *string                  `json:"workspaceId,omitempty"`
}

type WorkspaceLinksGateway 

type WorkspaceLinksGateway struct {
	Id *string `json:"id,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.