containerinstance

package
v67.3.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 10, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Deprecated: Please note, this package has been deprecated. A replacement package is available github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerinstance/armcontainerinstance(https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/containerinstance/armcontainerinstance). We strongly encourage you to upgrade to continue receiving updates. See [Migration Guide](https://aka.ms/azsdk/golang/t2/migration) for guidance on upgrading. Refer to our [deprecation policy](https://azure.github.io/azure-sdk/policies_support.html) for more details.

Package containerinstance implements the Azure ARM Containerinstance service API version 2019-12-01.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type CachedImages 

type CachedImages struct {
	// OsType - The OS type of the cached image.
	OsType *string `json:"osType,omitempty"`
	// Image - The cached image name.
	Image *string `json:"image,omitempty"`
}

CachedImages the cached image and OS type.

type CachedImagesListResult 

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

CachedImagesListResult the response containing cached images.

func (CachedImagesListResult) IsEmpty 

func (cilr CachedImagesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CachedImagesListResultIterator 

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

CachedImagesListResultIterator provides access to a complete listing of CachedImages values.

func NewCachedImagesListResultIterator 

func NewCachedImagesListResultIterator(page CachedImagesListResultPage) CachedImagesListResultIterator

Creates a new instance of the CachedImagesListResultIterator type.

func (*CachedImagesListResultIterator) Next 

func (iter *CachedImagesListResultIterator) 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. Deprecated: Use NextWithContext() instead.

func (*CachedImagesListResultIterator) NextWithContext 

func (iter *CachedImagesListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (CachedImagesListResultIterator) NotDone 

func (iter CachedImagesListResultIterator) NotDone() bool

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

func (CachedImagesListResultIterator) Response 

func (iter CachedImagesListResultIterator) Response() CachedImagesListResult

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

func (CachedImagesListResultIterator) Value 

func (iter CachedImagesListResultIterator) Value() CachedImages

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

type CachedImagesListResultPage 

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

CachedImagesListResultPage contains a page of CachedImages values.

func NewCachedImagesListResultPage 

func NewCachedImagesListResultPage(cur CachedImagesListResult, getNextPage func(context.Context, CachedImagesListResult) (CachedImagesListResult, error)) CachedImagesListResultPage

Creates a new instance of the CachedImagesListResultPage type.

func (*CachedImagesListResultPage) Next 

func (page *CachedImagesListResultPage) 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. Deprecated: Use NextWithContext() instead.

func (*CachedImagesListResultPage) NextWithContext 

func (page *CachedImagesListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (CachedImagesListResultPage) NotDone 

func (page CachedImagesListResultPage) NotDone() bool

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

func (CachedImagesListResultPage) Response 

func (page CachedImagesListResultPage) Response() CachedImagesListResult

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

func (CachedImagesListResultPage) Values 

func (page CachedImagesListResultPage) Values() []CachedImages

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

type Capabilities 

type Capabilities struct {
	// ResourceType - READ-ONLY; The resource type that this capability describes.
	ResourceType *string `json:"resourceType,omitempty"`
	// OsType - READ-ONLY; The OS type that this capability describes.
	OsType *string `json:"osType,omitempty"`
	// Location - READ-ONLY; The resource location.
	Location *string `json:"location,omitempty"`
	// IPAddressType - READ-ONLY; The ip address type that this capability describes.
	IPAddressType *string `json:"ipAddressType,omitempty"`
	// Gpu - READ-ONLY; The GPU sku that this capability describes.
	Gpu *string `json:"gpu,omitempty"`
	// Capabilities - READ-ONLY; The supported capabilities.
	Capabilities *CapabilitiesCapabilities `json:"capabilities,omitempty"`
}

Capabilities the regional capabilities.

func (Capabilities) MarshalJSON 

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

MarshalJSON is the custom marshaler for Capabilities.

type CapabilitiesCapabilities 

type CapabilitiesCapabilities struct {
	// MaxMemoryInGB - READ-ONLY; The maximum allowed memory request in GB.
	MaxMemoryInGB *float64 `json:"maxMemoryInGB,omitempty"`
	// MaxCPU - READ-ONLY; The maximum allowed CPU request in cores.
	MaxCPU *float64 `json:"maxCpu,omitempty"`
	// MaxGpuCount - READ-ONLY; The maximum allowed GPU count.
	MaxGpuCount *float64 `json:"maxGpuCount,omitempty"`
}

CapabilitiesCapabilities the supported capabilities.

func (CapabilitiesCapabilities) MarshalJSON 

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

MarshalJSON is the custom marshaler for CapabilitiesCapabilities.

type CapabilitiesListResult 

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

CapabilitiesListResult the response containing list of capabilities.

func (CapabilitiesListResult) IsEmpty 

func (clr CapabilitiesListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CapabilitiesListResultIterator 

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

CapabilitiesListResultIterator provides access to a complete listing of Capabilities values.

func NewCapabilitiesListResultIterator 

func NewCapabilitiesListResultIterator(page CapabilitiesListResultPage) CapabilitiesListResultIterator

Creates a new instance of the CapabilitiesListResultIterator type.

func (*CapabilitiesListResultIterator) Next 

func (iter *CapabilitiesListResultIterator) 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. Deprecated: Use NextWithContext() instead.

func (*CapabilitiesListResultIterator) NextWithContext 

func (iter *CapabilitiesListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (CapabilitiesListResultIterator) NotDone 

func (iter CapabilitiesListResultIterator) NotDone() bool

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

func (CapabilitiesListResultIterator) Response 

func (iter CapabilitiesListResultIterator) Response() CapabilitiesListResult

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

func (CapabilitiesListResultIterator) Value 

func (iter CapabilitiesListResultIterator) Value() Capabilities

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

type CapabilitiesListResultPage 

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

CapabilitiesListResultPage contains a page of Capabilities values.

func NewCapabilitiesListResultPage 

func NewCapabilitiesListResultPage(cur CapabilitiesListResult, getNextPage func(context.Context, CapabilitiesListResult) (CapabilitiesListResult, error)) CapabilitiesListResultPage

Creates a new instance of the CapabilitiesListResultPage type.

func (*CapabilitiesListResultPage) Next 

func (page *CapabilitiesListResultPage) 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. Deprecated: Use NextWithContext() instead.

func (*CapabilitiesListResultPage) NextWithContext 

func (page *CapabilitiesListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (CapabilitiesListResultPage) NotDone 

func (page CapabilitiesListResultPage) NotDone() bool

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

func (CapabilitiesListResultPage) Response 

func (page CapabilitiesListResultPage) Response() CapabilitiesListResult

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

func (CapabilitiesListResultPage) Values 

func (page CapabilitiesListResultPage) Values() []Capabilities

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

type CloudError 

type CloudError struct {
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError an error response from the Container Instance service.

type CloudErrorBody 

type CloudErrorBody struct {
	// Code - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`
	// Message - A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`
	// Target - The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
	// Details - A list of additional details about the error.
	Details *[]CloudErrorBody `json:"details,omitempty"`
}

CloudErrorBody an error response from the Container Instance service.

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 ContainerExec 

type ContainerExec struct {
	// Command - The commands to execute within the container.
	Command *[]string `json:"command,omitempty"`
}

ContainerExec the container execution command, for liveness or readiness probe

type ContainerExecRequest 

type ContainerExecRequest struct {
	// Command - The command to be executed.
	Command *string `json:"command,omitempty"`
	// TerminalSize - The size of the terminal.
	TerminalSize *ContainerExecRequestTerminalSize `json:"terminalSize,omitempty"`
}

ContainerExecRequest the container exec request.

type ContainerExecRequestTerminalSize 

type ContainerExecRequestTerminalSize struct {
	// Rows - The row size of the terminal
	Rows *int32 `json:"rows,omitempty"`
	// Cols - The column size of the terminal
	Cols *int32 `json:"cols,omitempty"`
}

ContainerExecRequestTerminalSize the size of the terminal.

type ContainerExecResponse 

type ContainerExecResponse struct {
	autorest.Response `json:"-"`
	// WebSocketURI - The uri for the exec websocket.
	WebSocketURI *string `json:"webSocketUri,omitempty"`
	// Password - The password to start the exec command.
	Password *string `json:"password,omitempty"`
}

ContainerExecResponse the information for the container exec command.

type ContainerGroup 

type ContainerGroup struct {
	autorest.Response `json:"-"`
	// Identity - The identity of the container group, if configured.
	Identity *ContainerGroupIdentity `json:"identity,omitempty"`
	// ContainerGroupProperties - The container group properties
	*ContainerGroupProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; The resource id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; 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 ContainerGroupDiagnostics 

type ContainerGroupDiagnostics struct {
	// LogAnalytics - Container group log analytics information.
	LogAnalytics *LogAnalytics `json:"logAnalytics,omitempty"`
}

ContainerGroupDiagnostics container group diagnostic information.

type ContainerGroupIPAddressType 

type ContainerGroupIPAddressType string

ContainerGroupIPAddressType enumerates the values for container group ip address type. 

const (
	// Private ...
	Private ContainerGroupIPAddressType = "Private"
	// Public ...
	Public ContainerGroupIPAddressType = "Public"
)

func PossibleContainerGroupIPAddressTypeValues 

func PossibleContainerGroupIPAddressTypeValues() []ContainerGroupIPAddressType

PossibleContainerGroupIPAddressTypeValues returns an array of possible values for the ContainerGroupIPAddressType const type.

type ContainerGroupIdentity 

type ContainerGroupIdentity struct {
	// PrincipalID - READ-ONLY; The principal id of the container group identity. This property will only be provided for a system assigned identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// TenantID - READ-ONLY; The tenant id associated with the container group. This property will only be provided for a system assigned identity.
	TenantID *string `json:"tenantId,omitempty"`
	// Type - The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssignedUserAssigned', 'None'
	Type ResourceIdentityType `json:"type,omitempty"`
	// UserAssignedIdentities - The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
	UserAssignedIdentities map[string]*ContainerGroupIdentityUserAssignedIdentitiesValue `json:"userAssignedIdentities"`
}

ContainerGroupIdentity identity for the container group.

func (ContainerGroupIdentity) MarshalJSON 

func (cgiVar ContainerGroupIdentity) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerGroupIdentity.

type ContainerGroupIdentityUserAssignedIdentitiesValue 

type ContainerGroupIdentityUserAssignedIdentitiesValue struct {
	// PrincipalID - READ-ONLY; The principal id of user assigned identity.
	PrincipalID *string `json:"principalId,omitempty"`
	// ClientID - READ-ONLY; The client id of user assigned identity.
	ClientID *string `json:"clientId,omitempty"`
}

ContainerGroupIdentityUserAssignedIdentitiesValue ...

func (ContainerGroupIdentityUserAssignedIdentitiesValue) MarshalJSON 

func (cgiAiv ContainerGroupIdentityUserAssignedIdentitiesValue) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerGroupIdentityUserAssignedIdentitiesValue.

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 NewContainerGroupListResultIterator 

func NewContainerGroupListResultIterator(page ContainerGroupListResultPage) ContainerGroupListResultIterator

Creates a new instance of the ContainerGroupListResultIterator type.

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. Deprecated: Use NextWithContext() instead.

func (*ContainerGroupListResultIterator) NextWithContext 

func (iter *ContainerGroupListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 NewContainerGroupListResultPage 

func NewContainerGroupListResultPage(cur ContainerGroupListResult, getNextPage func(context.Context, ContainerGroupListResult) (ContainerGroupListResult, error)) ContainerGroupListResultPage

Creates a new instance of the ContainerGroupListResultPage type.

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. Deprecated: Use NextWithContext() instead.

func (*ContainerGroupListResultPage) NextWithContext 

func (page *ContainerGroupListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 ContainerGroupNetworkProfile 

type ContainerGroupNetworkProfile struct {
	// ID - The identifier for a network profile.
	ID *string `json:"id,omitempty"`
}

ContainerGroupNetworkProfile container group network profile information.

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 - READ-ONLY; 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.
	// - `Always` Always restart
	// - `OnFailure` Restart on failure
	// - `Never` Never restart
	// . Possible values include: 'Always', 'OnFailure', 'Never'
	RestartPolicy ContainerGroupRestartPolicy `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"`
	// Volumes - The list of volumes that can be mounted by containers in this container group.
	Volumes *[]Volume `json:"volumes,omitempty"`
	// InstanceView - READ-ONLY; The instance view of the container group. Only valid in response.
	InstanceView *ContainerGroupPropertiesInstanceView `json:"instanceView,omitempty"`
	// Diagnostics - The diagnostic information for a container group.
	Diagnostics *ContainerGroupDiagnostics `json:"diagnostics,omitempty"`
	// NetworkProfile - The network profile information for a container group.
	NetworkProfile *ContainerGroupNetworkProfile `json:"networkProfile,omitempty"`
	// DNSConfig - The DNS config information for a container group.
	DNSConfig *DNSConfiguration `json:"dnsConfig,omitempty"`
	// Sku - The SKU for a container group. Possible values include: 'Standard', 'Dedicated'
	Sku ContainerGroupSku `json:"sku,omitempty"`
	// EncryptionProperties - The encryption properties for a container group.
	EncryptionProperties *EncryptionProperties `json:"encryptionProperties,omitempty"`
	// InitContainers - The init containers for a container group.
	InitContainers *[]InitContainerDefinition `json:"initContainers,omitempty"`
}

ContainerGroupProperties the container group properties

func (ContainerGroupProperties) MarshalJSON 

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

MarshalJSON is the custom marshaler for ContainerGroupProperties.

type ContainerGroupPropertiesInstanceView 

type ContainerGroupPropertiesInstanceView struct {
	// Events - READ-ONLY; The events of this container group.
	Events *[]Event `json:"events,omitempty"`
	// State - READ-ONLY; The state of the container group. Only valid in response.
	State *string `json:"state,omitempty"`
}

ContainerGroupPropertiesInstanceView the instance view of the container group. Only valid in response.

func (ContainerGroupPropertiesInstanceView) MarshalJSON 

func (cgV ContainerGroupPropertiesInstanceView) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerGroupPropertiesInstanceView.

type ContainerGroupRestartPolicy 

type ContainerGroupRestartPolicy string

ContainerGroupRestartPolicy enumerates the values for container group restart policy. 

const (
	// Always ...
	Always ContainerGroupRestartPolicy = "Always"
	// Never ...
	Never ContainerGroupRestartPolicy = "Never"
	// OnFailure ...
	OnFailure ContainerGroupRestartPolicy = "OnFailure"
)

func PossibleContainerGroupRestartPolicyValues 

func PossibleContainerGroupRestartPolicyValues() []ContainerGroupRestartPolicy

PossibleContainerGroupRestartPolicyValues returns an array of possible values for the ContainerGroupRestartPolicy const type.

type ContainerGroupSku 

type ContainerGroupSku string

ContainerGroupSku enumerates the values for container group sku. 

const (
	// Dedicated ...
	Dedicated ContainerGroupSku = "Dedicated"
	// Standard ...
	Standard ContainerGroupSku = "Standard"
)

func PossibleContainerGroupSkuValues 

func PossibleContainerGroupSkuValues() []ContainerGroupSku

PossibleContainerGroupSkuValues returns an array of possible values for the ContainerGroupSku const type.

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ContainerGroupsClient) CreateOrUpdate 

func (client ContainerGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, containerGroupName string, containerGroup ContainerGroup) (result ContainerGroupsCreateOrUpdateFuture, err error)

CreateOrUpdate create or update container groups with specified configurations. Parameters: resourceGroupName - the name of the resource group. containerGroupName - the name of the container group. 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) (future ContainerGroupsCreateOrUpdateFuture, err 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 ContainerGroupsDeleteFuture, 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. containerGroupName - the name of the container group.

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) (future ContainerGroupsDeleteFuture, err 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. 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.

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.

func (ContainerGroupsClient) Restart 

func (client ContainerGroupsClient) Restart(ctx context.Context, resourceGroupName string, containerGroupName string) (result ContainerGroupsRestartFuture, err error)

Restart restarts all containers in a container group in place. If container image has updates, new image will be downloaded. Parameters: resourceGroupName - the name of the resource group. containerGroupName - the name of the container group.

func (ContainerGroupsClient) RestartPreparer 

func (client ContainerGroupsClient) RestartPreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)

RestartPreparer prepares the Restart request.

func (ContainerGroupsClient) RestartResponder 

func (client ContainerGroupsClient) RestartResponder(resp *http.Response) (result autorest.Response, err error)

RestartResponder handles the response to the Restart request. The method always closes the http.Response Body.

func (ContainerGroupsClient) RestartSender 

func (client ContainerGroupsClient) RestartSender(req *http.Request) (future ContainerGroupsRestartFuture, err error)

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

func (ContainerGroupsClient) Start 

func (client ContainerGroupsClient) Start(ctx context.Context, resourceGroupName string, containerGroupName string) (result ContainerGroupsStartFuture, err error)

Start starts all containers in a container group. Compute resources will be allocated and billing will start. Parameters: resourceGroupName - the name of the resource group. containerGroupName - the name of the container group.

func (ContainerGroupsClient) StartPreparer 

func (client ContainerGroupsClient) StartPreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)

StartPreparer prepares the Start request.

func (ContainerGroupsClient) StartResponder 

func (client ContainerGroupsClient) StartResponder(resp *http.Response) (result autorest.Response, err error)

StartResponder handles the response to the Start request. The method always closes the http.Response Body.

func (ContainerGroupsClient) StartSender 

func (client ContainerGroupsClient) StartSender(req *http.Request) (future ContainerGroupsStartFuture, err error)

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

func (ContainerGroupsClient) Stop 

func (client ContainerGroupsClient) Stop(ctx context.Context, resourceGroupName string, containerGroupName string) (result autorest.Response, err error)

Stop stops all containers in a container group. Compute resources will be deallocated and billing will stop. Parameters: resourceGroupName - the name of the resource group. containerGroupName - the name of the container group.

func (ContainerGroupsClient) StopPreparer 

func (client ContainerGroupsClient) StopPreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)

StopPreparer prepares the Stop request.

func (ContainerGroupsClient) StopResponder 

func (client ContainerGroupsClient) StopResponder(resp *http.Response) (result autorest.Response, err error)

StopResponder handles the response to the Stop request. The method always closes the http.Response Body.

func (ContainerGroupsClient) StopSender 

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

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

func (ContainerGroupsClient) Update 

func (client ContainerGroupsClient) Update(ctx context.Context, resourceGroupName string, containerGroupName string, resource Resource) (result ContainerGroup, err error)

Update updates container group tags with specified values. Parameters: resourceGroupName - the name of the resource group. containerGroupName - the name of the container group. resource - the container group resource with just the tags to be updated.

func (ContainerGroupsClient) UpdatePreparer 

func (client ContainerGroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, containerGroupName string, resource Resource) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ContainerGroupsClient) UpdateResponder 

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

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ContainerGroupsClient) UpdateSender 

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

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

type ContainerGroupsCreateOrUpdateFuture 

type ContainerGroupsCreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ContainerGroupsClient) (ContainerGroup, error)
}

ContainerGroupsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ContainerGroupsCreateOrUpdateFuture) UnmarshalJSON 

func (future *ContainerGroupsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ContainerGroupsDeleteFuture 

type ContainerGroupsDeleteFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ContainerGroupsClient) (ContainerGroup, error)
}

ContainerGroupsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ContainerGroupsDeleteFuture) UnmarshalJSON 

func (future *ContainerGroupsDeleteFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ContainerGroupsRestartFuture 

type ContainerGroupsRestartFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ContainerGroupsClient) (autorest.Response, error)
}

ContainerGroupsRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ContainerGroupsRestartFuture) UnmarshalJSON 

func (future *ContainerGroupsRestartFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ContainerGroupsStartFuture 

type ContainerGroupsStartFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(ContainerGroupsClient) (autorest.Response, error)
}

ContainerGroupsStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*ContainerGroupsStartFuture) UnmarshalJSON 

func (future *ContainerGroupsStartFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type ContainerHTTPGet 

type ContainerHTTPGet struct {
	// Path - The path to probe.
	Path *string `json:"path,omitempty"`
	// Port - The port number to probe.
	Port *int32 `json:"port,omitempty"`
	// Scheme - The scheme. Possible values include: 'HTTP', 'HTTPS'
	Scheme Scheme `json:"scheme,omitempty"`
}

ContainerHTTPGet the container Http Get settings, for liveness or readiness probe

type ContainerNetworkProtocol 

type ContainerNetworkProtocol string

ContainerNetworkProtocol enumerates the values for container network protocol. 

const (
	// ContainerNetworkProtocolTCP ...
	ContainerNetworkProtocolTCP ContainerNetworkProtocol = "TCP"
	// ContainerNetworkProtocolUDP ...
	ContainerNetworkProtocolUDP ContainerNetworkProtocol = "UDP"
)

func PossibleContainerNetworkProtocolValues 

func PossibleContainerNetworkProtocolValues() []ContainerNetworkProtocol

PossibleContainerNetworkProtocolValues returns an array of possible values for the ContainerNetworkProtocol const type.

type ContainerPort 

type ContainerPort struct {
	// Protocol - The protocol associated with the port. Possible values include: 'ContainerNetworkProtocolTCP', 'ContainerNetworkProtocolUDP'
	Protocol ContainerNetworkProtocol `json:"protocol,omitempty"`
	// Port - The port number exposed within the container group.
	Port *int32 `json:"port,omitempty"`
}

ContainerPort the port exposed on the container instance.

type ContainerProbe 

type ContainerProbe struct {
	// Exec - The execution command to probe
	Exec *ContainerExec `json:"exec,omitempty"`
	// HTTPGet - The Http Get settings to probe
	HTTPGet *ContainerHTTPGet `json:"httpGet,omitempty"`
	// InitialDelaySeconds - The initial delay seconds.
	InitialDelaySeconds *int32 `json:"initialDelaySeconds,omitempty"`
	// PeriodSeconds - The period seconds.
	PeriodSeconds *int32 `json:"periodSeconds,omitempty"`
	// FailureThreshold - The failure threshold.
	FailureThreshold *int32 `json:"failureThreshold,omitempty"`
	// SuccessThreshold - The success threshold.
	SuccessThreshold *int32 `json:"successThreshold,omitempty"`
	// TimeoutSeconds - The timeout seconds.
	TimeoutSeconds *int32 `json:"timeoutSeconds,omitempty"`
}

ContainerProbe the container probe, for liveness or readiness

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 - READ-ONLY; 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"`
	// LivenessProbe - The liveness probe.
	LivenessProbe *ContainerProbe `json:"livenessProbe,omitempty"`
	// ReadinessProbe - The readiness probe.
	ReadinessProbe *ContainerProbe `json:"readinessProbe,omitempty"`
}

ContainerProperties the container instance properties.

func (ContainerProperties) MarshalJSON 

func (cp ContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerProperties.

type ContainerPropertiesInstanceView 

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

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

func (ContainerPropertiesInstanceView) MarshalJSON 

func (cpV ContainerPropertiesInstanceView) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerPropertiesInstanceView.

type ContainerState 

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

ContainerState the container instance state.

func (ContainerState) MarshalJSON 

func (cs ContainerState) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ContainerState.

type ContainersClient 

type ContainersClient struct {
	BaseClient
}

ContainersClient is the client for the Containers methods of the Containerinstance service.

func NewContainersClient 

func NewContainersClient(subscriptionID string) ContainersClient

NewContainersClient creates an instance of the ContainersClient client.

func NewContainersClientWithBaseURI 

func NewContainersClientWithBaseURI(baseURI string, subscriptionID string) ContainersClient

NewContainersClientWithBaseURI creates an instance of the ContainersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ContainersClient) ExecuteCommand 

func (client ContainersClient) ExecuteCommand(ctx context.Context, resourceGroupName string, containerGroupName string, containerName string, containerExecRequest ContainerExecRequest) (result ContainerExecResponse, err error)

ExecuteCommand executes a command for a specific container instance in a specified resource group and container group. Parameters: resourceGroupName - the name of the resource group. containerGroupName - the name of the container group. containerName - the name of the container instance. containerExecRequest - the request for the exec command.

func (ContainersClient) ExecuteCommandPreparer 

func (client ContainersClient) ExecuteCommandPreparer(ctx context.Context, resourceGroupName string, containerGroupName string, containerName string, containerExecRequest ContainerExecRequest) (*http.Request, error)

ExecuteCommandPreparer prepares the ExecuteCommand request.

func (ContainersClient) ExecuteCommandResponder 

func (client ContainersClient) ExecuteCommandResponder(resp *http.Response) (result ContainerExecResponse, err error)

ExecuteCommandResponder handles the response to the ExecuteCommand request. The method always closes the http.Response Body.

func (ContainersClient) ExecuteCommandSender 

func (client ContainersClient) ExecuteCommandSender(req *http.Request) (*http.Response, error)

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

func (ContainersClient) ListLogs 

func (client ContainersClient) ListLogs(ctx context.Context, resourceGroupName string, containerGroupName string, containerName string, tail *int32) (result Logs, err error)

ListLogs get the logs for a specified container instance in a specified resource group and container group. Parameters: resourceGroupName - the name of the resource group. containerGroupName - the name of the container group. containerName - the name of the container instance. 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 (ContainersClient) ListLogsPreparer 

func (client ContainersClient) ListLogsPreparer(ctx context.Context, resourceGroupName string, containerGroupName string, containerName string, tail *int32) (*http.Request, error)

ListLogsPreparer prepares the ListLogs request.

func (ContainersClient) ListLogsResponder 

func (client ContainersClient) ListLogsResponder(resp *http.Response) (result Logs, err error)

ListLogsResponder handles the response to the ListLogs request. The method always closes the http.Response Body.

func (ContainersClient) ListLogsSender 

func (client ContainersClient) ListLogsSender(req *http.Request) (*http.Response, error)

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

type DNSConfiguration 

type DNSConfiguration struct {
	// NameServers - The DNS servers for the container group.
	NameServers *[]string `json:"nameServers,omitempty"`
	// SearchDomains - The DNS search domains for hostname lookup in the container group.
	SearchDomains *string `json:"searchDomains,omitempty"`
	// Options - The DNS options for the container group.
	Options *string `json:"options,omitempty"`
}

DNSConfiguration DNS configuration for the container group.

type EncryptionProperties 

type EncryptionProperties struct {
	// VaultBaseURL - The keyvault base url.
	VaultBaseURL *string `json:"vaultBaseUrl,omitempty"`
	// KeyName - The encryption key name.
	KeyName *string `json:"keyName,omitempty"`
	// KeyVersion - The encryption key version.
	KeyVersion *string `json:"keyVersion,omitempty"`
}

EncryptionProperties the container group encryption properties.

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"`
	// SecureValue - The value of the secure environment variable.
	SecureValue *string `json:"secureValue,omitempty"`
}

EnvironmentVariable the environment variable to set within the container instance.

type Event 

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

Event a container group or container instance event.

func (Event) MarshalJSON 

func (e Event) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Event.

type GitRepoVolume 

type GitRepoVolume struct {
	// Directory - Target directory name. Must not contain or start with '..'.  If '.' is supplied, the volume directory will be the git repository.  Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.
	Directory *string `json:"directory,omitempty"`
	// Repository - Repository URL
	Repository *string `json:"repository,omitempty"`
	// Revision - Commit hash for the specified revision.
	Revision *string `json:"revision,omitempty"`
}

GitRepoVolume represents a volume that is populated with the contents of a git repository

type GpuResource 

type GpuResource struct {
	// Count - The count of the GPU resource.
	Count *int32 `json:"count,omitempty"`
	// Sku - The SKU of the GPU resource. Possible values include: 'K80', 'P100', 'V100'
	Sku GpuSku `json:"sku,omitempty"`
}

GpuResource the GPU resource.

type GpuSku 

type GpuSku string

GpuSku enumerates the values for gpu sku. 

const (
	// K80 ...
	K80 GpuSku = "K80"
	// P100 ...
	P100 GpuSku = "P100"
	// V100 ...
	V100 GpuSku = "V100"
)

func PossibleGpuSkuValues 

func PossibleGpuSkuValues() []GpuSku

PossibleGpuSkuValues returns an array of possible values for the GpuSku const type.

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 or private VNET. Possible values include: 'Public', 'Private'
	Type ContainerGroupIPAddressType `json:"type,omitempty"`
	// IP - The IP exposed to the public internet.
	IP *string `json:"ip,omitempty"`
	// DNSNameLabel - The Dns name label for the IP.
	DNSNameLabel *string `json:"dnsNameLabel,omitempty"`
	// Fqdn - READ-ONLY; The FQDN for the IP.
	Fqdn *string `json:"fqdn,omitempty"`
}

IPAddress IP address for the container group.

func (IPAddress) MarshalJSON 

func (ia IPAddress) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for IPAddress.

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 InitContainerDefinition 

type InitContainerDefinition struct {
	// Name - The name for the init container.
	Name *string `json:"name,omitempty"`
	// InitContainerPropertiesDefinition - The properties for the init container.
	*InitContainerPropertiesDefinition `json:"properties,omitempty"`
}

InitContainerDefinition the init container definition.

func (InitContainerDefinition) MarshalJSON 

func (icd InitContainerDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for InitContainerDefinition.

func (*InitContainerDefinition) UnmarshalJSON 

func (icd *InitContainerDefinition) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for InitContainerDefinition struct.

type InitContainerPropertiesDefinition 

type InitContainerPropertiesDefinition struct {
	// Image - The image of the init container.
	Image *string `json:"image,omitempty"`
	// Command - The command to execute within the init container in exec form.
	Command *[]string `json:"command,omitempty"`
	// EnvironmentVariables - The environment variables to set in the init container.
	EnvironmentVariables *[]EnvironmentVariable `json:"environmentVariables,omitempty"`
	// InstanceView - READ-ONLY; The instance view of the init container. Only valid in response.
	InstanceView *InitContainerPropertiesDefinitionInstanceView `json:"instanceView,omitempty"`
	// VolumeMounts - The volume mounts available to the init container.
	VolumeMounts *[]VolumeMount `json:"volumeMounts,omitempty"`
}

InitContainerPropertiesDefinition the init container definition properties.

func (InitContainerPropertiesDefinition) MarshalJSON 

func (icpd InitContainerPropertiesDefinition) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for InitContainerPropertiesDefinition.

type InitContainerPropertiesDefinitionInstanceView 

type InitContainerPropertiesDefinitionInstanceView struct {
	// RestartCount - READ-ONLY; The number of times that the init container has been restarted.
	RestartCount *int32 `json:"restartCount,omitempty"`
	// CurrentState - READ-ONLY; The current state of the init container.
	CurrentState *ContainerState `json:"currentState,omitempty"`
	// PreviousState - READ-ONLY; The previous state of the init container.
	PreviousState *ContainerState `json:"previousState,omitempty"`
	// Events - READ-ONLY; The events of the init container.
	Events *[]Event `json:"events,omitempty"`
}

InitContainerPropertiesDefinitionInstanceView the instance view of the init container. Only valid in response.

func (InitContainerPropertiesDefinitionInstanceView) MarshalJSON 

func (icpdV InitContainerPropertiesDefinitionInstanceView) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for InitContainerPropertiesDefinitionInstanceView.

type LocationClient 

type LocationClient struct {
	BaseClient
}

LocationClient is the client for the Location methods of the Containerinstance service.

func NewLocationClient 

func NewLocationClient(subscriptionID string) LocationClient

NewLocationClient creates an instance of the LocationClient client.

func NewLocationClientWithBaseURI 

func NewLocationClientWithBaseURI(baseURI string, subscriptionID string) LocationClient

NewLocationClientWithBaseURI creates an instance of the LocationClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (LocationClient) ListCachedImages 

func (client LocationClient) ListCachedImages(ctx context.Context, location string) (result CachedImagesListResultPage, err error)

ListCachedImages get the list of cached images on specific OS type for a subscription in a region. Parameters: location - the identifier for the physical azure location.

func (LocationClient) ListCachedImagesComplete 

func (client LocationClient) ListCachedImagesComplete(ctx context.Context, location string) (result CachedImagesListResultIterator, err error)

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

func (LocationClient) ListCachedImagesPreparer 

func (client LocationClient) ListCachedImagesPreparer(ctx context.Context, location string) (*http.Request, error)

ListCachedImagesPreparer prepares the ListCachedImages request.

func (LocationClient) ListCachedImagesResponder 

func (client LocationClient) ListCachedImagesResponder(resp *http.Response) (result CachedImagesListResult, err error)

ListCachedImagesResponder handles the response to the ListCachedImages request. The method always closes the http.Response Body.

func (LocationClient) ListCachedImagesSender 

func (client LocationClient) ListCachedImagesSender(req *http.Request) (*http.Response, error)

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

func (LocationClient) ListCapabilities 

func (client LocationClient) ListCapabilities(ctx context.Context, location string) (result CapabilitiesListResultPage, err error)

ListCapabilities get the list of CPU/memory/GPU capabilities of a region. Parameters: location - the identifier for the physical azure location.

func (LocationClient) ListCapabilitiesComplete 

func (client LocationClient) ListCapabilitiesComplete(ctx context.Context, location string) (result CapabilitiesListResultIterator, err error)

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

func (LocationClient) ListCapabilitiesPreparer 

func (client LocationClient) ListCapabilitiesPreparer(ctx context.Context, location string) (*http.Request, error)

ListCapabilitiesPreparer prepares the ListCapabilities request.

func (LocationClient) ListCapabilitiesResponder 

func (client LocationClient) ListCapabilitiesResponder(resp *http.Response) (result CapabilitiesListResult, err error)

ListCapabilitiesResponder handles the response to the ListCapabilities request. The method always closes the http.Response Body.

func (LocationClient) ListCapabilitiesSender 

func (client LocationClient) ListCapabilitiesSender(req *http.Request) (*http.Response, error)

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

func (LocationClient) ListUsage 

func (client LocationClient) ListUsage(ctx context.Context, location string) (result UsageListResult, err error)

ListUsage get the usage for a subscription Parameters: location - the identifier for the physical azure location.

func (LocationClient) ListUsagePreparer 

func (client LocationClient) ListUsagePreparer(ctx context.Context, location string) (*http.Request, error)

ListUsagePreparer prepares the ListUsage request.

func (LocationClient) ListUsageResponder 

func (client LocationClient) ListUsageResponder(resp *http.Response) (result UsageListResult, err error)

ListUsageResponder handles the response to the ListUsage request. The method always closes the http.Response Body.

func (LocationClient) ListUsageSender 

func (client LocationClient) ListUsageSender(req *http.Request) (*http.Response, error)

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

type LogAnalytics 

type LogAnalytics struct {
	// WorkspaceID - The workspace id for log analytics
	WorkspaceID *string `json:"workspaceId,omitempty"`
	// WorkspaceKey - The workspace key for log analytics
	WorkspaceKey *string `json:"workspaceKey,omitempty"`
	// LogType - The log type to be used. Possible values include: 'ContainerInsights', 'ContainerInstanceLogs'
	LogType LogAnalyticsLogType `json:"logType,omitempty"`
	// Metadata - Metadata for log analytics.
	Metadata map[string]*string `json:"metadata"`
}

LogAnalytics container group log analytics information.

func (LogAnalytics) MarshalJSON 

func (la LogAnalytics) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LogAnalytics.

type LogAnalyticsLogType 

type LogAnalyticsLogType string

LogAnalyticsLogType enumerates the values for log analytics log type. 

const (
	// ContainerInsights ...
	ContainerInsights LogAnalyticsLogType = "ContainerInsights"
	// ContainerInstanceLogs ...
	ContainerInstanceLogs LogAnalyticsLogType = "ContainerInstanceLogs"
)

func PossibleLogAnalyticsLogTypeValues 

func PossibleLogAnalyticsLogTypeValues() []LogAnalyticsLogType

PossibleLogAnalyticsLogTypeValues returns an array of possible values for the LogAnalyticsLogType const type.

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 Operation 

type Operation struct {
	// Name - The name of the operation.
	Name *string `json:"name,omitempty"`
	// Display - The display information of the operation.
	Display *OperationDisplay `json:"display,omitempty"`
	// Properties - The additional properties.
	Properties interface{} `json:"properties,omitempty"`
	// Origin - The intended executor of the operation. Possible values include: 'User', 'System'
	Origin OperationsOrigin `json:"origin,omitempty"`
}

Operation an operation for Azure Container Instance service.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - The name of the provider of the operation.
	Provider *string `json:"provider,omitempty"`
	// Resource - The name of the resource type of the operation.
	Resource *string `json:"resource,omitempty"`
	// Operation - The friendly name of the operation.
	Operation *string `json:"operation,omitempty"`
	// Description - The description of the operation.
	Description *string `json:"description,omitempty"`
}

OperationDisplay the display information of the operation.

type OperationListResult 

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

OperationListResult the operation list response that contains all operations for Azure Container Instance service.

func (OperationListResult) IsEmpty 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func NewOperationListResultIterator 

func NewOperationListResultIterator(page OperationListResultPage) OperationListResultIterator

Creates a new instance of the OperationListResultIterator type.

func (*OperationListResultIterator) Next 

func (iter *OperationListResultIterator) 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. Deprecated: Use NextWithContext() instead.

func (*OperationListResultIterator) NextWithContext 

func (iter *OperationListResultIterator) NextWithContext(ctx context.Context) (err error)

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

func (OperationListResultIterator) NotDone 

func (iter OperationListResultIterator) NotDone() bool

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

func (OperationListResultIterator) Response 

func (iter OperationListResultIterator) Response() OperationListResult

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

func (OperationListResultIterator) Value 

func (iter OperationListResultIterator) Value() Operation

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

type OperationListResultPage 

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

OperationListResultPage contains a page of Operation values.

func NewOperationListResultPage 

func NewOperationListResultPage(cur OperationListResult, getNextPage func(context.Context, OperationListResult) (OperationListResult, error)) OperationListResultPage

Creates a new instance of the OperationListResultPage type.

func (*OperationListResultPage) Next 

func (page *OperationListResultPage) 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. Deprecated: Use NextWithContext() instead.

func (*OperationListResultPage) NextWithContext 

func (page *OperationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext 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 (OperationListResultPage) NotDone 

func (page OperationListResultPage) NotDone() bool

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

func (OperationListResultPage) Response 

func (page OperationListResultPage) Response() OperationListResult

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

func (OperationListResultPage) Values 

func (page OperationListResultPage) Values() []Operation

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

type OperationsClient 

type OperationsClient struct {
	BaseClient
}

OperationsClient is the client for the Operations methods of the Containerinstance service.

func NewOperationsClient 

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI 

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List 

func (client OperationsClient) List(ctx context.Context) (result OperationListResultPage, err error)

List list the operations for Azure Container Instance service.

func (OperationsClient) ListComplete 

func (client OperationsClient) ListComplete(ctx context.Context) (result OperationListResultIterator, err error)

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

func (OperationsClient) ListPreparer 

func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationsClient) ListResponder 

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender 

func (client OperationsClient) 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 OperationsOrigin 

type OperationsOrigin string

OperationsOrigin enumerates the values for operations origin. 

const (
	// System ...
	System OperationsOrigin = "System"
	// User ...
	User OperationsOrigin = "User"
)

func PossibleOperationsOriginValues 

func PossibleOperationsOriginValues() []OperationsOrigin

PossibleOperationsOriginValues returns an array of possible values for the OperationsOrigin 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 - READ-ONLY; The resource id.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; 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 ResourceIdentityType 

type ResourceIdentityType string

ResourceIdentityType enumerates the values for resource identity type. 

const (
	// None ...
	None ResourceIdentityType = "None"
	// SystemAssigned ...
	SystemAssigned ResourceIdentityType = "SystemAssigned"
	// SystemAssignedUserAssigned ...
	SystemAssignedUserAssigned ResourceIdentityType = "SystemAssigned, UserAssigned"
	// UserAssigned ...
	UserAssigned ResourceIdentityType = "UserAssigned"
)

func PossibleResourceIdentityTypeValues 

func PossibleResourceIdentityTypeValues() []ResourceIdentityType

PossibleResourceIdentityTypeValues returns an array of possible values for the ResourceIdentityType const type.

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"`
	// Gpu - The GPU limit of this container instance.
	Gpu *GpuResource `json:"gpu,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"`
	// Gpu - The GPU request of this container instance.
	Gpu *GpuResource `json:"gpu,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 Scheme 

type Scheme string

Scheme enumerates the values for scheme. 

const (
	// HTTP ...
	HTTP Scheme = "http"
	// HTTPS ...
	HTTPS Scheme = "https"
)

func PossibleSchemeValues 

func PossibleSchemeValues() []Scheme

PossibleSchemeValues returns an array of possible values for the Scheme const type.

type Usage 

type Usage struct {
	// Unit - READ-ONLY; Unit of the usage result
	Unit *string `json:"unit,omitempty"`
	// CurrentValue - READ-ONLY; The current usage of the resource
	CurrentValue *int32 `json:"currentValue,omitempty"`
	// Limit - READ-ONLY; The maximum permitted usage of the resource.
	Limit *int32 `json:"limit,omitempty"`
	// Name - READ-ONLY; The name object of the resource
	Name *UsageName `json:"name,omitempty"`
}

Usage a single usage result

func (Usage) MarshalJSON 

func (u Usage) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Usage.

type UsageListResult 

type UsageListResult struct {
	autorest.Response `json:"-"`
	// Value - READ-ONLY; The usage data.
	Value *[]Usage `json:"value,omitempty"`
}

UsageListResult the response containing the usage data

func (UsageListResult) MarshalJSON 

func (ulr UsageListResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UsageListResult.

type UsageName 

type UsageName struct {
	// Value - READ-ONLY; The name of the resource
	Value *string `json:"value,omitempty"`
	// LocalizedValue - READ-ONLY; The localized name of the resource
	LocalizedValue *string `json:"localizedValue,omitempty"`
}

UsageName the name object of the resource

func (UsageName) MarshalJSON 

func (u UsageName) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UsageName.

type Volume 

type Volume struct {
	// Name - The name of the volume.
	Name *string `json:"name,omitempty"`
	// AzureFile - The Azure File volume.
	AzureFile *AzureFileVolume `json:"azureFile,omitempty"`
	// EmptyDir - The empty directory volume.
	EmptyDir interface{} `json:"emptyDir,omitempty"`
	// Secret - The secret volume.
	Secret map[string]*string `json:"secret"`
	// GitRepo - The git repo volume.
	GitRepo *GitRepoVolume `json:"gitRepo,omitempty"`
}

Volume the properties of the volume.

func (Volume) MarshalJSON 

func (vVar Volume) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for 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

Directories

Path Synopsis
Deprecated: Please note, this package has been deprecated.
 Deprecated: Please note, this package has been deprecated.

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.