...

Package containerinstance

import "github.com/Azure/azure-sdk-for-go/services/preview/containerinstance/mgmt/2017-10-01-preview/containerinstance"
Overview
Index
Subdirectories

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 2017-10-01-preview.

Index ▾

Constants
func UserAgent() string
func Version() string
type AzureFileVolume
type BaseClient
    func New(subscriptionID string) BaseClient
    func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient
type Container
    func (c Container) MarshalJSON() ([]byte, error)
    func (c *Container) UnmarshalJSON(body []byte) error
type ContainerGroup
    func (cg ContainerGroup) MarshalJSON() ([]byte, error)
    func (cg *ContainerGroup) UnmarshalJSON(body []byte) error
type ContainerGroupListResult
    func (cglr ContainerGroupListResult) IsEmpty() bool
type ContainerGroupListResultIterator
    func NewContainerGroupListResultIterator(page ContainerGroupListResultPage) ContainerGroupListResultIterator
    func (iter *ContainerGroupListResultIterator) Next() error
    func (iter *ContainerGroupListResultIterator) NextWithContext(ctx context.Context) (err error)
    func (iter ContainerGroupListResultIterator) NotDone() bool
    func (iter ContainerGroupListResultIterator) Response() ContainerGroupListResult
    func (iter ContainerGroupListResultIterator) Value() ContainerGroup
type ContainerGroupListResultPage
    func NewContainerGroupListResultPage(cur ContainerGroupListResult, getNextPage func(context.Context, ContainerGroupListResult) (ContainerGroupListResult, error)) ContainerGroupListResultPage
    func (page *ContainerGroupListResultPage) Next() error
    func (page *ContainerGroupListResultPage) NextWithContext(ctx context.Context) (err error)
    func (page ContainerGroupListResultPage) NotDone() bool
    func (page ContainerGroupListResultPage) Response() ContainerGroupListResult
    func (page ContainerGroupListResultPage) Values() []ContainerGroup
type ContainerGroupNetworkProtocol
    func PossibleContainerGroupNetworkProtocolValues() []ContainerGroupNetworkProtocol
type ContainerGroupProperties
    func (cg ContainerGroupProperties) MarshalJSON() ([]byte, error)
type ContainerGroupPropertiesInstanceView
    func (cgV ContainerGroupPropertiesInstanceView) MarshalJSON() ([]byte, error)
type ContainerGroupRestartPolicy
    func PossibleContainerGroupRestartPolicyValues() []ContainerGroupRestartPolicy
type ContainerGroupsClient
    func NewContainerGroupsClient(subscriptionID string) ContainerGroupsClient
    func NewContainerGroupsClientWithBaseURI(baseURI string, subscriptionID string) ContainerGroupsClient
    func (client ContainerGroupsClient) CreateOrUpdate(ctx context.Context, resourceGroupName string, containerGroupName string, containerGroup ContainerGroup) (result ContainerGroup, err error)
    func (client ContainerGroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, containerGroupName string, containerGroup ContainerGroup) (*http.Request, error)
    func (client ContainerGroupsClient) CreateOrUpdateResponder(resp *http.Response) (result ContainerGroup, err error)
    func (client ContainerGroupsClient) CreateOrUpdateSender(req *http.Request) (*http.Response, error)
    func (client ContainerGroupsClient) Delete(ctx context.Context, resourceGroupName string, containerGroupName string) (result ContainerGroup, err error)
    func (client ContainerGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)
    func (client ContainerGroupsClient) DeleteResponder(resp *http.Response) (result ContainerGroup, err error)
    func (client ContainerGroupsClient) DeleteSender(req *http.Request) (*http.Response, error)
    func (client ContainerGroupsClient) Get(ctx context.Context, resourceGroupName string, containerGroupName string) (result ContainerGroup, err error)
    func (client ContainerGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)
    func (client ContainerGroupsClient) GetResponder(resp *http.Response) (result ContainerGroup, err error)
    func (client ContainerGroupsClient) GetSender(req *http.Request) (*http.Response, error)
    func (client ContainerGroupsClient) List(ctx context.Context) (result ContainerGroupListResultPage, err error)
    func (client ContainerGroupsClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ContainerGroupListResultPage, err error)
    func (client ContainerGroupsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ContainerGroupListResultIterator, err error)
    func (client ContainerGroupsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
    func (client ContainerGroupsClient) ListByResourceGroupResponder(resp *http.Response) (result ContainerGroupListResult, err error)
    func (client ContainerGroupsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)
    func (client ContainerGroupsClient) ListComplete(ctx context.Context) (result ContainerGroupListResultIterator, err error)
    func (client ContainerGroupsClient) ListPreparer(ctx context.Context) (*http.Request, error)
    func (client ContainerGroupsClient) ListResponder(resp *http.Response) (result ContainerGroupListResult, err error)
    func (client ContainerGroupsClient) ListSender(req *http.Request) (*http.Response, error)
type ContainerLogsClient
    func NewContainerLogsClient(subscriptionID string) ContainerLogsClient
    func NewContainerLogsClientWithBaseURI(baseURI string, subscriptionID string) ContainerLogsClient
    func (client ContainerLogsClient) List(ctx context.Context, resourceGroupName string, containerGroupName string, containerName string, tail *int32) (result Logs, err error)
    func (client ContainerLogsClient) ListPreparer(ctx context.Context, resourceGroupName string, containerGroupName string, containerName string, tail *int32) (*http.Request, error)
    func (client ContainerLogsClient) ListResponder(resp *http.Response) (result Logs, err error)
    func (client ContainerLogsClient) ListSender(req *http.Request) (*http.Response, error)
type ContainerNetworkProtocol
    func PossibleContainerNetworkProtocolValues() []ContainerNetworkProtocol
type ContainerPort
type ContainerProperties
    func (cp ContainerProperties) MarshalJSON() ([]byte, error)
type ContainerPropertiesInstanceView
    func (cpV ContainerPropertiesInstanceView) MarshalJSON() ([]byte, error)
type ContainerState
type EnvironmentVariable
type Event
type IPAddress
type ImageRegistryCredential
type Logs
type OperatingSystemTypes
    func PossibleOperatingSystemTypesValues() []OperatingSystemTypes
type Operation
type OperationDisplay
type OperationListResult
type OperationsClient
    func NewOperationsClient(subscriptionID string) OperationsClient
    func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient
    func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
    func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
    func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)
    func (client OperationsClient) ListSender(req *http.Request) (*http.Response, error)
type OperationsOrigin
    func PossibleOperationsOriginValues() []OperationsOrigin
type Port
type Resource
    func (r Resource) MarshalJSON() ([]byte, error)
type ResourceLimits
type ResourceRequests
type ResourceRequirements
type Volume
type VolumeMount

Package files

client.go containergroups.go containerlogs.go enums.go models.go operations.go version.go

Constants

const (
    // DefaultBaseURI is the default URI used for the service Containerinstance
    DefaultBaseURI = "https://management.azure.com"
)

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.

type AzureFileVolume

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

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"`
}

type BaseClient

BaseClient is the base client for Containerinstance.

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

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 Container

Container a container instance.

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"`
}

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 ContainerGroup

ContainerGroup a container group.

type ContainerGroup struct {
    autorest.Response         `json:"-"`
    *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"`
}

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

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

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"`
}

func (ContainerGroupListResult) IsEmpty

func (cglr ContainerGroupListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ContainerGroupListResultIterator

ContainerGroupListResultIterator provides access to a complete listing of ContainerGroup values.

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

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

ContainerGroupListResultPage contains a page of ContainerGroup values.

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

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 ContainerGroupNetworkProtocol

ContainerGroupNetworkProtocol enumerates the values for container group network protocol.

type ContainerGroupNetworkProtocol string
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

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"`
}

func (ContainerGroupProperties) MarshalJSON

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

MarshalJSON is the custom marshaler for ContainerGroupProperties.

type ContainerGroupPropertiesInstanceView

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

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"`
}

func (ContainerGroupPropertiesInstanceView) MarshalJSON

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

MarshalJSON is the custom marshaler for ContainerGroupPropertiesInstanceView.

type ContainerGroupRestartPolicy

ContainerGroupRestartPolicy enumerates the values for container group restart policy.

type ContainerGroupRestartPolicy string
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 ContainerGroupsClient

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

type ContainerGroupsClient struct {
    BaseClient
}

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 ContainerGroup, 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) (*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. 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) (*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. 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.

type ContainerLogsClient

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

type ContainerLogsClient struct {
    BaseClient
}

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

func (ContainerLogsClient) List

func (client ContainerLogsClient) List(ctx context.Context, resourceGroupName string, containerGroupName string, containerName 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. 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 (ContainerLogsClient) ListPreparer

func (client ContainerLogsClient) ListPreparer(ctx context.Context, resourceGroupName string, containerGroupName string, containerName 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 ContainerNetworkProtocol

ContainerNetworkProtocol enumerates the values for container network protocol.

type ContainerNetworkProtocol string
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

ContainerPort the port exposed on the container instance.

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"`
}

type ContainerProperties

ContainerProperties the container instance properties.

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"`
}

func (ContainerProperties) MarshalJSON

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

MarshalJSON is the custom marshaler for ContainerProperties.

type ContainerPropertiesInstanceView

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

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"`
}

func (ContainerPropertiesInstanceView) MarshalJSON

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

MarshalJSON is the custom marshaler for ContainerPropertiesInstanceView.

type ContainerState

ContainerState the container instance state.

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"`
}

type EnvironmentVariable

EnvironmentVariable the environment variable to set within the container instance.

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"`
}

type Event

Event a container group or container instance event.

type Event 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"`
    // Name - The event name.
    Name *string `json:"name,omitempty"`
    // Message - The event message.
    Message *string `json:"message,omitempty"`
    // Type - The event type.
    Type *string `json:"type,omitempty"`
}

type IPAddress

IPAddress IP address for the container group.

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"`
}

type ImageRegistryCredential

ImageRegistryCredential image registry credential.

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"`
}

type Logs

Logs the logs.

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

type OperatingSystemTypes

OperatingSystemTypes enumerates the values for operating system types.

type OperatingSystemTypes string
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

Operation an operation for Azure Container Instance service.

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"`
    // Origin - The intended executor of the operation. Possible values include: 'User', 'System'
    Origin OperationsOrigin `json:"origin,omitempty"`
}

type OperationDisplay

OperationDisplay the display information of the operation.

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"`
}

type OperationListResult

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

type OperationListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of operations.
    Value *[]Operation `json:"value,omitempty"`
}

type OperationsClient

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

type OperationsClient struct {
    BaseClient
}

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 OperationListResult, err error)

List list the operations for Azure Container Instance service.

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

OperationsOrigin enumerates the values for operations origin.

type OperationsOrigin string
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

Port the port exposed on the container group.

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"`
}

type Resource

Resource the Resource model definition.

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"`
}

func (Resource) MarshalJSON

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

MarshalJSON is the custom marshaler for Resource.

type ResourceLimits

ResourceLimits the resource limits.

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"`
}

type ResourceRequests

ResourceRequests the resource requests.

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"`
}

type ResourceRequirements

ResourceRequirements the resource requirements.

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"`
}

type Volume

Volume the properties of the 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"`
    // EmptyDir - The empty directory volume.
    EmptyDir interface{} `json:"emptyDir,omitempty"`
}

type VolumeMount

VolumeMount the properties of the volume mount.

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"`
}

Subdirectories

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