Documentation ¶
Overview ¶
Package containerservice implements the Azure ARM Containerservice service API version 2015-11-01-preview.
Compute Client
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AgentPoolProfile
- type BaseClient
- type Client
- func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, containerServiceName string, ...) (result ContainerServiceCreateOrUpdateFuture, err error)
- func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, containerServiceName string, ...) (*http.Request, error)
- func (client Client) CreateOrUpdateResponder(resp *http.Response) (result ContainerService, err error)
- func (client Client) CreateOrUpdateSender(req *http.Request) (future ContainerServiceCreateOrUpdateFuture, err error)
- func (client Client) Delete(ctx context.Context, resourceGroupName string, containerServiceName string) (result ContainerServiceDeleteFuture, err error)
- func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, containerServiceName string) (*http.Request, error)
- func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client Client) DeleteSender(req *http.Request) (future ContainerServiceDeleteFuture, err error)
- func (client Client) Get(ctx context.Context, resourceGroupName string, containerServiceName string) (result ContainerService, err error)
- func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, containerServiceName string) (*http.Request, error)
- func (client Client) GetResponder(resp *http.Response) (result ContainerService, err error)
- func (client Client) GetSender(req *http.Request) (*http.Response, error)
- func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListResult, err error)
- func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
- func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
- func (client Client) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- type ContainerService
- type ContainerServiceCreateOrUpdateFuture
- type ContainerServiceDeleteFuture
- type DiagnosticsProfile
- type LinuxProfile
- type ListResult
- type MasterProfile
- type OchestratorTypes
- type OrchestratorProfile
- type Properties
- type Resource
- type SSHConfiguration
- type SSHPublicKey
- type VMDiagnostics
- type VMSizeTypes
- type WindowsProfile
Constants ¶
const (
// DefaultBaseURI is the default URI used for the service Containerservice
DefaultBaseURI = "https://management.azure.com"
)
Variables ¶
This section is empty.
Functions ¶
func UserAgent ¶
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version ¶
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
Types ¶
type AgentPoolProfile ¶
type AgentPoolProfile struct { // Name - Unique name of the agent pool profile within the context of the subscription and resource group Name *string `json:"name,omitempty"` // Count - No. of agents (VMs) that will host docker containers Count *int32 `json:"count,omitempty"` // VMSize - Size of agent VMs. Possible values include: 'StandardA0', 'StandardA1', 'StandardA2', 'StandardA3', 'StandardA4', 'StandardA5', 'StandardA6', 'StandardA7', 'StandardA8', 'StandardA9', 'StandardA10', 'StandardA11', 'StandardD1', 'StandardD2', 'StandardD3', 'StandardD4', 'StandardD11', 'StandardD12', 'StandardD13', 'StandardD14', 'StandardD1V2', 'StandardD2V2', 'StandardD3V2', 'StandardD4V2', 'StandardD5V2', 'StandardD11V2', 'StandardD12V2', 'StandardD13V2', 'StandardD14V2', 'StandardG1', 'StandardG2', 'StandardG3', 'StandardG4', 'StandardG5', 'StandardDS1', 'StandardDS2', 'StandardDS3', 'StandardDS4', 'StandardDS11', 'StandardDS12', 'StandardDS13', 'StandardDS14', 'StandardGS1', 'StandardGS2', 'StandardGS3', 'StandardGS4', 'StandardGS5' VMSize VMSizeTypes `json:"vmSize,omitempty"` // DNSPrefix - DNS prefix to be used to create FQDN for this agent pool DNSPrefix *string `json:"dnsPrefix,omitempty"` // Fqdn - FDQN for the agent pool Fqdn *string `json:"fqdn,omitempty"` }
AgentPoolProfile profile for container service agent pool
type BaseClient ¶
BaseClient is the base client for Containerservice.
func New ¶
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
NewWithBaseURI creates an instance of the BaseClient client.
type Client ¶
type Client struct {
BaseClient
}
Client is the compute Client
func NewClientWithBaseURI ¶
NewClientWithBaseURI creates an instance of the Client client.
func (Client) CreateOrUpdate ¶
func (client Client) CreateOrUpdate(ctx context.Context, resourceGroupName string, containerServiceName string, parameters ContainerService) (result ContainerServiceCreateOrUpdateFuture, err error)
CreateOrUpdate the operation to create or update a container service.
resourceGroupName is the name of the resource group. containerServiceName is the name of the container service within the given subscription and resource group. parameters is parameters supplied to the Create Container Service operation.
func (Client) CreateOrUpdatePreparer ¶
func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, containerServiceName string, parameters ContainerService) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (Client) CreateOrUpdateResponder ¶
func (client Client) CreateOrUpdateResponder(resp *http.Response) (result ContainerService, err error)
CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.
func (Client) CreateOrUpdateSender ¶
func (client Client) CreateOrUpdateSender(req *http.Request) (future ContainerServiceCreateOrUpdateFuture, err error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (Client) Delete ¶
func (client Client) Delete(ctx context.Context, resourceGroupName string, containerServiceName string) (result ContainerServiceDeleteFuture, err error)
Delete the operation to delete a container service.
resourceGroupName is the name of the resource group. containerServiceName is the name of the container service within the given subscription and resource group.
func (Client) DeletePreparer ¶
func (client Client) DeletePreparer(ctx context.Context, resourceGroupName string, containerServiceName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (Client) DeleteResponder ¶
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (Client) DeleteSender ¶
func (client Client) DeleteSender(req *http.Request) (future ContainerServiceDeleteFuture, err error)
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (Client) Get ¶
func (client Client) Get(ctx context.Context, resourceGroupName string, containerServiceName string) (result ContainerService, err error)
Get the operation to get a container service.
resourceGroupName is the name of the resource group. containerServiceName is the name of the container service within the given subscription and resource group.
func (Client) GetPreparer ¶
func (client Client) GetPreparer(ctx context.Context, resourceGroupName string, containerServiceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (Client) GetResponder ¶
func (client Client) GetResponder(resp *http.Response) (result ContainerService, err error)
GetResponder handles the response to the Get request. The method always closes the http.Response Body.
func (Client) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (Client) ListByResourceGroup ¶
func (client Client) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ListResult, err error)
ListByResourceGroup the operation to list container services.
resourceGroupName is the name of the resource group.
func (Client) ListByResourceGroupPreparer ¶
func (client Client) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (Client) ListByResourceGroupResponder ¶
func (client Client) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
type ContainerService ¶
type ContainerService struct { autorest.Response `json:"-"` // ID - Resource Id ID *string `json:"id,omitempty"` // Name - Resource name Name *string `json:"name,omitempty"` // Type - Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags *map[string]*string `json:"tags,omitempty"` *Properties `json:"properties,omitempty"` }
ContainerService container service
func (*ContainerService) UnmarshalJSON ¶
func (cs *ContainerService) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ContainerService struct.
type ContainerServiceCreateOrUpdateFuture ¶
type ContainerServiceCreateOrUpdateFuture struct { azure.Future // contains filtered or unexported fields }
ContainerServiceCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
func (ContainerServiceCreateOrUpdateFuture) Result ¶
func (future ContainerServiceCreateOrUpdateFuture) Result(client Client) (cs ContainerService, err error)
Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.
type ContainerServiceDeleteFuture ¶
ContainerServiceDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type DiagnosticsProfile ¶
type DiagnosticsProfile struct { // VMDiagnostics - Profile for container service VM diagnostic agent VMDiagnostics *VMDiagnostics `json:"vmDiagnostics,omitempty"` }
DiagnosticsProfile ...
type LinuxProfile ¶
type LinuxProfile struct { // AdminUsername - The administrator username to use for all Linux VMs AdminUsername *string `json:"adminUsername,omitempty"` // SSH - Specifies the ssh key configuration for Linux VMs SSH *SSHConfiguration `json:"ssh,omitempty"` }
LinuxProfile profile for Linux VM
type ListResult ¶
type ListResult struct { autorest.Response `json:"-"` // Value - Gets or sets the list of container services. Value *[]ContainerService `json:"value,omitempty"` }
ListResult the List Container Service operation response
type MasterProfile ¶
type MasterProfile struct { // Count - Number of masters (VMs) in the container cluster Count *int32 `json:"count,omitempty"` // DNSPrefix - DNS prefix to be used to create FQDN for master DNSPrefix *string `json:"dnsPrefix,omitempty"` // Fqdn - FDQN for the master Fqdn *string `json:"fqdn,omitempty"` }
MasterProfile profile for container service master
type OchestratorTypes ¶
type OchestratorTypes string
OchestratorTypes enumerates the values for ochestrator types.
const ( // DCOS ... DCOS OchestratorTypes = "DCOS" // Mesos ... Mesos OchestratorTypes = "Mesos" // SwarmPreview ... SwarmPreview OchestratorTypes = "SwarmPreview" )
type OrchestratorProfile ¶
type OrchestratorProfile struct { // OrchestratorType - Specifies what orchestrator will be used to manage container cluster resources. Possible values include: 'Mesos', 'SwarmPreview', 'DCOS' OrchestratorType OchestratorTypes `json:"orchestratorType,omitempty"` }
OrchestratorProfile profile for Orchestrator
type Properties ¶
type Properties struct { // ProvisioningState - Gets the provisioning state, which only appears in the response. ProvisioningState *string `json:"provisioningState,omitempty"` // OrchestratorProfile - Properties of orchestrator OrchestratorProfile *OrchestratorProfile `json:"orchestratorProfile,omitempty"` // MasterProfile - Properties of master agents MasterProfile *MasterProfile `json:"masterProfile,omitempty"` // AgentPoolProfiles - Properties of agent pools AgentPoolProfiles *[]AgentPoolProfile `json:"agentPoolProfiles,omitempty"` // WindowsProfile - Properties of Windows VMs WindowsProfile *WindowsProfile `json:"windowsProfile,omitempty"` // LinuxProfile - Properties for Linux VMs LinuxProfile *LinuxProfile `json:"linuxProfile,omitempty"` // DiagnosticsProfile - Properties for Diagnostic Agent DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"` }
Properties properties of container service
type Resource ¶
type Resource struct { // ID - Resource Id ID *string `json:"id,omitempty"` // Name - Resource name Name *string `json:"name,omitempty"` // Type - Resource type Type *string `json:"type,omitempty"` // Location - Resource location Location *string `json:"location,omitempty"` // Tags - Resource tags Tags *map[string]*string `json:"tags,omitempty"` }
Resource the Resource model definition.
type SSHConfiguration ¶
type SSHConfiguration struct { // PublicKeys - Gets or sets the list of SSH public keys used to authenticate with Linux based VMs PublicKeys *[]SSHPublicKey `json:"publicKeys,omitempty"` }
SSHConfiguration SSH configuration for Linux based VMs running on Azure
type SSHPublicKey ¶
type SSHPublicKey struct { // KeyData - Gets or sets Certificate public key used to authenticate with VM through SSH. The certificate must be in Pem format with or without headers. KeyData *string `json:"keyData,omitempty"` }
SSHPublicKey contains information about SSH certificate public key data.
type VMDiagnostics ¶
type VMDiagnostics struct { // Enabled - Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine. Enabled *bool `json:"enabled,omitempty"` // StorageURI - Gets or sets whether VM Diagnostic Agent should be provisioned on the Virtual Machine. StorageURI *string `json:"storageUri,omitempty"` }
VMDiagnostics describes VM Diagnostics.
type VMSizeTypes ¶
type VMSizeTypes string
VMSizeTypes enumerates the values for vm size types.
const ( // StandardA0 ... StandardA0 VMSizeTypes = "Standard_A0" // StandardA1 ... StandardA1 VMSizeTypes = "Standard_A1" // StandardA10 ... StandardA10 VMSizeTypes = "Standard_A10" // StandardA11 ... StandardA11 VMSizeTypes = "Standard_A11" // StandardA2 ... StandardA2 VMSizeTypes = "Standard_A2" // StandardA3 ... StandardA3 VMSizeTypes = "Standard_A3" // StandardA4 ... StandardA4 VMSizeTypes = "Standard_A4" // StandardA5 ... StandardA5 VMSizeTypes = "Standard_A5" // StandardA6 ... StandardA6 VMSizeTypes = "Standard_A6" // StandardA7 ... StandardA7 VMSizeTypes = "Standard_A7" // StandardA8 ... StandardA8 VMSizeTypes = "Standard_A8" // StandardA9 ... StandardA9 VMSizeTypes = "Standard_A9" // StandardD1 ... StandardD1 VMSizeTypes = "Standard_D1" // StandardD11 ... StandardD11 VMSizeTypes = "Standard_D11" // StandardD11V2 ... StandardD11V2 VMSizeTypes = "Standard_D11_v2" // StandardD12 ... StandardD12 VMSizeTypes = "Standard_D12" // StandardD12V2 ... StandardD12V2 VMSizeTypes = "Standard_D12_v2" // StandardD13 ... StandardD13 VMSizeTypes = "Standard_D13" // StandardD13V2 ... StandardD13V2 VMSizeTypes = "Standard_D13_v2" // StandardD14 ... StandardD14 VMSizeTypes = "Standard_D14" // StandardD14V2 ... StandardD14V2 VMSizeTypes = "Standard_D14_v2" // StandardD1V2 ... StandardD1V2 VMSizeTypes = "Standard_D1_v2" // StandardD2 ... StandardD2 VMSizeTypes = "Standard_D2" // StandardD2V2 ... StandardD2V2 VMSizeTypes = "Standard_D2_v2" // StandardD3 ... StandardD3 VMSizeTypes = "Standard_D3" // StandardD3V2 ... StandardD3V2 VMSizeTypes = "Standard_D3_v2" // StandardD4 ... StandardD4 VMSizeTypes = "Standard_D4" // StandardD4V2 ... StandardD4V2 VMSizeTypes = "Standard_D4_v2" // StandardD5V2 ... StandardD5V2 VMSizeTypes = "Standard_D5_v2" // StandardDS1 ... StandardDS1 VMSizeTypes = "Standard_DS1" // StandardDS11 ... StandardDS11 VMSizeTypes = "Standard_DS11" // StandardDS12 ... StandardDS12 VMSizeTypes = "Standard_DS12" // StandardDS13 ... StandardDS13 VMSizeTypes = "Standard_DS13" // StandardDS14 ... StandardDS14 VMSizeTypes = "Standard_DS14" // StandardDS2 ... StandardDS2 VMSizeTypes = "Standard_DS2" // StandardDS3 ... StandardDS3 VMSizeTypes = "Standard_DS3" // StandardDS4 ... StandardDS4 VMSizeTypes = "Standard_DS4" // StandardG1 ... StandardG1 VMSizeTypes = "Standard_G1" // StandardG2 ... StandardG2 VMSizeTypes = "Standard_G2" // StandardG3 ... StandardG3 VMSizeTypes = "Standard_G3" // StandardG4 ... StandardG4 VMSizeTypes = "Standard_G4" // StandardG5 ... StandardG5 VMSizeTypes = "Standard_G5" // StandardGS1 ... StandardGS1 VMSizeTypes = "Standard_GS1" // StandardGS2 ... StandardGS2 VMSizeTypes = "Standard_GS2" // StandardGS3 ... StandardGS3 VMSizeTypes = "Standard_GS3" // StandardGS4 ... StandardGS4 VMSizeTypes = "Standard_GS4" // StandardGS5 ... StandardGS5 VMSizeTypes = "Standard_GS5" )
type WindowsProfile ¶
type WindowsProfile struct { // AdminUsername - The administrator username to use for Windows jumpbox AdminUsername *string `json:"adminUsername,omitempty"` // AdminPassword - The administrator password to use for Windows jumpbox AdminPassword *string `json:"adminPassword,omitempty"` }
WindowsProfile profile for Windows jumpbox