containerservices

README

github.com/hashicorp/go-azure-sdk/resource-manager/containerservice/2019-08-01/containerservices Documentation

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

Client Initialization

client := containerservices.NewContainerServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerServicesClient.ListOrchestrators

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

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

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type ContainerServicesClient
  • func NewContainerServicesClientWithBaseURI(endpoint string) ContainerServicesClient
  • func (c ContainerServicesClient) ListOrchestrators(ctx context.Context, id LocationId, options ListOrchestratorsOperationOptions) (result ListOrchestratorsOperationResponse, err error)
• type ListOrchestratorsOperationOptions
  • func DefaultListOrchestratorsOperationOptions() ListOrchestratorsOperationOptions
• type ListOrchestratorsOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type OrchestratorProfile
• type OrchestratorVersionProfile
• type OrchestratorVersionProfileListResult
• type OrchestratorVersionProfileProperties

Functions

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 ContainerServicesClient

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

func NewContainerServicesClientWithBaseURI

func NewContainerServicesClientWithBaseURI(endpoint string) ContainerServicesClient

func (ContainerServicesClient) ListOrchestrators

func (c ContainerServicesClient) ListOrchestrators(ctx context.Context, id LocationId, options ListOrchestratorsOperationOptions) (result ListOrchestratorsOperationResponse, err error)

ListOrchestrators ...

type ListOrchestratorsOperationOptions

type ListOrchestratorsOperationOptions struct {
	ResourceType *string
}

func DefaultListOrchestratorsOperationOptions

func DefaultListOrchestratorsOperationOptions() ListOrchestratorsOperationOptions

type ListOrchestratorsOperationResponse

type ListOrchestratorsOperationResponse struct {
	HttpResponse *http.Response
	Model        *OrchestratorVersionProfileListResult
}

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 OrchestratorProfile

type OrchestratorProfile struct {
	IsPreview           *bool   `json:"isPreview,omitempty"`
	OrchestratorType    *string `json:"orchestratorType,omitempty"`
	OrchestratorVersion string  `json:"orchestratorVersion"`
}

type OrchestratorVersionProfile

type OrchestratorVersionProfile struct {
	Default             *bool                  `json:"default,omitempty"`
	IsPreview           *bool                  `json:"isPreview,omitempty"`
	OrchestratorType    string                 `json:"orchestratorType"`
	OrchestratorVersion string                 `json:"orchestratorVersion"`
	Upgrades            *[]OrchestratorProfile `json:"upgrades,omitempty"`
}

type OrchestratorVersionProfileListResult

type OrchestratorVersionProfileListResult struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties OrchestratorVersionProfileProperties `json:"properties"`
	Type       *string                              `json:"type,omitempty"`
}

type OrchestratorVersionProfileProperties

type OrchestratorVersionProfileProperties struct {
	Orchestrators []OrchestratorVersionProfile `json:"orchestrators"`
}