containerinstance

package
v11.2.2-beta+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2017 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package containerinstance implements the Azure ARM Containerinstance service API version 2017-08-01-preview.

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Containerinstance
	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 AzureFileVolume 

type AzureFileVolume struct {
	ShareName          *string `json:"shareName,omitempty"`
	ReadOnly           *bool   `json:"readOnly,omitempty"`
	StorageAccountName *string `json:"storageAccountName,omitempty"`
	StorageAccountKey  *string `json:"storageAccountKey,omitempty"`
}

AzureFileVolume is the properties of the Azure File volume. Azure File shares are mounted as volumes.

type Container 

type Container struct {
	Name                 *string `json:"name,omitempty"`
	*ContainerProperties `json:"properties,omitempty"`
}

Container is a container instance.

type ContainerEvent 

type ContainerEvent struct {
	Count          *int32     `json:"count,omitempty"`
	FirstTimestamp *date.Time `json:"firstTimestamp,omitempty"`
	LastTimestamp  *date.Time `json:"lastTimestamp,omitempty"`
	Message        *string    `json:"message,omitempty"`
	Type           *string    `json:"type,omitempty"`
}

ContainerEvent is a container instance event.

type ContainerGroup 

type ContainerGroup 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"`
	*ContainerGroupProperties `json:"properties,omitempty"`
}

ContainerGroup is a container group.

type ContainerGroupListResult 

type ContainerGroupListResult struct {
	autorest.Response `json:"-"`
	Value             *[]ContainerGroup `json:"value,omitempty"`
	NextLink          *string           `json:"nextLink,omitempty"`
}

ContainerGroupListResult is the container group list response that contains the container group properties.

func (ContainerGroupListResult) ContainerGroupListResultPreparer 

func (client ContainerGroupListResult) ContainerGroupListResultPreparer() (*http.Request, error)

ContainerGroupListResultPreparer prepares a request to retrieve the next set of results. It returns nil if no more results exist.

type ContainerGroupNetworkProtocol 

type ContainerGroupNetworkProtocol string

ContainerGroupNetworkProtocol enumerates the values for container group network protocol. 

const (
	// TCP specifies the tcp state for container group network protocol.
	TCP ContainerGroupNetworkProtocol = "TCP"
	// UDP specifies the udp state for container group network protocol.
	UDP ContainerGroupNetworkProtocol = "UDP"
)

type ContainerGroupProperties 

type ContainerGroupProperties struct {
	ProvisioningState        *string                    `json:"provisioningState,omitempty"`
	Containers               *[]Container               `json:"containers,omitempty"`
	ImageRegistryCredentials *[]ImageRegistryCredential `json:"imageRegistryCredentials,omitempty"`
	RestartPolicy            ContainerRestartPolicy     `json:"restartPolicy,omitempty"`
	IPAddress                *IPAddress                 `json:"ipAddress,omitempty"`
	OsType                   OperatingSystemTypes       `json:"osType,omitempty"`
	State                    *string                    `json:"state,omitempty"`
	Volumes                  *[]Volume                  `json:"volumes,omitempty"`
}

ContainerGroupProperties is

type ContainerGroupsClient 

type ContainerGroupsClient struct {
	ManagementClient
}

ContainerGroupsClient is the client for the ContainerGroups methods of the Containerinstance service.

func NewContainerGroupsClient 

func NewContainerGroupsClient(subscriptionID string) ContainerGroupsClient

NewContainerGroupsClient creates an instance of the ContainerGroupsClient client.

func NewContainerGroupsClientWithBaseURI 

func NewContainerGroupsClientWithBaseURI(baseURI string, subscriptionID string) ContainerGroupsClient

NewContainerGroupsClientWithBaseURI creates an instance of the ContainerGroupsClient client.

func (ContainerGroupsClient) CreateOrUpdate 

func (client ContainerGroupsClient) CreateOrUpdate(resourceGroupName string, containerGroupName string, containerGroup ContainerGroup) (result ContainerGroup, err error)

CreateOrUpdate create or update container groups with specified configurations.

resourceGroupName is the name of the resource group to contain the container group to be created or updated. containerGroupName is the name of the container group to be created or updated. containerGroup is the properties of the container group to be created or updated.

func (ContainerGroupsClient) CreateOrUpdatePreparer 

func (client ContainerGroupsClient) CreateOrUpdatePreparer(resourceGroupName string, containerGroupName string, containerGroup ContainerGroup) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (ContainerGroupsClient) CreateOrUpdateResponder 

func (client ContainerGroupsClient) CreateOrUpdateResponder(resp *http.Response) (result ContainerGroup, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (ContainerGroupsClient) CreateOrUpdateSender 

func (client ContainerGroupsClient) 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 (ContainerGroupsClient) Delete 

func (client ContainerGroupsClient) Delete(resourceGroupName string, containerGroupName string) (result ContainerGroup, err error)

Delete delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.

resourceGroupName is the name of the resource group that contains the container group. containerGroupName is the name of the container group to be deleted.

func (ContainerGroupsClient) DeletePreparer 

func (client ContainerGroupsClient) DeletePreparer(resourceGroupName string, containerGroupName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ContainerGroupsClient) DeleteResponder 

func (client ContainerGroupsClient) DeleteResponder(resp *http.Response) (result ContainerGroup, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ContainerGroupsClient) DeleteSender 

func (client ContainerGroupsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ContainerGroupsClient) Get 

func (client ContainerGroupsClient) Get(resourceGroupName string, containerGroupName string) (result ContainerGroup, err error)

Get gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

resourceGroupName is the name of the resource group that contains the container group. containerGroupName is the name of the container group.

func (ContainerGroupsClient) GetPreparer 

func (client ContainerGroupsClient) GetPreparer(resourceGroupName string, containerGroupName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ContainerGroupsClient) GetResponder 

func (client ContainerGroupsClient) GetResponder(resp *http.Response) (result ContainerGroup, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ContainerGroupsClient) GetSender 

func (client ContainerGroupsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ContainerGroupsClient) List 

func (client ContainerGroupsClient) List() (result ContainerGroupListResult, err error)

List get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

func (ContainerGroupsClient) ListByResourceGroup 

func (client ContainerGroupsClient) ListByResourceGroup(resourceGroupName string) (result ContainerGroupListResult, err error)

ListByResourceGroup get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.

resourceGroupName is the name of the resource group that contains the container group.

func (ContainerGroupsClient) ListByResourceGroupComplete 

func (client ContainerGroupsClient) ListByResourceGroupComplete(resourceGroupName string, cancel <-chan struct{}) (<-chan ContainerGroup, <-chan error)

ListByResourceGroupComplete gets all elements from the list without paging.

func (ContainerGroupsClient) ListByResourceGroupNextResults 

func (client ContainerGroupsClient) ListByResourceGroupNextResults(lastResults ContainerGroupListResult) (result ContainerGroupListResult, err error)

ListByResourceGroupNextResults retrieves the next set of results, if any.

func (ContainerGroupsClient) ListByResourceGroupPreparer 

func (client ContainerGroupsClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ContainerGroupsClient) ListByResourceGroupResponder 

func (client ContainerGroupsClient) ListByResourceGroupResponder(resp *http.Response) (result ContainerGroupListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ContainerGroupsClient) ListByResourceGroupSender 

func (client ContainerGroupsClient) 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 (ContainerGroupsClient) ListComplete 

func (client ContainerGroupsClient) ListComplete(cancel <-chan struct{}) (<-chan ContainerGroup, <-chan error)

ListComplete gets all elements from the list without paging.

func (ContainerGroupsClient) ListNextResults 

func (client ContainerGroupsClient) ListNextResults(lastResults ContainerGroupListResult) (result ContainerGroupListResult, err error)

ListNextResults retrieves the next set of results, if any.

func (ContainerGroupsClient) ListPreparer 

func (client ContainerGroupsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (ContainerGroupsClient) ListResponder 

func (client ContainerGroupsClient) ListResponder(resp *http.Response) (result ContainerGroupListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ContainerGroupsClient) ListSender 

func (client ContainerGroupsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ContainerLogsClient 

type ContainerLogsClient struct {
	ManagementClient
}

ContainerLogsClient is the client for the ContainerLogs methods of the Containerinstance service.

func NewContainerLogsClient 

func NewContainerLogsClient(subscriptionID string) ContainerLogsClient

NewContainerLogsClient creates an instance of the ContainerLogsClient client.

func NewContainerLogsClientWithBaseURI 

func NewContainerLogsClientWithBaseURI(baseURI string, subscriptionID string) ContainerLogsClient

NewContainerLogsClientWithBaseURI creates an instance of the ContainerLogsClient client.

func (ContainerLogsClient) List 

func (client ContainerLogsClient) List(resourceGroupName string, containerName string, containerGroupName string, tail *int32) (result Logs, err error)

List get the logs for a specified container instance in a specified resource group and container group.

resourceGroupName is the name of the resource group that contains the container instance. containerName is the name of the container instance. containerGroupName is the name of the container group the container instance belongs to. tail is the number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.

func (ContainerLogsClient) ListPreparer 

func (client ContainerLogsClient) ListPreparer(resourceGroupName string, containerName string, containerGroupName string, tail *int32) (*http.Request, error)

ListPreparer prepares the List request.

func (ContainerLogsClient) ListResponder 

func (client ContainerLogsClient) ListResponder(resp *http.Response) (result Logs, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ContainerLogsClient) ListSender 

func (client ContainerLogsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ContainerPort 

type ContainerPort struct {
	Port *int32 `json:"port,omitempty"`
}

ContainerPort is the port exposed on the container instance.

type ContainerProperties 

type ContainerProperties struct {
	Image                *string                          `json:"image,omitempty"`
	Command              *[]string                        `json:"command,omitempty"`
	Ports                *[]ContainerPort                 `json:"ports,omitempty"`
	EnvironmentVariables *[]EnvironmentVariable           `json:"environmentVariables,omitempty"`
	InstanceView         *ContainerPropertiesInstanceView `json:"instanceView,omitempty"`
	Resources            *ResourceRequirements            `json:"resources,omitempty"`
	VolumeMounts         *[]VolumeMount                   `json:"volumeMounts,omitempty"`
}

ContainerProperties is the container instance properties.

type ContainerPropertiesInstanceView 

type ContainerPropertiesInstanceView struct {
	RestartCount  *int32            `json:"restartCount,omitempty"`
	CurrentState  *ContainerState   `json:"currentState,omitempty"`
	PreviousState *ContainerState   `json:"previousState,omitempty"`
	Events        *[]ContainerEvent `json:"events,omitempty"`
}

ContainerPropertiesInstanceView is the instance view of the container instance. Only valid in response.

type ContainerRestartPolicy 

type ContainerRestartPolicy string

ContainerRestartPolicy enumerates the values for container restart policy. 

const (
	// Always specifies the always state for container restart policy.
	Always ContainerRestartPolicy = "always"
)

type ContainerState 

type ContainerState struct {
	State        *string    `json:"state,omitempty"`
	StartTime    *date.Time `json:"startTime,omitempty"`
	ExitCode     *int32     `json:"exitCode,omitempty"`
	FinishTime   *date.Time `json:"finishTime,omitempty"`
	DetailStatus *string    `json:"detailStatus,omitempty"`
}

ContainerState is the container instance state.

type EnvironmentVariable 

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

EnvironmentVariable is the environment variable to set within the container instance.

type IPAddress 

type IPAddress struct {
	Ports *[]Port `json:"ports,omitempty"`
	Type  *string `json:"type,omitempty"`
	IP    *string `json:"ip,omitempty"`
}

IPAddress is IP address for the container group.

type ImageRegistryCredential 

type ImageRegistryCredential struct {
	Server   *string `json:"server,omitempty"`
	Username *string `json:"username,omitempty"`
	Password *string `json:"password,omitempty"`
}

ImageRegistryCredential is image registry credential.

type Logs 

type Logs struct {
	autorest.Response `json:"-"`
	Content           *string `json:"content,omitempty"`
}

Logs is the logs.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

ManagementClient is the base client for Containerinstance.

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 OperatingSystemTypes 

type OperatingSystemTypes string

OperatingSystemTypes enumerates the values for operating system types. 

const (
	// Linux specifies the linux state for operating system types.
	Linux OperatingSystemTypes = "Linux"
	// Windows specifies the windows state for operating system types.
	Windows OperatingSystemTypes = "Windows"
)

type Port 

type Port struct {
	Protocol ContainerGroupNetworkProtocol `json:"protocol,omitempty"`
	Port     *int32                        `json:"port,omitempty"`
}

Port is the port exposed on the container group.

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 ResourceLimits 

type ResourceLimits struct {
	MemoryInGB *float64 `json:"memoryInGB,omitempty"`
	CPU        *float64 `json:"cpu,omitempty"`
}

ResourceLimits is the resource limits.

type ResourceRequests 

type ResourceRequests struct {
	MemoryInGB *float64 `json:"memoryInGB,omitempty"`
	CPU        *float64 `json:"cpu,omitempty"`
}

ResourceRequests is the resource requests.

type ResourceRequirements 

type ResourceRequirements struct {
	Requests *ResourceRequests `json:"requests,omitempty"`
	Limits   *ResourceLimits   `json:"limits,omitempty"`
}

ResourceRequirements is the resource requirements.

type Volume 

type Volume struct {
	Name      *string          `json:"name,omitempty"`
	AzureFile *AzureFileVolume `json:"azureFile,omitempty"`
}

Volume is the properties of the volume.

type VolumeMount 

type VolumeMount struct {
	Name      *string `json:"name,omitempty"`
	MountPath *string `json:"mountPath,omitempty"`
	ReadOnly  *bool   `json:"readOnly,omitempty"`
}

VolumeMount is the properties of the volume mount.

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.