containerinstance

package
v0.20240524.1090207 Latest Latest
Warning

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

Go to latest
Published: May 24, 2024 License: MPL-2.0 Imports: 17 Imported by: 1

README ¶

github.com/hashicorp/go-azure-sdk/resource-manager/containerinstance/2023-05-01/containerinstance Documentation

The containerinstance SDK allows for interaction with the Azure Resource Manager Service containerinstance (API Version 2023-05-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/containerinstance/2023-05-01/containerinstance"

Client Initialization

client := containerinstance.NewContainerInstanceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContainerInstanceClient.ContainerGroupsCreateOrUpdate

ctx := context.TODO()
id := containerinstance.NewContainerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue")

payload := containerinstance.ContainerGroup{
	// ...
}


if err := client.ContainerGroupsCreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ContainerInstanceClient.ContainerGroupsDelete

ctx := context.TODO()
id := containerinstance.NewContainerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue")

if err := client.ContainerGroupsDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ContainerInstanceClient.ContainerGroupsGet

ctx := context.TODO()
id := containerinstance.NewContainerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue")

read, err := client.ContainerGroupsGet(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerInstanceClient.ContainerGroupsGetOutboundNetworkDependenciesEndpoints

ctx := context.TODO()
id := containerinstance.NewContainerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue")

read, err := client.ContainerGroupsGetOutboundNetworkDependenciesEndpoints(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerInstanceClient.ContainerGroupsList

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.ContainerGroupsList(ctx, id)` can be used to do batched pagination
items, err := client.ContainerGroupsListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ContainerInstanceClient.ContainerGroupsListByResourceGroup

ctx := context.TODO()
id := commonids.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

// alternatively `client.ContainerGroupsListByResourceGroup(ctx, id)` can be used to do batched pagination
items, err := client.ContainerGroupsListByResourceGroupComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ContainerInstanceClient.ContainerGroupsRestart

ctx := context.TODO()
id := containerinstance.NewContainerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue")

if err := client.ContainerGroupsRestartThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ContainerInstanceClient.ContainerGroupsStart

ctx := context.TODO()
id := containerinstance.NewContainerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue")

if err := client.ContainerGroupsStartThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ContainerInstanceClient.ContainerGroupsStop

ctx := context.TODO()
id := containerinstance.NewContainerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue")

read, err := client.ContainerGroupsStop(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerInstanceClient.ContainerGroupsUpdate

ctx := context.TODO()
id := containerinstance.NewContainerGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue")

payload := containerinstance.Resource{
	// ...
}


read, err := client.ContainerGroupsUpdate(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerInstanceClient.ContainersAttach

ctx := context.TODO()
id := containerinstance.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue", "containerValue")

read, err := client.ContainersAttach(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerInstanceClient.ContainersExecuteCommand

ctx := context.TODO()
id := containerinstance.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue", "containerValue")

payload := containerinstance.ContainerExecRequest{
	// ...
}


read, err := client.ContainersExecuteCommand(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerInstanceClient.ContainersListLogs

ctx := context.TODO()
id := containerinstance.NewContainerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "containerGroupValue", "containerValue")

read, err := client.ContainersListLogs(ctx, id, containerinstance.DefaultContainersListLogsOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerInstanceClient.LocationListCachedImages

ctx := context.TODO()
id := containerinstance.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

// alternatively `client.LocationListCachedImages(ctx, id)` can be used to do batched pagination
items, err := client.LocationListCachedImagesComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ContainerInstanceClient.LocationListCapabilities

ctx := context.TODO()
id := containerinstance.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

// alternatively `client.LocationListCapabilities(ctx, id)` can be used to do batched pagination
items, err := client.LocationListCapabilitiesComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: ContainerInstanceClient.LocationListUsage

ctx := context.TODO()
id := containerinstance.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

read, err := client.LocationListUsage(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContainerInstanceClient.SubnetServiceAssociationLinkDelete

ctx := context.TODO()
id := commonids.NewSubnetID("12345678-1234-9876-4563-123456789012", "example-resource-group", "virtualNetworkValue", "subnetValue")

if err := client.SubnetServiceAssociationLinkDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func PossibleValuesForContainerGroupIPAddressType ¶

func PossibleValuesForContainerGroupIPAddressType() []string

func PossibleValuesForContainerGroupNetworkProtocol ¶

func PossibleValuesForContainerGroupNetworkProtocol() []string

func PossibleValuesForContainerGroupPriority ¶

func PossibleValuesForContainerGroupPriority() []string

func PossibleValuesForContainerGroupRestartPolicy ¶

func PossibleValuesForContainerGroupRestartPolicy() []string

func PossibleValuesForContainerGroupSku ¶

func PossibleValuesForContainerGroupSku() []string

func PossibleValuesForContainerNetworkProtocol ¶

func PossibleValuesForContainerNetworkProtocol() []string

func PossibleValuesForDnsNameLabelReusePolicy ¶

func PossibleValuesForDnsNameLabelReusePolicy() []string

func PossibleValuesForGpuSku ¶

func PossibleValuesForGpuSku() []string

func PossibleValuesForLogAnalyticsLogType ¶

func PossibleValuesForLogAnalyticsLogType() []string

func PossibleValuesForOperatingSystemTypes ¶

func PossibleValuesForOperatingSystemTypes() []string

func PossibleValuesForScheme ¶

func PossibleValuesForScheme() []string

func ValidateContainerGroupID ¶

func ValidateContainerGroupID(input interface{}, key string) (warnings []string, errors []error)

ValidateContainerGroupID checks that 'input' can be parsed as a Container Group ID

func ValidateContainerID ¶

func ValidateContainerID(input interface{}, key string) (warnings []string, errors []error)

ValidateContainerID checks that 'input' can be parsed as a Container ID

func ValidateLocationID ¶

func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types ¶

type AzureFileVolume ¶

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

type CachedImages ¶

type CachedImages struct {
	Image  string `json:"image"`
	OsType string `json:"osType"`
}

type CachedImagesOperationPredicate ¶

type CachedImagesOperationPredicate struct {
	Image  *string
	OsType *string
}

func (CachedImagesOperationPredicate) Matches ¶

type Capabilities ¶

type Capabilities struct {
	Capabilities  *CapabilitiesCapabilities `json:"capabilities,omitempty"`
	Gpu           *string                   `json:"gpu,omitempty"`
	IPAddressType *string                   `json:"ipAddressType,omitempty"`
	Location      *string                   `json:"location,omitempty"`
	OsType        *string                   `json:"osType,omitempty"`
	ResourceType  *string                   `json:"resourceType,omitempty"`
}

type CapabilitiesCapabilities ¶

type CapabilitiesCapabilities struct {
	MaxCPU        *float64 `json:"maxCpu,omitempty"`
	MaxGpuCount   *float64 `json:"maxGpuCount,omitempty"`
	MaxMemoryInGB *float64 `json:"maxMemoryInGB,omitempty"`
}

type CapabilitiesOperationPredicate ¶

type CapabilitiesOperationPredicate struct {
	Gpu           *string
	IPAddressType *string
	Location      *string
	OsType        *string
	ResourceType  *string
}

func (CapabilitiesOperationPredicate) Matches ¶

type ConfidentialComputeProperties ¶

type ConfidentialComputeProperties struct {
	CcePolicy *string `json:"ccePolicy,omitempty"`
}

type Container ¶

type Container struct {
	Name       string              `json:"name"`
	Properties ContainerProperties `json:"properties"`
}

type ContainerAttachResponse ¶

type ContainerAttachResponse struct {
	Password     *string `json:"password,omitempty"`
	WebSocketUri *string `json:"webSocketUri,omitempty"`
}

type ContainerExec ¶

type ContainerExec struct {
	Command *[]string `json:"command,omitempty"`
}

type ContainerExecRequest ¶

type ContainerExecRequest struct {
	Command      *string                           `json:"command,omitempty"`
	TerminalSize *ContainerExecRequestTerminalSize `json:"terminalSize,omitempty"`
}

type ContainerExecRequestTerminalSize ¶

type ContainerExecRequestTerminalSize struct {
	Cols *int64 `json:"cols,omitempty"`
	Rows *int64 `json:"rows,omitempty"`
}

type ContainerExecResponse ¶

type ContainerExecResponse struct {
	Password     *string `json:"password,omitempty"`
	WebSocketUri *string `json:"webSocketUri,omitempty"`
}

type ContainerGroup ¶

type ContainerGroup struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Name       *string                            `json:"name,omitempty"`
	Properties ContainerGroupPropertiesProperties `json:"properties"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
	Zones      *zones.Schema                      `json:"zones,omitempty"`
}

type ContainerGroupDiagnostics ¶

type ContainerGroupDiagnostics struct {
	LogAnalytics *LogAnalytics `json:"logAnalytics,omitempty"`
}

type ContainerGroupIPAddressType ¶

type ContainerGroupIPAddressType string
const (
	ContainerGroupIPAddressTypePrivate ContainerGroupIPAddressType = "Private"
	ContainerGroupIPAddressTypePublic  ContainerGroupIPAddressType = "Public"
)

func (*ContainerGroupIPAddressType) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *ContainerGroupIPAddressType) UnmarshalJSON(bytes []byte) error

type ContainerGroupId ¶

type ContainerGroupId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ContainerGroupName string
}

ContainerGroupId is a struct representing the Resource ID for a Container Group

func NewContainerGroupID ¶

func NewContainerGroupID(subscriptionId string, resourceGroupName string, containerGroupName string) ContainerGroupId

NewContainerGroupID returns a new ContainerGroupId struct

func ParseContainerGroupID ¶

func ParseContainerGroupID(input string) (*ContainerGroupId, error)

ParseContainerGroupID parses 'input' into a ContainerGroupId

func ParseContainerGroupIDInsensitively ¶

func ParseContainerGroupIDInsensitively(input string) (*ContainerGroupId, error)

ParseContainerGroupIDInsensitively parses 'input' case-insensitively into a ContainerGroupId note: this method should only be used for API response data and not user input

func (*ContainerGroupId) FromParseResult ¶

func (id *ContainerGroupId) FromParseResult(input resourceids.ParseResult) error

func (ContainerGroupId) ID ¶

func (id ContainerGroupId) ID() string

ID returns the formatted Container Group ID

func (ContainerGroupId) Segments ¶

func (id ContainerGroupId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Container Group ID

func (ContainerGroupId) String ¶

func (id ContainerGroupId) String() string

String returns a human-readable description of this Container Group ID

type ContainerGroupNetworkProtocol ¶

type ContainerGroupNetworkProtocol string
const (
	ContainerGroupNetworkProtocolTCP ContainerGroupNetworkProtocol = "TCP"
	ContainerGroupNetworkProtocolUDP ContainerGroupNetworkProtocol = "UDP"
)

func (*ContainerGroupNetworkProtocol) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *ContainerGroupNetworkProtocol) UnmarshalJSON(bytes []byte) error

type ContainerGroupOperationPredicate ¶

type ContainerGroupOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ContainerGroupOperationPredicate) Matches ¶

type ContainerGroupPriority ¶

type ContainerGroupPriority string
const (
	ContainerGroupPriorityRegular ContainerGroupPriority = "Regular"
	ContainerGroupPrioritySpot    ContainerGroupPriority = "Spot"
)

func (*ContainerGroupPriority) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *ContainerGroupPriority) UnmarshalJSON(bytes []byte) error

type ContainerGroupPropertiesProperties ¶

type ContainerGroupPropertiesProperties struct {
	ConfidentialComputeProperties *ConfidentialComputeProperties                  `json:"confidentialComputeProperties,omitempty"`
	Containers                    []Container                                     `json:"containers"`
	Diagnostics                   *ContainerGroupDiagnostics                      `json:"diagnostics,omitempty"`
	DnsConfig                     *DnsConfiguration                               `json:"dnsConfig,omitempty"`
	EncryptionProperties          *EncryptionProperties                           `json:"encryptionProperties,omitempty"`
	Extensions                    *[]DeploymentExtensionSpec                      `json:"extensions,omitempty"`
	IPAddress                     *IPAddress                                      `json:"ipAddress,omitempty"`
	ImageRegistryCredentials      *[]ImageRegistryCredential                      `json:"imageRegistryCredentials,omitempty"`
	InitContainers                *[]InitContainerDefinition                      `json:"initContainers,omitempty"`
	InstanceView                  *ContainerGroupPropertiesPropertiesInstanceView `json:"instanceView,omitempty"`
	OsType                        OperatingSystemTypes                            `json:"osType"`
	Priority                      *ContainerGroupPriority                         `json:"priority,omitempty"`
	ProvisioningState             *string                                         `json:"provisioningState,omitempty"`
	RestartPolicy                 *ContainerGroupRestartPolicy                    `json:"restartPolicy,omitempty"`
	Sku                           *ContainerGroupSku                              `json:"sku,omitempty"`
	SubnetIds                     *[]ContainerGroupSubnetId                       `json:"subnetIds,omitempty"`
	Volumes                       *[]Volume                                       `json:"volumes,omitempty"`
}

type ContainerGroupPropertiesPropertiesInstanceView ¶

type ContainerGroupPropertiesPropertiesInstanceView struct {
	Events *[]Event `json:"events,omitempty"`
	State  *string  `json:"state,omitempty"`
}

type ContainerGroupRestartPolicy ¶

type ContainerGroupRestartPolicy string
const (
	ContainerGroupRestartPolicyAlways    ContainerGroupRestartPolicy = "Always"
	ContainerGroupRestartPolicyNever     ContainerGroupRestartPolicy = "Never"
	ContainerGroupRestartPolicyOnFailure ContainerGroupRestartPolicy = "OnFailure"
)

func (*ContainerGroupRestartPolicy) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *ContainerGroupRestartPolicy) UnmarshalJSON(bytes []byte) error

type ContainerGroupSku ¶

type ContainerGroupSku string
const (
	ContainerGroupSkuConfidential ContainerGroupSku = "Confidential"
	ContainerGroupSkuDedicated    ContainerGroupSku = "Dedicated"
	ContainerGroupSkuStandard     ContainerGroupSku = "Standard"
)

func (*ContainerGroupSku) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *ContainerGroupSku) UnmarshalJSON(bytes []byte) error

type ContainerGroupSubnetId ¶

type ContainerGroupSubnetId struct {
	Id   string  `json:"id"`
	Name *string `json:"name,omitempty"`
}

type ContainerGroupsCreateOrUpdateOperationResponse ¶

type ContainerGroupsCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContainerGroup
}

type ContainerGroupsDeleteOperationResponse ¶

type ContainerGroupsDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContainerGroup
}

type ContainerGroupsGetOperationResponse ¶

type ContainerGroupsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContainerGroup
}

type ContainerGroupsGetOutboundNetworkDependenciesEndpointsOperationResponse ¶

type ContainerGroupsGetOutboundNetworkDependenciesEndpointsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]string
}

type ContainerGroupsListByResourceGroupCompleteResult ¶

type ContainerGroupsListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ContainerGroup
}

type ContainerGroupsListByResourceGroupOperationResponse ¶

type ContainerGroupsListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ContainerGroup
}

type ContainerGroupsListCompleteResult ¶

type ContainerGroupsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ContainerGroup
}

type ContainerGroupsListOperationResponse ¶

type ContainerGroupsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ContainerGroup
}

type ContainerGroupsRestartOperationResponse ¶

type ContainerGroupsRestartOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ContainerGroupsStartOperationResponse ¶

type ContainerGroupsStartOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type ContainerGroupsStopOperationResponse ¶

type ContainerGroupsStopOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ContainerGroupsUpdateOperationResponse ¶

type ContainerGroupsUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContainerGroup
}

type ContainerHTTPGet ¶

type ContainerHTTPGet struct {
	HTTPHeaders *[]HTTPHeader `json:"httpHeaders,omitempty"`
	Path        *string       `json:"path,omitempty"`
	Port        int64         `json:"port"`
	Scheme      *Scheme       `json:"scheme,omitempty"`
}

type ContainerId ¶

type ContainerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ContainerGroupName string
	ContainerName      string
}

ContainerId is a struct representing the Resource ID for a Container

func NewContainerID ¶

func NewContainerID(subscriptionId string, resourceGroupName string, containerGroupName string, containerName string) ContainerId

NewContainerID returns a new ContainerId struct

func ParseContainerID ¶

func ParseContainerID(input string) (*ContainerId, error)

ParseContainerID parses 'input' into a ContainerId

func ParseContainerIDInsensitively ¶

func ParseContainerIDInsensitively(input string) (*ContainerId, error)

ParseContainerIDInsensitively parses 'input' case-insensitively into a ContainerId note: this method should only be used for API response data and not user input

func (*ContainerId) FromParseResult ¶

func (id *ContainerId) FromParseResult(input resourceids.ParseResult) error

func (ContainerId) ID ¶

func (id ContainerId) ID() string

ID returns the formatted Container ID

func (ContainerId) Segments ¶

func (id ContainerId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Container ID

func (ContainerId) String ¶

func (id ContainerId) String() string

String returns a human-readable description of this Container ID

type ContainerInstanceClient ¶

type ContainerInstanceClient struct {
	Client *resourcemanager.Client
}

func NewContainerInstanceClientWithBaseURI ¶

func NewContainerInstanceClientWithBaseURI(sdkApi sdkEnv.Api) (*ContainerInstanceClient, error)

func (ContainerInstanceClient) ContainerGroupsCreateOrUpdate ¶

ContainerGroupsCreateOrUpdate ...

func (ContainerInstanceClient) ContainerGroupsCreateOrUpdateThenPoll ¶

func (c ContainerInstanceClient) ContainerGroupsCreateOrUpdateThenPoll(ctx context.Context, id ContainerGroupId, input ContainerGroup) error

ContainerGroupsCreateOrUpdateThenPoll performs ContainerGroupsCreateOrUpdate then polls until it's completed

func (ContainerInstanceClient) ContainerGroupsDelete ¶

ContainerGroupsDelete ...

func (ContainerInstanceClient) ContainerGroupsDeleteThenPoll ¶

func (c ContainerInstanceClient) ContainerGroupsDeleteThenPoll(ctx context.Context, id ContainerGroupId) error

ContainerGroupsDeleteThenPoll performs ContainerGroupsDelete then polls until it's completed

func (ContainerInstanceClient) ContainerGroupsGet ¶

ContainerGroupsGet ...

func (ContainerInstanceClient) ContainerGroupsGetOutboundNetworkDependenciesEndpoints ¶

func (c ContainerInstanceClient) ContainerGroupsGetOutboundNetworkDependenciesEndpoints(ctx context.Context, id ContainerGroupId) (result ContainerGroupsGetOutboundNetworkDependenciesEndpointsOperationResponse, err error)

ContainerGroupsGetOutboundNetworkDependenciesEndpoints ...

func (ContainerInstanceClient) ContainerGroupsList ¶

ContainerGroupsList ...

func (ContainerInstanceClient) ContainerGroupsListByResourceGroup ¶

ContainerGroupsListByResourceGroup ...

func (ContainerInstanceClient) ContainerGroupsListByResourceGroupComplete ¶

ContainerGroupsListByResourceGroupComplete retrieves all the results into a single object

func (ContainerInstanceClient) ContainerGroupsListByResourceGroupCompleteMatchingPredicate ¶

func (c ContainerInstanceClient) ContainerGroupsListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ContainerGroupOperationPredicate) (result ContainerGroupsListByResourceGroupCompleteResult, err error)

ContainerGroupsListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContainerInstanceClient) ContainerGroupsListComplete ¶

ContainerGroupsListComplete retrieves all the results into a single object

func (ContainerInstanceClient) ContainerGroupsListCompleteMatchingPredicate ¶

func (c ContainerInstanceClient) ContainerGroupsListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ContainerGroupOperationPredicate) (result ContainerGroupsListCompleteResult, err error)

ContainerGroupsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContainerInstanceClient) ContainerGroupsRestart ¶

ContainerGroupsRestart ...

func (ContainerInstanceClient) ContainerGroupsRestartThenPoll ¶

func (c ContainerInstanceClient) ContainerGroupsRestartThenPoll(ctx context.Context, id ContainerGroupId) error

ContainerGroupsRestartThenPoll performs ContainerGroupsRestart then polls until it's completed

func (ContainerInstanceClient) ContainerGroupsStart ¶

ContainerGroupsStart ...

func (ContainerInstanceClient) ContainerGroupsStartThenPoll ¶

func (c ContainerInstanceClient) ContainerGroupsStartThenPoll(ctx context.Context, id ContainerGroupId) error

ContainerGroupsStartThenPoll performs ContainerGroupsStart then polls until it's completed

func (ContainerInstanceClient) ContainerGroupsStop ¶

ContainerGroupsStop ...

func (ContainerInstanceClient) ContainerGroupsUpdate ¶

ContainerGroupsUpdate ...

func (ContainerInstanceClient) ContainersAttach ¶

ContainersAttach ...

func (ContainerInstanceClient) ContainersExecuteCommand ¶

ContainersExecuteCommand ...

func (ContainerInstanceClient) ContainersListLogs ¶

ContainersListLogs ...

func (ContainerInstanceClient) LocationListCachedImages ¶

func (c ContainerInstanceClient) LocationListCachedImages(ctx context.Context, id LocationId) (result LocationListCachedImagesOperationResponse, err error)

LocationListCachedImages ...

func (ContainerInstanceClient) LocationListCachedImagesComplete ¶

func (c ContainerInstanceClient) LocationListCachedImagesComplete(ctx context.Context, id LocationId) (LocationListCachedImagesCompleteResult, error)

LocationListCachedImagesComplete retrieves all the results into a single object

func (ContainerInstanceClient) LocationListCachedImagesCompleteMatchingPredicate ¶

func (c ContainerInstanceClient) LocationListCachedImagesCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate CachedImagesOperationPredicate) (result LocationListCachedImagesCompleteResult, err error)

LocationListCachedImagesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContainerInstanceClient) LocationListCapabilities ¶

func (c ContainerInstanceClient) LocationListCapabilities(ctx context.Context, id LocationId) (result LocationListCapabilitiesOperationResponse, err error)

LocationListCapabilities ...

func (ContainerInstanceClient) LocationListCapabilitiesComplete ¶

func (c ContainerInstanceClient) LocationListCapabilitiesComplete(ctx context.Context, id LocationId) (LocationListCapabilitiesCompleteResult, error)

LocationListCapabilitiesComplete retrieves all the results into a single object

func (ContainerInstanceClient) LocationListCapabilitiesCompleteMatchingPredicate ¶

func (c ContainerInstanceClient) LocationListCapabilitiesCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate CapabilitiesOperationPredicate) (result LocationListCapabilitiesCompleteResult, err error)

LocationListCapabilitiesCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContainerInstanceClient) LocationListUsage ¶

LocationListUsage ...

func (ContainerInstanceClient) SubnetServiceAssociationLinkDelete ¶

func (c ContainerInstanceClient) SubnetServiceAssociationLinkDelete(ctx context.Context, id commonids.SubnetId) (result SubnetServiceAssociationLinkDeleteOperationResponse, err error)

SubnetServiceAssociationLinkDelete ...

func (ContainerInstanceClient) SubnetServiceAssociationLinkDeleteThenPoll ¶

func (c ContainerInstanceClient) SubnetServiceAssociationLinkDeleteThenPoll(ctx context.Context, id commonids.SubnetId) error

SubnetServiceAssociationLinkDeleteThenPoll performs SubnetServiceAssociationLinkDelete then polls until it's completed

type ContainerNetworkProtocol ¶

type ContainerNetworkProtocol string
const (
	ContainerNetworkProtocolTCP ContainerNetworkProtocol = "TCP"
	ContainerNetworkProtocolUDP ContainerNetworkProtocol = "UDP"
)

func (*ContainerNetworkProtocol) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *ContainerNetworkProtocol) UnmarshalJSON(bytes []byte) error

type ContainerPort ¶

type ContainerPort struct {
	Port     int64                     `json:"port"`
	Protocol *ContainerNetworkProtocol `json:"protocol,omitempty"`
}

type ContainerProbe ¶

type ContainerProbe struct {
	Exec                *ContainerExec    `json:"exec,omitempty"`
	FailureThreshold    *int64            `json:"failureThreshold,omitempty"`
	HTTPGet             *ContainerHTTPGet `json:"httpGet,omitempty"`
	InitialDelaySeconds *int64            `json:"initialDelaySeconds,omitempty"`
	PeriodSeconds       *int64            `json:"periodSeconds,omitempty"`
	SuccessThreshold    *int64            `json:"successThreshold,omitempty"`
	TimeoutSeconds      *int64            `json:"timeoutSeconds,omitempty"`
}

type ContainerProperties ¶

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

type ContainerPropertiesInstanceView ¶

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

type ContainerState ¶

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

func (*ContainerState) GetFinishTimeAsTime ¶

func (o *ContainerState) GetFinishTimeAsTime() (*time.Time, error)

func (*ContainerState) GetStartTimeAsTime ¶

func (o *ContainerState) GetStartTimeAsTime() (*time.Time, error)

func (*ContainerState) SetFinishTimeAsTime ¶

func (o *ContainerState) SetFinishTimeAsTime(input time.Time)

func (*ContainerState) SetStartTimeAsTime ¶

func (o *ContainerState) SetStartTimeAsTime(input time.Time)

type ContainersAttachOperationResponse ¶

type ContainersAttachOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContainerAttachResponse
}

type ContainersExecuteCommandOperationResponse ¶

type ContainersExecuteCommandOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContainerExecResponse
}

type ContainersListLogsOperationOptions ¶

type ContainersListLogsOperationOptions struct {
	Tail       *int64
	Timestamps *bool
}

func DefaultContainersListLogsOperationOptions ¶

func DefaultContainersListLogsOperationOptions() ContainersListLogsOperationOptions

func (ContainersListLogsOperationOptions) ToHeaders ¶ added in v0.20240325.1113504

func (ContainersListLogsOperationOptions) ToOData ¶ added in v0.20240325.1113504

func (ContainersListLogsOperationOptions) ToQuery ¶ added in v0.20240325.1113504

type ContainersListLogsOperationResponse ¶

type ContainersListLogsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Logs
}

type DeploymentExtensionSpec ¶

type DeploymentExtensionSpec struct {
	Name       string                             `json:"name"`
	Properties *DeploymentExtensionSpecProperties `json:"properties,omitempty"`
}

type DeploymentExtensionSpecProperties ¶

type DeploymentExtensionSpecProperties struct {
	ExtensionType     string       `json:"extensionType"`
	ProtectedSettings *interface{} `json:"protectedSettings,omitempty"`
	Settings          *interface{} `json:"settings,omitempty"`
	Version           string       `json:"version"`
}

type DnsConfiguration ¶

type DnsConfiguration struct {
	NameServers   []string `json:"nameServers"`
	Options       *string  `json:"options,omitempty"`
	SearchDomains *string  `json:"searchDomains,omitempty"`
}

type DnsNameLabelReusePolicy ¶

type DnsNameLabelReusePolicy string
const (
	DnsNameLabelReusePolicyNoreuse            DnsNameLabelReusePolicy = "Noreuse"
	DnsNameLabelReusePolicyResourceGroupReuse DnsNameLabelReusePolicy = "ResourceGroupReuse"
	DnsNameLabelReusePolicySubscriptionReuse  DnsNameLabelReusePolicy = "SubscriptionReuse"
	DnsNameLabelReusePolicyTenantReuse        DnsNameLabelReusePolicy = "TenantReuse"
	DnsNameLabelReusePolicyUnsecure           DnsNameLabelReusePolicy = "Unsecure"
)

func (*DnsNameLabelReusePolicy) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *DnsNameLabelReusePolicy) UnmarshalJSON(bytes []byte) error

type EncryptionProperties ¶

type EncryptionProperties struct {
	Identity     *string `json:"identity,omitempty"`
	KeyName      string  `json:"keyName"`
	KeyVersion   string  `json:"keyVersion"`
	VaultBaseUrl string  `json:"vaultBaseUrl"`
}

type EnvironmentVariable ¶

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

type Event ¶

type Event struct {
	Count          *int64  `json:"count,omitempty"`
	FirstTimestamp *string `json:"firstTimestamp,omitempty"`
	LastTimestamp  *string `json:"lastTimestamp,omitempty"`
	Message        *string `json:"message,omitempty"`
	Name           *string `json:"name,omitempty"`
	Type           *string `json:"type,omitempty"`
}

func (*Event) GetFirstTimestampAsTime ¶

func (o *Event) GetFirstTimestampAsTime() (*time.Time, error)

func (*Event) GetLastTimestampAsTime ¶

func (o *Event) GetLastTimestampAsTime() (*time.Time, error)

func (*Event) SetFirstTimestampAsTime ¶

func (o *Event) SetFirstTimestampAsTime(input time.Time)

func (*Event) SetLastTimestampAsTime ¶

func (o *Event) SetLastTimestampAsTime(input time.Time)

type GitRepoVolume ¶

type GitRepoVolume struct {
	Directory  *string `json:"directory,omitempty"`
	Repository string  `json:"repository"`
	Revision   *string `json:"revision,omitempty"`
}

type GpuResource ¶

type GpuResource struct {
	Count int64  `json:"count"`
	Sku   GpuSku `json:"sku"`
}

type GpuSku ¶

type GpuSku string
const (
	GpuSkuKEightZero  GpuSku = "K80"
	GpuSkuPOneHundred GpuSku = "P100"
	GpuSkuVOneHundred GpuSku = "V100"
)

func (*GpuSku) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *GpuSku) UnmarshalJSON(bytes []byte) error

type HTTPHeader ¶

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

type IPAddress ¶

type IPAddress struct {
	AutoGeneratedDomainNameLabelScope *DnsNameLabelReusePolicy    `json:"autoGeneratedDomainNameLabelScope,omitempty"`
	DnsNameLabel                      *string                     `json:"dnsNameLabel,omitempty"`
	Fqdn                              *string                     `json:"fqdn,omitempty"`
	IP                                *string                     `json:"ip,omitempty"`
	Ports                             []Port                      `json:"ports"`
	Type                              ContainerGroupIPAddressType `json:"type"`
}

type ImageRegistryCredential ¶

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

type InitContainerDefinition ¶

type InitContainerDefinition struct {
	Name       string                            `json:"name"`
	Properties InitContainerPropertiesDefinition `json:"properties"`
}

type InitContainerPropertiesDefinition ¶

type InitContainerPropertiesDefinition struct {
	Command              *[]string                                      `json:"command,omitempty"`
	EnvironmentVariables *[]EnvironmentVariable                         `json:"environmentVariables,omitempty"`
	Image                *string                                        `json:"image,omitempty"`
	InstanceView         *InitContainerPropertiesDefinitionInstanceView `json:"instanceView,omitempty"`
	SecurityContext      *SecurityContextDefinition                     `json:"securityContext,omitempty"`
	VolumeMounts         *[]VolumeMount                                 `json:"volumeMounts,omitempty"`
}

type InitContainerPropertiesDefinitionInstanceView ¶

type InitContainerPropertiesDefinitionInstanceView struct {
	CurrentState  *ContainerState `json:"currentState,omitempty"`
	Events        *[]Event        `json:"events,omitempty"`
	PreviousState *ContainerState `json:"previousState,omitempty"`
	RestartCount  *int64          `json:"restartCount,omitempty"`
}

type LocationId ¶

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID ¶

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID ¶

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively ¶

func ParseLocationIDInsensitively(input string) (*LocationId, error)

ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input

func (*LocationId) FromParseResult ¶

func (id *LocationId) FromParseResult(input resourceids.ParseResult) error

func (LocationId) ID ¶

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments ¶

func (id LocationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String ¶

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type LocationListCachedImagesCompleteResult ¶

type LocationListCachedImagesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CachedImages
}

type LocationListCachedImagesOperationResponse ¶

type LocationListCachedImagesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CachedImages
}

type LocationListCapabilitiesCompleteResult ¶

type LocationListCapabilitiesCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Capabilities
}

type LocationListCapabilitiesOperationResponse ¶

type LocationListCapabilitiesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Capabilities
}

type LocationListUsageOperationResponse ¶

type LocationListUsageOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *UsageListResult
}

type LogAnalytics ¶

type LogAnalytics struct {
	LogType             *LogAnalyticsLogType `json:"logType,omitempty"`
	Metadata            *map[string]string   `json:"metadata,omitempty"`
	WorkspaceId         string               `json:"workspaceId"`
	WorkspaceKey        string               `json:"workspaceKey"`
	WorkspaceResourceId *string              `json:"workspaceResourceId,omitempty"`
}

type LogAnalyticsLogType ¶

type LogAnalyticsLogType string
const (
	LogAnalyticsLogTypeContainerInsights     LogAnalyticsLogType = "ContainerInsights"
	LogAnalyticsLogTypeContainerInstanceLogs LogAnalyticsLogType = "ContainerInstanceLogs"
)

func (*LogAnalyticsLogType) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *LogAnalyticsLogType) UnmarshalJSON(bytes []byte) error

type Logs ¶

type Logs struct {
	Content *string `json:"content,omitempty"`
}

type OperatingSystemTypes ¶

type OperatingSystemTypes string
const (
	OperatingSystemTypesLinux   OperatingSystemTypes = "Linux"
	OperatingSystemTypesWindows OperatingSystemTypes = "Windows"
)

func (*OperatingSystemTypes) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *OperatingSystemTypes) UnmarshalJSON(bytes []byte) error

type Port ¶

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

type Resource ¶

type Resource struct {
	Id       *string            `json:"id,omitempty"`
	Location *string            `json:"location,omitempty"`
	Name     *string            `json:"name,omitempty"`
	Tags     *map[string]string `json:"tags,omitempty"`
	Type     *string            `json:"type,omitempty"`
	Zones    *zones.Schema      `json:"zones,omitempty"`
}

type ResourceLimits ¶

type ResourceLimits struct {
	Cpu        *float64     `json:"cpu,omitempty"`
	Gpu        *GpuResource `json:"gpu,omitempty"`
	MemoryInGB *float64     `json:"memoryInGB,omitempty"`
}

type ResourceRequests ¶

type ResourceRequests struct {
	Cpu        float64      `json:"cpu"`
	Gpu        *GpuResource `json:"gpu,omitempty"`
	MemoryInGB float64      `json:"memoryInGB"`
}

type ResourceRequirements ¶

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

type Scheme ¶

type Scheme string
const (
	SchemeHTTP  Scheme = "http"
	SchemeHTTPS Scheme = "https"
)

func (*Scheme) UnmarshalJSON ¶ added in v0.20240325.1113504

func (s *Scheme) UnmarshalJSON(bytes []byte) error

type SecurityContextCapabilitiesDefinition ¶

type SecurityContextCapabilitiesDefinition struct {
	Add  *[]string `json:"add,omitempty"`
	Drop *[]string `json:"drop,omitempty"`
}

type SecurityContextDefinition ¶

type SecurityContextDefinition struct {
	AllowPrivilegeEscalation *bool                                  `json:"allowPrivilegeEscalation,omitempty"`
	Capabilities             *SecurityContextCapabilitiesDefinition `json:"capabilities,omitempty"`
	Privileged               *bool                                  `json:"privileged,omitempty"`
	RunAsGroup               *int64                                 `json:"runAsGroup,omitempty"`
	RunAsUser                *int64                                 `json:"runAsUser,omitempty"`
	SeccompProfile           *string                                `json:"seccompProfile,omitempty"`
}

type SubnetServiceAssociationLinkDeleteOperationResponse ¶

type SubnetServiceAssociationLinkDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type Usage ¶

type Usage struct {
	CurrentValue *int64     `json:"currentValue,omitempty"`
	Id           *string    `json:"id,omitempty"`
	Limit        *int64     `json:"limit,omitempty"`
	Name         *UsageName `json:"name,omitempty"`
	Unit         *string    `json:"unit,omitempty"`
}

type UsageListResult ¶

type UsageListResult struct {
	Value *[]Usage `json:"value,omitempty"`
}

type UsageName ¶

type UsageName struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          *string `json:"value,omitempty"`
}

type Volume ¶

type Volume struct {
	AzureFile *AzureFileVolume   `json:"azureFile,omitempty"`
	EmptyDir  *interface{}       `json:"emptyDir,omitempty"`
	GitRepo   *GitRepoVolume     `json:"gitRepo,omitempty"`
	Name      string             `json:"name"`
	Secret    *map[string]string `json:"secret,omitempty"`
}

type VolumeMount ¶

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

Source Files ¶

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL