containerinstance

package
v19.1.1+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 17, 2018 License: Apache-2.0 Imports: 9 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 - The name of the Azure File share to be mounted as a volume.
	ShareName *string `json:"shareName,omitempty"`
	// ReadOnly - The flag indicating whether the Azure File shared mounted as a volume is read-only.
	ReadOnly *bool `json:"readOnly,omitempty"`
	// StorageAccountName - The name of the storage account that contains the Azure File share.
	StorageAccountName *string `json:"storageAccountName,omitempty"`
	// StorageAccountKey - The storage account access key used to access the Azure File share.
	StorageAccountKey *string `json:"storageAccountKey,omitempty"`
}

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

type BaseClient 

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

BaseClient is the base client for Containerinstance.

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 Container 

type Container struct {
	// Name - The user-provided name of the container instance.
	Name *string `json:"name,omitempty"`
	// ContainerProperties - The properties of the container instance.
	*ContainerProperties `json:"properties,omitempty"`
}

Container a container instance.

func (Container) MarshalJSON 

func (c Container) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Container.

func (*Container) UnmarshalJSON 

func (c *Container) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Container struct.

type ContainerEvent 

type ContainerEvent struct {
	// Count - The count of the event.
	Count *int32 `json:"count,omitempty"`
	// FirstTimestamp - The date-time of the earliest logged event.
	FirstTimestamp *date.Time `json:"firstTimestamp,omitempty"`
	// LastTimestamp - The date-time of the latest logged event.
	LastTimestamp *date.Time `json:"lastTimestamp,omitempty"`
	// Message - The event message.
	Message *string `json:"message,omitempty"`
	// Type - The event type.
	Type *string `json:"type,omitempty"`
}

ContainerEvent a container instance event.

type ContainerGroup 

type ContainerGroup struct {
	autorest.Response         `json:"-"`
	*ContainerGroupProperties `json:"properties,omitempty"`
	// ID - The resource id.
	ID *string `json:"id,omitempty"`
	// Name - The resource name.
	Name *string `json:"name,omitempty"`
	// Type - The resource type.
	Type *string `json:"type,omitempty"`
	// Location - The resource location.
	Location *string `json:"location,omitempty"`
	// Tags - The resource tags.
	Tags map[string]*string `json:"tags"`
}

ContainerGroup a container group.

func (ContainerGroup) MarshalJSON 

func (cg ContainerGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerGroup.

func (*ContainerGroup) UnmarshalJSON 

func (cg *ContainerGroup) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ContainerGroup struct.

type ContainerGroupListResult 

type ContainerGroupListResult struct {
	autorest.Response `json:"-"`
	// Value - The list of container groups.
	Value *[]ContainerGroup `json:"value,omitempty"`
	// NextLink - The URI to fetch the next page of container groups.
	NextLink *string `json:"nextLink,omitempty"`
}

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

func (ContainerGroupListResult) IsEmpty 

func (cglr ContainerGroupListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ContainerGroupListResultIterator 

type ContainerGroupListResultIterator struct {
	// contains filtered or unexported fields
}

ContainerGroupListResultIterator provides access to a complete listing of ContainerGroup values.

func (*ContainerGroupListResultIterator) Next 

func (iter *ContainerGroupListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ContainerGroupListResultIterator) NotDone 

func (iter ContainerGroupListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ContainerGroupListResultIterator) Response 

func (iter ContainerGroupListResultIterator) Response() ContainerGroupListResult

Response returns the raw server response from the last page request.

func (ContainerGroupListResultIterator) Value 

func (iter ContainerGroupListResultIterator) Value() ContainerGroup

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ContainerGroupListResultPage 

type ContainerGroupListResultPage struct {
	// contains filtered or unexported fields
}

ContainerGroupListResultPage contains a page of ContainerGroup values.

func (*ContainerGroupListResultPage) Next 

func (page *ContainerGroupListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ContainerGroupListResultPage) NotDone 

func (page ContainerGroupListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ContainerGroupListResultPage) Response 

func (page ContainerGroupListResultPage) Response() ContainerGroupListResult

Response returns the raw server response from the last page request.

func (ContainerGroupListResultPage) Values 

func (page ContainerGroupListResultPage) Values() []ContainerGroup

Values returns the slice of values for the current page or nil if there are no values.

type ContainerGroupNetworkProtocol 

type ContainerGroupNetworkProtocol string

ContainerGroupNetworkProtocol enumerates the values for container group network protocol. 

const (
	// TCP ...
	TCP ContainerGroupNetworkProtocol = "TCP"
	// UDP ...
	UDP ContainerGroupNetworkProtocol = "UDP"
)

func PossibleContainerGroupNetworkProtocolValues 

func PossibleContainerGroupNetworkProtocolValues() []ContainerGroupNetworkProtocol

PossibleContainerGroupNetworkProtocolValues returns an array of possible values for the ContainerGroupNetworkProtocol const type.

type ContainerGroupProperties 

type ContainerGroupProperties struct {
	// ProvisioningState - The provisioning state of the container group. This only appears in the response.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// Containers - The containers within the container group.
	Containers *[]Container `json:"containers,omitempty"`
	// ImageRegistryCredentials - The image registry credentials by which the container group is created from.
	ImageRegistryCredentials *[]ImageRegistryCredential `json:"imageRegistryCredentials,omitempty"`
	// RestartPolicy - Restart policy for all containers within the container group. Currently the only available option is `always`. Possible values include: 'Always'
	RestartPolicy ContainerRestartPolicy `json:"restartPolicy,omitempty"`
	// IPAddress - The IP address type of the container group.
	IPAddress *IPAddress `json:"ipAddress,omitempty"`
	// OsType - The operating system type required by the containers in the container group. Possible values include: 'Windows', 'Linux'
	OsType OperatingSystemTypes `json:"osType,omitempty"`
	// State - The current state of the container group. This is only valid for the response.
	State *string `json:"state,omitempty"`
	// Volumes - The list of volumes that can be mounted by containers in this container group.
	Volumes *[]Volume `json:"volumes,omitempty"`
}

ContainerGroupProperties ...

type ContainerGroupsClient 

type ContainerGroupsClient struct {
	BaseClient
}

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(ctx context.Context, resourceGroupName string, containerGroupName string, containerGroup ContainerGroup) (result ContainerGroup, err error)

CreateOrUpdate create or update container groups with specified configurations. Parameters: resourceGroupName - the name of the resource group to contain the container group to be created or updated. containerGroupName - the name of the container group to be created or updated. containerGroup - the properties of the container group to be created or updated.

func (ContainerGroupsClient) CreateOrUpdatePreparer 

func (client ContainerGroupsClient) CreateOrUpdatePreparer(ctx context.Context, 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(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group that contains the container group. containerGroupName - the name of the container group to be deleted.

func (ContainerGroupsClient) DeletePreparer 

func (client ContainerGroupsClient) DeletePreparer(ctx context.Context, 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(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group that contains the container group. containerGroupName - the name of the container group.

func (ContainerGroupsClient) GetPreparer 

func (client ContainerGroupsClient) GetPreparer(ctx context.Context, 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(ctx context.Context) (result ContainerGroupListResultPage, 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(ctx context.Context, resourceGroupName string) (result ContainerGroupListResultPage, 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. Parameters: resourceGroupName - the name of the resource group that contains the container group.

func (ContainerGroupsClient) ListByResourceGroupComplete 

func (client ContainerGroupsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ContainerGroupListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (ContainerGroupsClient) ListByResourceGroupPreparer 

func (client ContainerGroupsClient) ListByResourceGroupPreparer(ctx context.Context, 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(ctx context.Context) (result ContainerGroupListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ContainerGroupsClient) ListPreparer 

func (client ContainerGroupsClient) ListPreparer(ctx context.Context) (*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 {
	BaseClient
}

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(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group that contains the container instance. containerName - the name of the container instance. containerGroupName - the name of the container group the container instance belongs to. tail - 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(ctx context.Context, 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 - The port number exposed within the container group.
	Port *int32 `json:"port,omitempty"`
}

ContainerPort the port exposed on the container instance.

type ContainerProperties 

type ContainerProperties struct {
	// Image - The name of the image used to create the container instance.
	Image *string `json:"image,omitempty"`
	// Command - The commands to execute within the container instance in exec form.
	Command *[]string `json:"command,omitempty"`
	// Ports - The exposed ports on the container instance.
	Ports *[]ContainerPort `json:"ports,omitempty"`
	// EnvironmentVariables - The environment variables to set in the container instance.
	EnvironmentVariables *[]EnvironmentVariable `json:"environmentVariables,omitempty"`
	// InstanceView - The instance view of the container instance. Only valid in response.
	InstanceView *ContainerPropertiesInstanceView `json:"instanceView,omitempty"`
	// Resources - The resource requirements of the container instance.
	Resources *ResourceRequirements `json:"resources,omitempty"`
	// VolumeMounts - The volume mounts available to the container instance.
	VolumeMounts *[]VolumeMount `json:"volumeMounts,omitempty"`
}

ContainerProperties the container instance properties.

type ContainerPropertiesInstanceView 

type ContainerPropertiesInstanceView struct {
	// RestartCount - The number of times that the container instance has been restarted.
	RestartCount *int32 `json:"restartCount,omitempty"`
	// CurrentState - Current container instance state.
	CurrentState *ContainerState `json:"currentState,omitempty"`
	// PreviousState - Previous container instance state.
	PreviousState *ContainerState `json:"previousState,omitempty"`
	// Events - The events of the container instance.
	Events *[]ContainerEvent `json:"events,omitempty"`
}

ContainerPropertiesInstanceView 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 ...
	Always ContainerRestartPolicy = "always"
)

func PossibleContainerRestartPolicyValues 

func PossibleContainerRestartPolicyValues() []ContainerRestartPolicy

PossibleContainerRestartPolicyValues returns an array of possible values for the ContainerRestartPolicy const type.

type ContainerState 

type ContainerState struct {
	// State - The state of the container instance.
	State *string `json:"state,omitempty"`
	// StartTime - The date-time when the container instance state started.
	StartTime *date.Time `json:"startTime,omitempty"`
	// ExitCode - The container instance exit codes correspond to those from the `docker run` command.
	ExitCode *int32 `json:"exitCode,omitempty"`
	// FinishTime - The date-time when the container instance state finished.
	FinishTime *date.Time `json:"finishTime,omitempty"`
	// DetailStatus - The human-readable status of the container instance state.
	DetailStatus *string `json:"detailStatus,omitempty"`
}

ContainerState the container instance state.

type EnvironmentVariable 

type EnvironmentVariable struct {
	// Name - The name of the environment variable.
	Name *string `json:"name,omitempty"`
	// Value - The value of the environment variable.
	Value *string `json:"value,omitempty"`
}

EnvironmentVariable the environment variable to set within the container instance.

type IPAddress 

type IPAddress struct {
	// Ports - The list of ports exposed on the container group.
	Ports *[]Port `json:"ports,omitempty"`
	// Type - Specifies if the IP is exposed to the public internet.
	Type *string `json:"type,omitempty"`
	// IP - The IP exposed to the public internet.
	IP *string `json:"ip,omitempty"`
}

IPAddress IP address for the container group.

type ImageRegistryCredential 

type ImageRegistryCredential struct {
	// Server - The Docker image registry server without a protocol such as "http" and "https".
	Server *string `json:"server,omitempty"`
	// Username - The username for the private registry.
	Username *string `json:"username,omitempty"`
	// Password - The password for the private registry.
	Password *string `json:"password,omitempty"`
}

ImageRegistryCredential image registry credential.

type Logs 

type Logs struct {
	autorest.Response `json:"-"`
	// Content - The content of the log.
	Content *string `json:"content,omitempty"`
}

Logs the logs.

type OperatingSystemTypes 

type OperatingSystemTypes string

OperatingSystemTypes enumerates the values for operating system types. 

const (
	// Linux ...
	Linux OperatingSystemTypes = "Linux"
	// Windows ...
	Windows OperatingSystemTypes = "Windows"
)

func PossibleOperatingSystemTypesValues 

func PossibleOperatingSystemTypesValues() []OperatingSystemTypes

PossibleOperatingSystemTypesValues returns an array of possible values for the OperatingSystemTypes const type.

type Port 

type Port struct {
	// Protocol - The protocol associated with the port. Possible values include: 'TCP', 'UDP'
	Protocol ContainerGroupNetworkProtocol `json:"protocol,omitempty"`
	// Port - The port number.
	Port *int32 `json:"port,omitempty"`
}

Port the port exposed on the container group.

type Resource 

type Resource struct {
	// ID - The resource id.
	ID *string `json:"id,omitempty"`
	// Name - The resource name.
	Name *string `json:"name,omitempty"`
	// Type - The resource type.
	Type *string `json:"type,omitempty"`
	// Location - The resource location.
	Location *string `json:"location,omitempty"`
	// Tags - The resource tags.
	Tags map[string]*string `json:"tags"`
}

Resource the Resource model definition.

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type ResourceLimits 

type ResourceLimits struct {
	// MemoryInGB - The memory limit in GB of this container instance.
	MemoryInGB *float64 `json:"memoryInGB,omitempty"`
	// CPU - The CPU limit of this container instance.
	CPU *float64 `json:"cpu,omitempty"`
}

ResourceLimits the resource limits.

type ResourceRequests 

type ResourceRequests struct {
	// MemoryInGB - The memory request in GB of this container instance.
	MemoryInGB *float64 `json:"memoryInGB,omitempty"`
	// CPU - The CPU request of this container instance.
	CPU *float64 `json:"cpu,omitempty"`
}

ResourceRequests the resource requests.

type ResourceRequirements 

type ResourceRequirements struct {
	// Requests - The resource requests of this container instance.
	Requests *ResourceRequests `json:"requests,omitempty"`
	// Limits - The resource limits of this container instance.
	Limits *ResourceLimits `json:"limits,omitempty"`
}

ResourceRequirements the resource requirements.

type Volume 

type Volume struct {
	// Name - The name of the volume.
	Name *string `json:"name,omitempty"`
	// AzureFile - The name of the Azure File volume.
	AzureFile *AzureFileVolume `json:"azureFile,omitempty"`
}

Volume the properties of the volume.

type VolumeMount 

type VolumeMount struct {
	// Name - The name of the volume mount.
	Name *string `json:"name,omitempty"`
	// MountPath - The path within the container where the volume should be mounted. Must not contain colon (:).
	MountPath *string `json:"mountPath,omitempty"`
	// ReadOnly - The flag indicating whether the volume mount is read-only.
	ReadOnly *bool `json:"readOnly,omitempty"`
}

VolumeMount 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.