const (
// DefaultBaseURI is the default URI used for the service Containerinstance
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
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"`
}
BaseClient is the base client for Containerinstance.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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).
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 (c Container) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Container.
func (c *Container) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Container struct.
ContainerClient is the client for the Container methods of the Containerinstance service.
type ContainerClient struct {
BaseClient
}
func NewContainerClient(subscriptionID string) ContainerClient
NewContainerClient creates an instance of the ContainerClient client.
func NewContainerClientWithBaseURI(baseURI string, subscriptionID string) ContainerClient
NewContainerClientWithBaseURI creates an instance of the ContainerClient 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 (client ContainerClient) 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 (client ContainerClient) ExecuteCommandPreparer(ctx context.Context, resourceGroupName string, containerGroupName string, containerName string, containerExecRequest ContainerExecRequest) (*http.Request, error)
ExecuteCommandPreparer prepares the ExecuteCommand request.
func (client ContainerClient) 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 (client ContainerClient) 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 (client ContainerClient) 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 (client ContainerClient) ListLogsPreparer(ctx context.Context, resourceGroupName string, containerGroupName string, containerName string, tail *int32) (*http.Request, error)
ListLogsPreparer prepares the ListLogs request.
func (client ContainerClient) 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 (client ContainerClient) 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.
ContainerExec the container execution command, for liveness or readiness probe
type ContainerExec struct {
// Command - The commands to execute within the container.
Command *[]string `json:"command,omitempty"`
}
ContainerExecRequest the container exec request.
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"`
}
ContainerExecRequestTerminalSize the size of the terminal.
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"`
}
ContainerExecResponse the information for the container exec command.
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"`
}
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 (cg ContainerGroup) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerGroup.
func (cg *ContainerGroup) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ContainerGroup struct.
ContainerGroupDiagnostics container group diagnostic information.
type ContainerGroupDiagnostics struct {
// LogAnalytics - Container group log analytics information.
LogAnalytics *LogAnalytics `json:"logAnalytics,omitempty"`
}
ContainerGroupIPAddressType enumerates the values for container group ip address type.
type ContainerGroupIPAddressType string
const (
// Private ...
Private ContainerGroupIPAddressType = "Private"
// Public ...
Public ContainerGroupIPAddressType = "Public"
)
func PossibleContainerGroupIPAddressTypeValues() []ContainerGroupIPAddressType
PossibleContainerGroupIPAddressTypeValues returns an array of possible values for the ContainerGroupIPAddressType const type.
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 (cglr ContainerGroupListResult) IsEmpty() bool
IsEmpty returns true if the ListResult contains no values.
ContainerGroupListResultIterator provides access to a complete listing of ContainerGroup values.
type ContainerGroupListResultIterator struct {
// contains filtered or unexported fields
}
func NewContainerGroupListResultIterator(page ContainerGroupListResultPage) ContainerGroupListResultIterator
Creates a new instance of the ContainerGroupListResultIterator type.
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 (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 (iter ContainerGroupListResultIterator) NotDone() bool
NotDone returns true if the enumeration should be started or is not yet complete.
func (iter ContainerGroupListResultIterator) Response() ContainerGroupListResult
Response returns the raw server response from the last page request.
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.
ContainerGroupListResultPage contains a page of ContainerGroup values.
type ContainerGroupListResultPage struct {
// contains filtered or unexported fields
}
func NewContainerGroupListResultPage(cur ContainerGroupListResult, getNextPage func(context.Context, ContainerGroupListResult) (ContainerGroupListResult, error)) ContainerGroupListResultPage
Creates a new instance of the ContainerGroupListResultPage type.
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 (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 (page ContainerGroupListResultPage) NotDone() bool
NotDone returns true if the page enumeration should be started or is not yet complete.
func (page ContainerGroupListResultPage) Response() ContainerGroupListResult
Response returns the raw server response from the last page request.
func (page ContainerGroupListResultPage) Values() []ContainerGroup
Values returns the slice of values for the current page or nil if there are no values.
ContainerGroupNetworkProfile container group network profile information.
type ContainerGroupNetworkProfile struct {
// ID - The identifier for a network profile.
ID *string `json:"id,omitempty"`
}
ContainerGroupNetworkProtocol enumerates the values for container group network protocol.
type ContainerGroupNetworkProtocol string
const (
// TCP ...
TCP ContainerGroupNetworkProtocol = "TCP"
// UDP ...
UDP ContainerGroupNetworkProtocol = "UDP"
)
func PossibleContainerGroupNetworkProtocolValues() []ContainerGroupNetworkProtocol
PossibleContainerGroupNetworkProtocolValues returns an array of possible values for the ContainerGroupNetworkProtocol const 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"`
}
func (cg ContainerGroupProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerGroupProperties.
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 (cgV ContainerGroupPropertiesInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerGroupPropertiesInstanceView.
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() []ContainerGroupRestartPolicy
PossibleContainerGroupRestartPolicyValues returns an array of possible values for the ContainerGroupRestartPolicy const type.
ContainerGroupUsageClient is the client for the ContainerGroupUsage methods of the Containerinstance service.
type ContainerGroupUsageClient struct {
BaseClient
}
func NewContainerGroupUsageClient(subscriptionID string) ContainerGroupUsageClient
NewContainerGroupUsageClient creates an instance of the ContainerGroupUsageClient client.
func NewContainerGroupUsageClientWithBaseURI(baseURI string, subscriptionID string) ContainerGroupUsageClient
NewContainerGroupUsageClientWithBaseURI creates an instance of the ContainerGroupUsageClient 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 (client ContainerGroupUsageClient) List(ctx context.Context, location string) (result UsageListResult, err error)
List get the usage for a subscription Parameters: location - the identifier for the physical azure location.
func (client ContainerGroupUsageClient) ListPreparer(ctx context.Context, location string) (*http.Request, error)
ListPreparer prepares the List request.
func (client ContainerGroupUsageClient) ListResponder(resp *http.Response) (result UsageListResult, err error)
ListResponder handles the response to the List request. The method always closes the http.Response Body.
func (client ContainerGroupUsageClient) 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.
ContainerGroupsClient is the client for the ContainerGroups methods of the Containerinstance service.
type ContainerGroupsClient struct {
BaseClient
}
func NewContainerGroupsClient(subscriptionID string) ContainerGroupsClient
NewContainerGroupsClient creates an instance of the ContainerGroupsClient client.
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 (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 (client ContainerGroupsClient) CreateOrUpdatePreparer(ctx context.Context, resourceGroupName string, containerGroupName string, containerGroup ContainerGroup) (*http.Request, error)
CreateOrUpdatePreparer prepares the CreateOrUpdate request.
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 (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 (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 (client ContainerGroupsClient) DeletePreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)
DeletePreparer prepares the Delete request.
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 (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 (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 (client ContainerGroupsClient) GetPreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (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 (client ContainerGroupsClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ContainerGroupListResultIterator, err error)
ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.
func (client ContainerGroupsClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (client ContainerGroupsClient) ListComplete(ctx context.Context) (result ContainerGroupListResultIterator, err error)
ListComplete enumerates all values, automatically crossing page boundaries as required.
func (client ContainerGroupsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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 (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 (client ContainerGroupsClient) RestartPreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)
RestartPreparer prepares the Restart request.
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 (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 (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 (client ContainerGroupsClient) StopPreparer(ctx context.Context, resourceGroupName string, containerGroupName string) (*http.Request, error)
StopPreparer prepares the Stop request.
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 (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 (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 (client ContainerGroupsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, containerGroupName string, resource Resource) (*http.Request, error)
UpdatePreparer prepares the Update request.
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 (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.
ContainerGroupsCreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *ContainerGroupsCreateOrUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ContainerGroupsRestartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
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)
}
func (future *ContainerGroupsRestartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ContainerHTTPGet the container Http Get settings, for liveness or readiness probe
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"`
}
ContainerNetworkProtocol enumerates the values for container network protocol.
type ContainerNetworkProtocol string
const (
// ContainerNetworkProtocolTCP ...
ContainerNetworkProtocolTCP ContainerNetworkProtocol = "TCP"
// ContainerNetworkProtocolUDP ...
ContainerNetworkProtocolUDP ContainerNetworkProtocol = "UDP"
)
func PossibleContainerNetworkProtocolValues() []ContainerNetworkProtocol
PossibleContainerNetworkProtocolValues returns an array of possible values for the ContainerNetworkProtocol const type.
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"`
}
ContainerProbe the container probe, for liveness or readiness
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"`
}
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"`
// LivenessProbe - The liveness probe.
LivenessProbe *ContainerProbe `json:"livenessProbe,omitempty"`
// ReadinessProbe - The readiness probe.
ReadinessProbe *ContainerProbe `json:"readinessProbe,omitempty"`
}
func (cp ContainerProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerProperties.
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 (cpV ContainerPropertiesInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ContainerPropertiesInstanceView.
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"`
}
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"`
// SecureValue - The value of the secure environment variable.
SecureValue *string `json:"secureValue,omitempty"`
}
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"`
}
GitRepoVolume represents a volume that is populated with the contents of a git repository
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"`
}
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. 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"`
}
func (ia IPAddress) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for IPAddress.
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"`
}
LogAnalytics container group log analytics information.
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"`
}
func (la LogAnalytics) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for LogAnalytics.
LogAnalyticsLogType enumerates the values for log analytics log type.
type LogAnalyticsLogType string
const (
// ContainerInsights ...
ContainerInsights LogAnalyticsLogType = "ContainerInsights"
// ContainerInstanceLogs ...
ContainerInstanceLogs LogAnalyticsLogType = "ContainerInstanceLogs"
)
func PossibleLogAnalyticsLogTypeValues() []LogAnalyticsLogType
PossibleLogAnalyticsLogTypeValues returns an array of possible values for the LogAnalyticsLogType const type.
Logs the logs.
type Logs struct {
autorest.Response `json:"-"`
// Content - The content of the log.
Content *string `json:"content,omitempty"`
}
OperatingSystemTypes enumerates the values for operating system types.
type OperatingSystemTypes string
const (
// Linux ...
Linux OperatingSystemTypes = "Linux"
// Windows ...
Windows OperatingSystemTypes = "Windows"
)
func PossibleOperatingSystemTypesValues() []OperatingSystemTypes
PossibleOperatingSystemTypesValues returns an array of possible values for the OperatingSystemTypes const type.
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"`
}
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"`
}
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"`
// NextLink - The URI to fetch the next page of operations.
NextLink *string `json:"nextLink,omitempty"`
}
OperationsClient is the client for the Operations methods of the Containerinstance service.
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
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 (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List list the operations for Azure Container Instance service.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
OperationsOrigin enumerates the values for operations origin.
type OperationsOrigin string
const (
// System ...
System OperationsOrigin = "System"
// User ...
User OperationsOrigin = "User"
)
func PossibleOperationsOriginValues() []OperationsOrigin
PossibleOperationsOriginValues returns an array of possible values for the OperationsOrigin const type.
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"`
}
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 (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
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"`
}
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"`
}
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"`
}
Scheme enumerates the values for scheme.
type Scheme string
const (
// HTTP ...
HTTP Scheme = "http"
// HTTPS ...
HTTPS Scheme = "https"
)
func PossibleSchemeValues() []Scheme
PossibleSchemeValues returns an array of possible values for the Scheme const type.
Usage a single usage result
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"`
}
func (u Usage) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Usage.
UsageListResult the response containing the usage data
type UsageListResult struct {
autorest.Response `json:"-"`
// Value - READ-ONLY
Value *[]Usage `json:"value,omitempty"`
}
func (ulr UsageListResult) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UsageListResult.
UsageName the name object of the resource
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"`
}
func (u UsageName) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for UsageName.
Volume the properties of the 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"`
}
func (vVar Volume) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Volume.
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"`
}
| Name | Synopsis |
|---|---|
| .. | |
| containerinstanceapi | Deprecated: Please note, this package has been deprecated. |