Documentation ¶
Overview ¶
Package containerservice implements the Azure ARM Containerservice service API version 2017-01-31.
The Container Service Client.
Index ¶
- Constants
- func UserAgent() string
- func Version() string
- type AgentPoolProfile
- type ContainerService
- type ContainerServicesClient
- func (client ContainerServicesClient) CreateOrUpdate(resourceGroupName string, containerServiceName string, ...) (<-chan ContainerService, <-chan error)
- func (client ContainerServicesClient) CreateOrUpdatePreparer(resourceGroupName string, containerServiceName string, ...) (*http.Request, error)
- func (client ContainerServicesClient) CreateOrUpdateResponder(resp *http.Response) (result ContainerService, err error)
- func (client ContainerServicesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
- func (client ContainerServicesClient) Delete(resourceGroupName string, containerServiceName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)
- func (client ContainerServicesClient) DeletePreparer(resourceGroupName string, containerServiceName string, cancel <-chan struct{}) (*http.Request, error)
- func (client ContainerServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
- func (client ContainerServicesClient) DeleteSender(req *http.Request) (*http.Response, error)
- func (client ContainerServicesClient) Get(resourceGroupName string, containerServiceName string) (result ContainerService, err error)
- func (client ContainerServicesClient) GetPreparer(resourceGroupName string, containerServiceName string) (*http.Request, error)
- func (client ContainerServicesClient) GetResponder(resp *http.Response) (result ContainerService, err error)
- func (client ContainerServicesClient) GetSender(req *http.Request) (*http.Response, error)
- func (client ContainerServicesClient) List() (result ListResult, err error)
- func (client ContainerServicesClient) ListByResourceGroup(resourceGroupName string) (result ListResult, err error)
- func (client ContainerServicesClient) ListByResourceGroupNextResults(lastResults ListResult) (result ListResult, err error)
- func (client ContainerServicesClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
- func (client ContainerServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
- func (client ContainerServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
- func (client ContainerServicesClient) ListNextResults(lastResults ListResult) (result ListResult, err error)
- func (client ContainerServicesClient) ListPreparer() (*http.Request, error)
- func (client ContainerServicesClient) ListResponder(resp *http.Response) (result ListResult, err error)
- func (client ContainerServicesClient) ListSender(req *http.Request) (*http.Response, error)
- type CustomProfile
- type DiagnosticsProfile
- type LinuxProfile
- type ListResult
- type ManagementClient
- type MasterProfile
- type OchestratorTypes
- type OrchestratorProfile
- type Properties
- type Resource
- type SSHConfiguration
- type SSHPublicKey
- type ServicePrincipalProfile
- 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 *string `json:"name,omitempty"` Count *int32 `json:"count,omitempty"` VMSize VMSizeTypes `json:"vmSize,omitempty"` DNSPrefix *string `json:"dnsPrefix,omitempty"` Fqdn *string `json:"fqdn,omitempty"` }
AgentPoolProfile is profile for the container service agent pool.
type ContainerService ¶
type ContainerService struct { autorest.Response `json:"-"` ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` *Properties `json:"properties,omitempty"` }
ContainerService is container service.
type ContainerServicesClient ¶
type ContainerServicesClient struct {
ManagementClient
}
ContainerServicesClient is the the Container Service Client.
func NewContainerServicesClient ¶
func NewContainerServicesClient(subscriptionID string) ContainerServicesClient
NewContainerServicesClient creates an instance of the ContainerServicesClient client.
func NewContainerServicesClientWithBaseURI ¶
func NewContainerServicesClientWithBaseURI(baseURI string, subscriptionID string) ContainerServicesClient
NewContainerServicesClientWithBaseURI creates an instance of the ContainerServicesClient client.
func (ContainerServicesClient) CreateOrUpdate ¶
func (client ContainerServicesClient) CreateOrUpdate(resourceGroupName string, containerServiceName string, parameters ContainerService, cancel <-chan struct{}) (<-chan ContainerService, <-chan error)
CreateOrUpdate creates or updates a container service with the specified configuration of orchestrator, masters, and agents. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group. containerServiceName is the name of the container service in the specified subscription and resource group. parameters is parameters supplied to the Create or Update a Container Service operation.
func (ContainerServicesClient) CreateOrUpdatePreparer ¶
func (client ContainerServicesClient) CreateOrUpdatePreparer(resourceGroupName string, containerServiceName string, parameters ContainerService, cancel <-chan struct{}) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
func (ContainerServicesClient) CreateOrUpdateResponder ¶
func (client ContainerServicesClient) 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 (ContainerServicesClient) CreateOrUpdateSender ¶
func (client ContainerServicesClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.
func (ContainerServicesClient) Delete ¶
func (client ContainerServicesClient) Delete(resourceGroupName string, containerServiceName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)
Delete deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.
resourceGroupName is the name of the resource group. containerServiceName is the name of the container service in the specified subscription and resource group.
func (ContainerServicesClient) DeletePreparer ¶
func (client ContainerServicesClient) DeletePreparer(resourceGroupName string, containerServiceName string, cancel <-chan struct{}) (*http.Request, error)
DeletePreparer prepares the Delete request.
func (ContainerServicesClient) DeleteResponder ¶
func (client ContainerServicesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.
func (ContainerServicesClient) DeleteSender ¶
DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.
func (ContainerServicesClient) Get ¶
func (client ContainerServicesClient) Get(resourceGroupName string, containerServiceName string) (result ContainerService, err error)
Get gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
resourceGroupName is the name of the resource group. containerServiceName is the name of the container service in the specified subscription and resource group.
func (ContainerServicesClient) GetPreparer ¶
func (client ContainerServicesClient) GetPreparer(resourceGroupName string, containerServiceName string) (*http.Request, error)
GetPreparer prepares the Get request.
func (ContainerServicesClient) GetResponder ¶
func (client ContainerServicesClient) 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 (ContainerServicesClient) GetSender ¶
GetSender sends the Get request. The method will close the http.Response Body if it receives an error.
func (ContainerServicesClient) List ¶
func (client ContainerServicesClient) List() (result ListResult, err error)
List gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
func (ContainerServicesClient) ListByResourceGroup ¶
func (client ContainerServicesClient) ListByResourceGroup(resourceGroupName string) (result ListResult, err error)
ListByResourceGroup gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
resourceGroupName is the name of the resource group.
func (ContainerServicesClient) ListByResourceGroupNextResults ¶
func (client ContainerServicesClient) ListByResourceGroupNextResults(lastResults ListResult) (result ListResult, err error)
ListByResourceGroupNextResults retrieves the next set of results, if any.
func (ContainerServicesClient) ListByResourceGroupPreparer ¶
func (client ContainerServicesClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
func (ContainerServicesClient) ListByResourceGroupResponder ¶
func (client ContainerServicesClient) ListByResourceGroupResponder(resp *http.Response) (result ListResult, err error)
ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.
func (ContainerServicesClient) ListByResourceGroupSender ¶
func (client ContainerServicesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.
func (ContainerServicesClient) ListNextResults ¶
func (client ContainerServicesClient) ListNextResults(lastResults ListResult) (result ListResult, err error)
ListNextResults retrieves the next set of results, if any.
func (ContainerServicesClient) ListPreparer ¶
func (client ContainerServicesClient) ListPreparer() (*http.Request, error)
ListPreparer prepares the List request.
func (ContainerServicesClient) ListResponder ¶
func (client ContainerServicesClient) ListResponder(resp *http.Response) (result ListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (ContainerServicesClient) ListSender ¶
ListSender sends the List request. The method will close the http.Response Body if it receives an error.
type CustomProfile ¶
type CustomProfile struct {
Orchestrator *string `json:"orchestrator,omitempty"`
}
CustomProfile is properties to configure a custom container service cluster.
type DiagnosticsProfile ¶
type DiagnosticsProfile struct {
VMDiagnostics *VMDiagnostics `json:"vmDiagnostics,omitempty"`
}
DiagnosticsProfile is
type LinuxProfile ¶
type LinuxProfile struct { AdminUsername *string `json:"adminUsername,omitempty"` SSH *SSHConfiguration `json:"ssh,omitempty"` }
LinuxProfile is profile for Linux VMs in the container service cluster.
type ListResult ¶
type ListResult struct { autorest.Response `json:"-"` Value *[]ContainerService `json:"value,omitempty"` NextLink *string `json:"nextLink,omitempty"` }
ListResult is the response from the List Container Services operation.
func (ListResult) ListResultPreparer ¶
func (client ListResult) ListResultPreparer() (*http.Request, error)
ListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.
type ManagementClient ¶
ManagementClient is the base client for Containerservice.
func New ¶
func New(subscriptionID string) ManagementClient
New creates an instance of the ManagementClient client.
func NewWithBaseURI ¶
func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient
NewWithBaseURI creates an instance of the ManagementClient client.
type MasterProfile ¶
type MasterProfile struct { Count *int32 `json:"count,omitempty"` DNSPrefix *string `json:"dnsPrefix,omitempty"` Fqdn *string `json:"fqdn,omitempty"` }
MasterProfile is profile for the container service master.
type OchestratorTypes ¶
type OchestratorTypes string
OchestratorTypes enumerates the values for ochestrator types.
const ( // Custom specifies the custom state for ochestrator types. Custom OchestratorTypes = "Custom" // DCOS specifies the dcos state for ochestrator types. DCOS OchestratorTypes = "DCOS" // Kubernetes specifies the kubernetes state for ochestrator types. Kubernetes OchestratorTypes = "Kubernetes" // Swarm specifies the swarm state for ochestrator types. Swarm OchestratorTypes = "Swarm" )
type OrchestratorProfile ¶
type OrchestratorProfile struct {
OrchestratorType OchestratorTypes `json:"orchestratorType,omitempty"`
}
OrchestratorProfile is profile for the container service orchestrator.
type Properties ¶
type Properties struct { ProvisioningState *string `json:"provisioningState,omitempty"` OrchestratorProfile *OrchestratorProfile `json:"orchestratorProfile,omitempty"` CustomProfile *CustomProfile `json:"customProfile,omitempty"` ServicePrincipalProfile *ServicePrincipalProfile `json:"servicePrincipalProfile,omitempty"` MasterProfile *MasterProfile `json:"masterProfile,omitempty"` AgentPoolProfiles *[]AgentPoolProfile `json:"agentPoolProfiles,omitempty"` WindowsProfile *WindowsProfile `json:"windowsProfile,omitempty"` LinuxProfile *LinuxProfile `json:"linuxProfile,omitempty"` DiagnosticsProfile *DiagnosticsProfile `json:"diagnosticsProfile,omitempty"` }
Properties is properties of the container service.
type Resource ¶
type Resource struct { ID *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Type *string `json:"type,omitempty"` Location *string `json:"location,omitempty"` Tags *map[string]*string `json:"tags,omitempty"` }
Resource is the Resource model definition.
type SSHConfiguration ¶
type SSHConfiguration struct {
PublicKeys *[]SSHPublicKey `json:"publicKeys,omitempty"`
}
SSHConfiguration is sSH configuration for Linux-based VMs running on Azure.
type SSHPublicKey ¶
type SSHPublicKey struct {
KeyData *string `json:"keyData,omitempty"`
}
SSHPublicKey is contains information about SSH certificate public key data.
type ServicePrincipalProfile ¶
type ServicePrincipalProfile struct { ClientID *string `json:"clientId,omitempty"` Secret *string `json:"secret,omitempty"` }
ServicePrincipalProfile is information about a service principal identity for the cluster to use for manipulating Azure APIs.
type VMDiagnostics ¶
type VMDiagnostics struct { Enabled *bool `json:"enabled,omitempty"` StorageURI *string `json:"storageUri,omitempty"` }
VMDiagnostics is profile for diagnostics on the container service VMs.
type VMSizeTypes ¶
type VMSizeTypes string
VMSizeTypes enumerates the values for vm size types.
const ( // StandardA0 specifies the standard a0 state for vm size types. StandardA0 VMSizeTypes = "Standard_A0" // StandardA1 specifies the standard a1 state for vm size types. StandardA1 VMSizeTypes = "Standard_A1" // StandardA10 specifies the standard a10 state for vm size types. StandardA10 VMSizeTypes = "Standard_A10" // StandardA11 specifies the standard a11 state for vm size types. StandardA11 VMSizeTypes = "Standard_A11" // StandardA2 specifies the standard a2 state for vm size types. StandardA2 VMSizeTypes = "Standard_A2" // StandardA3 specifies the standard a3 state for vm size types. StandardA3 VMSizeTypes = "Standard_A3" // StandardA4 specifies the standard a4 state for vm size types. StandardA4 VMSizeTypes = "Standard_A4" // StandardA5 specifies the standard a5 state for vm size types. StandardA5 VMSizeTypes = "Standard_A5" // StandardA6 specifies the standard a6 state for vm size types. StandardA6 VMSizeTypes = "Standard_A6" // StandardA7 specifies the standard a7 state for vm size types. StandardA7 VMSizeTypes = "Standard_A7" // StandardA8 specifies the standard a8 state for vm size types. StandardA8 VMSizeTypes = "Standard_A8" // StandardA9 specifies the standard a9 state for vm size types. StandardA9 VMSizeTypes = "Standard_A9" // StandardD1 specifies the standard d1 state for vm size types. StandardD1 VMSizeTypes = "Standard_D1" // StandardD11 specifies the standard d11 state for vm size types. StandardD11 VMSizeTypes = "Standard_D11" // StandardD11V2 specifies the standard d11v2 state for vm size types. StandardD11V2 VMSizeTypes = "Standard_D11_v2" // StandardD12 specifies the standard d12 state for vm size types. StandardD12 VMSizeTypes = "Standard_D12" // StandardD12V2 specifies the standard d12v2 state for vm size types. StandardD12V2 VMSizeTypes = "Standard_D12_v2" // StandardD13 specifies the standard d13 state for vm size types. StandardD13 VMSizeTypes = "Standard_D13" // StandardD13V2 specifies the standard d13v2 state for vm size types. StandardD13V2 VMSizeTypes = "Standard_D13_v2" // StandardD14 specifies the standard d14 state for vm size types. StandardD14 VMSizeTypes = "Standard_D14" // StandardD14V2 specifies the standard d14v2 state for vm size types. StandardD14V2 VMSizeTypes = "Standard_D14_v2" // StandardD1V2 specifies the standard d1v2 state for vm size types. StandardD1V2 VMSizeTypes = "Standard_D1_v2" // StandardD2 specifies the standard d2 state for vm size types. StandardD2 VMSizeTypes = "Standard_D2" // StandardD2V2 specifies the standard d2v2 state for vm size types. StandardD2V2 VMSizeTypes = "Standard_D2_v2" // StandardD3 specifies the standard d3 state for vm size types. StandardD3 VMSizeTypes = "Standard_D3" // StandardD3V2 specifies the standard d3v2 state for vm size types. StandardD3V2 VMSizeTypes = "Standard_D3_v2" // StandardD4 specifies the standard d4 state for vm size types. StandardD4 VMSizeTypes = "Standard_D4" // StandardD4V2 specifies the standard d4v2 state for vm size types. StandardD4V2 VMSizeTypes = "Standard_D4_v2" // StandardD5V2 specifies the standard d5v2 state for vm size types. StandardD5V2 VMSizeTypes = "Standard_D5_v2" // StandardDS1 specifies the standard ds1 state for vm size types. StandardDS1 VMSizeTypes = "Standard_DS1" // StandardDS11 specifies the standard ds11 state for vm size types. StandardDS11 VMSizeTypes = "Standard_DS11" // StandardDS12 specifies the standard ds12 state for vm size types. StandardDS12 VMSizeTypes = "Standard_DS12" // StandardDS13 specifies the standard ds13 state for vm size types. StandardDS13 VMSizeTypes = "Standard_DS13" // StandardDS14 specifies the standard ds14 state for vm size types. StandardDS14 VMSizeTypes = "Standard_DS14" // StandardDS2 specifies the standard ds2 state for vm size types. StandardDS2 VMSizeTypes = "Standard_DS2" // StandardDS3 specifies the standard ds3 state for vm size types. StandardDS3 VMSizeTypes = "Standard_DS3" // StandardDS4 specifies the standard ds4 state for vm size types. StandardDS4 VMSizeTypes = "Standard_DS4" // StandardG1 specifies the standard g1 state for vm size types. StandardG1 VMSizeTypes = "Standard_G1" // StandardG2 specifies the standard g2 state for vm size types. StandardG2 VMSizeTypes = "Standard_G2" // StandardG3 specifies the standard g3 state for vm size types. StandardG3 VMSizeTypes = "Standard_G3" // StandardG4 specifies the standard g4 state for vm size types. StandardG4 VMSizeTypes = "Standard_G4" // StandardG5 specifies the standard g5 state for vm size types. StandardG5 VMSizeTypes = "Standard_G5" // StandardGS1 specifies the standard gs1 state for vm size types. StandardGS1 VMSizeTypes = "Standard_GS1" // StandardGS2 specifies the standard gs2 state for vm size types. StandardGS2 VMSizeTypes = "Standard_GS2" // StandardGS3 specifies the standard gs3 state for vm size types. StandardGS3 VMSizeTypes = "Standard_GS3" // StandardGS4 specifies the standard gs4 state for vm size types. StandardGS4 VMSizeTypes = "Standard_GS4" // StandardGS5 specifies the standard gs5 state for vm size types. StandardGS5 VMSizeTypes = "Standard_GS5" )
type WindowsProfile ¶
type WindowsProfile struct { AdminUsername *string `json:"adminUsername,omitempty"` AdminPassword *string `json:"adminPassword,omitempty"` }
WindowsProfile is profile for Windows VMs in the container service cluster.