batchaccount

package
v0.20230204.1123804 Latest Latest
Warning

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

Go to latest
Published: Feb 4, 2023 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/batch/2022-01-01/batchaccount Documentation

The batchaccount SDK allows for interaction with the Azure Resource Manager Service batch (API Version 2022-01-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-sdk/resource-manager/batch/2022-01-01/batchaccount"

Client Initialization

client := batchaccount.NewBatchAccountClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BatchAccountClient.Create

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

payload := batchaccount.BatchAccountCreateParameters{
	// ...
}


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

Example Usage: BatchAccountClient.Delete

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

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

Example Usage: BatchAccountClient.Get

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

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

Example Usage: BatchAccountClient.GetKeys

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

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

Example Usage: BatchAccountClient.List

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

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

Example Usage: BatchAccountClient.ListByResourceGroup

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

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

Example Usage: BatchAccountClient.ListOutboundNetworkDependenciesEndpoints

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

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

Example Usage: BatchAccountClient.RegenerateKey

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

payload := batchaccount.BatchAccountRegenerateKeyParameters{
	// ...
}


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

Example Usage: BatchAccountClient.SynchronizeAutoStorageKeys

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

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

Example Usage: BatchAccountClient.Update

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

payload := batchaccount.BatchAccountUpdateParameters{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAccountKeyType

func PossibleValuesForAccountKeyType() []string

func PossibleValuesForAuthenticationMode

func PossibleValuesForAuthenticationMode() []string

func PossibleValuesForAutoStorageAuthenticationMode

func PossibleValuesForAutoStorageAuthenticationMode() []string

func PossibleValuesForKeySource

func PossibleValuesForKeySource() []string

func PossibleValuesForPoolAllocationMode

func PossibleValuesForPoolAllocationMode() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateLinkServiceConnectionStatus

func PossibleValuesForPrivateLinkServiceConnectionStatus() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicNetworkAccessType

func PossibleValuesForPublicNetworkAccessType() []string

func ValidateBatchAccountID

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

ValidateBatchAccountID checks that 'input' can be parsed as a Batch Account ID

Types

type AccountKeyType

type AccountKeyType string
const (
	AccountKeyTypePrimary   AccountKeyType = "Primary"
	AccountKeyTypeSecondary AccountKeyType = "Secondary"
)

type AuthenticationMode

type AuthenticationMode string
const (
	AuthenticationModeAAD                     AuthenticationMode = "AAD"
	AuthenticationModeSharedKey               AuthenticationMode = "SharedKey"
	AuthenticationModeTaskAuthenticationToken AuthenticationMode = "TaskAuthenticationToken"
)

type AutoStorageAuthenticationMode

type AutoStorageAuthenticationMode string
const (
	AutoStorageAuthenticationModeBatchAccountManagedIdentity AutoStorageAuthenticationMode = "BatchAccountManagedIdentity"
	AutoStorageAuthenticationModeStorageKeys                 AutoStorageAuthenticationMode = "StorageKeys"
)

type AutoStorageBaseProperties

type AutoStorageBaseProperties struct {
	AuthenticationMode    *AutoStorageAuthenticationMode `json:"authenticationMode,omitempty"`
	NodeIdentityReference *ComputeNodeIdentityReference  `json:"nodeIdentityReference,omitempty"`
	StorageAccountId      string                         `json:"storageAccountId"`
}

type AutoStorageProperties

type AutoStorageProperties struct {
	AuthenticationMode    *AutoStorageAuthenticationMode `json:"authenticationMode,omitempty"`
	LastKeySync           string                         `json:"lastKeySync"`
	NodeIdentityReference *ComputeNodeIdentityReference  `json:"nodeIdentityReference,omitempty"`
	StorageAccountId      string                         `json:"storageAccountId"`
}

func (*AutoStorageProperties) GetLastKeySyncAsTime

func (o *AutoStorageProperties) GetLastKeySyncAsTime() (*time.Time, error)

func (*AutoStorageProperties) SetLastKeySyncAsTime

func (o *AutoStorageProperties) SetLastKeySyncAsTime(input time.Time)

type BatchAccount

type BatchAccount struct {
	Id         *string                           `json:"id,omitempty"`
	Identity   *identity.SystemOrUserAssignedMap `json:"identity,omitempty"`
	Location   *string                           `json:"location,omitempty"`
	Name       *string                           `json:"name,omitempty"`
	Properties *BatchAccountProperties           `json:"properties,omitempty"`
	Tags       *map[string]string                `json:"tags,omitempty"`
	Type       *string                           `json:"type,omitempty"`
}

type BatchAccountClient

type BatchAccountClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewBatchAccountClientWithBaseURI

func NewBatchAccountClientWithBaseURI(endpoint string) BatchAccountClient

func (BatchAccountClient) Create

Create ...

func (BatchAccountClient) CreateThenPoll

CreateThenPoll performs Create then polls until it's completed

func (BatchAccountClient) Delete

Delete ...

func (BatchAccountClient) DeleteThenPoll

func (c BatchAccountClient) DeleteThenPoll(ctx context.Context, id BatchAccountId) error

DeleteThenPoll performs Delete then polls until it's completed

func (BatchAccountClient) Get

Get ...

func (BatchAccountClient) GetKeys

GetKeys ...

func (BatchAccountClient) List

List ...

func (BatchAccountClient) ListByResourceGroup

ListByResourceGroup ...

func (BatchAccountClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all of the results into a single object

func (BatchAccountClient) ListByResourceGroupCompleteMatchingPredicate

func (c BatchAccountClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate BatchAccountOperationPredicate) (resp ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (BatchAccountClient) ListComplete

ListComplete retrieves all of the results into a single object

func (BatchAccountClient) ListCompleteMatchingPredicate

func (c BatchAccountClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate BatchAccountOperationPredicate) (resp ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (BatchAccountClient) ListOutboundNetworkDependenciesEndpoints

func (c BatchAccountClient) ListOutboundNetworkDependenciesEndpoints(ctx context.Context, id BatchAccountId) (resp ListOutboundNetworkDependenciesEndpointsOperationResponse, err error)

ListOutboundNetworkDependenciesEndpoints ...

func (BatchAccountClient) ListOutboundNetworkDependenciesEndpointsComplete

func (c BatchAccountClient) ListOutboundNetworkDependenciesEndpointsComplete(ctx context.Context, id BatchAccountId) (ListOutboundNetworkDependenciesEndpointsCompleteResult, error)

ListOutboundNetworkDependenciesEndpointsComplete retrieves all of the results into a single object

func (BatchAccountClient) ListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate

func (c BatchAccountClient) ListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate(ctx context.Context, id BatchAccountId, predicate OutboundEnvironmentEndpointOperationPredicate) (resp ListOutboundNetworkDependenciesEndpointsCompleteResult, err error)

ListOutboundNetworkDependenciesEndpointsCompleteMatchingPredicate retrieves all of the results and then applied the predicate

func (BatchAccountClient) RegenerateKey

RegenerateKey ...

func (BatchAccountClient) SynchronizeAutoStorageKeys

func (c BatchAccountClient) SynchronizeAutoStorageKeys(ctx context.Context, id BatchAccountId) (result SynchronizeAutoStorageKeysOperationResponse, err error)

SynchronizeAutoStorageKeys ...

func (BatchAccountClient) Update

Update ...

type BatchAccountCreateParameters

type BatchAccountCreateParameters struct {
	Identity   *identity.SystemOrUserAssignedMap `json:"identity,omitempty"`
	Location   string                            `json:"location"`
	Properties *BatchAccountCreateProperties     `json:"properties,omitempty"`
	Tags       *map[string]string                `json:"tags,omitempty"`
}

type BatchAccountCreateProperties

type BatchAccountCreateProperties struct {
	AllowedAuthenticationModes *[]AuthenticationMode      `json:"allowedAuthenticationModes,omitempty"`
	AutoStorage                *AutoStorageBaseProperties `json:"autoStorage,omitempty"`
	Encryption                 *EncryptionProperties      `json:"encryption,omitempty"`
	KeyVaultReference          *KeyVaultReference         `json:"keyVaultReference,omitempty"`
	PoolAllocationMode         *PoolAllocationMode        `json:"poolAllocationMode,omitempty"`
	PublicNetworkAccess        *PublicNetworkAccessType   `json:"publicNetworkAccess,omitempty"`
}

type BatchAccountId

type BatchAccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	BatchAccountName  string
}

BatchAccountId is a struct representing the Resource ID for a Batch Account

func NewBatchAccountID

func NewBatchAccountID(subscriptionId string, resourceGroupName string, batchAccountName string) BatchAccountId

NewBatchAccountID returns a new BatchAccountId struct

func ParseBatchAccountID

func ParseBatchAccountID(input string) (*BatchAccountId, error)

ParseBatchAccountID parses 'input' into a BatchAccountId

func ParseBatchAccountIDInsensitively

func ParseBatchAccountIDInsensitively(input string) (*BatchAccountId, error)

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

func (BatchAccountId) ID

func (id BatchAccountId) ID() string

ID returns the formatted Batch Account ID

func (BatchAccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Batch Account ID

func (BatchAccountId) String

func (id BatchAccountId) String() string

String returns a human-readable description of this Batch Account ID

type BatchAccountKeys

type BatchAccountKeys struct {
	AccountName *string `json:"accountName,omitempty"`
	Primary     *string `json:"primary,omitempty"`
	Secondary   *string `json:"secondary,omitempty"`
}

type BatchAccountOperationPredicate

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

func (BatchAccountOperationPredicate) Matches

type BatchAccountProperties

type BatchAccountProperties struct {
	AccountEndpoint                       *string                          `json:"accountEndpoint,omitempty"`
	ActiveJobAndJobScheduleQuota          *int64                           `json:"activeJobAndJobScheduleQuota,omitempty"`
	AllowedAuthenticationModes            *[]AuthenticationMode            `json:"allowedAuthenticationModes,omitempty"`
	AutoStorage                           *AutoStorageProperties           `json:"autoStorage,omitempty"`
	DedicatedCoreQuota                    *int64                           `json:"dedicatedCoreQuota,omitempty"`
	DedicatedCoreQuotaPerVMFamily         *[]VirtualMachineFamilyCoreQuota `json:"dedicatedCoreQuotaPerVMFamily,omitempty"`
	DedicatedCoreQuotaPerVMFamilyEnforced *bool                            `json:"dedicatedCoreQuotaPerVMFamilyEnforced,omitempty"`
	Encryption                            *EncryptionProperties            `json:"encryption,omitempty"`
	KeyVaultReference                     *KeyVaultReference               `json:"keyVaultReference,omitempty"`
	LowPriorityCoreQuota                  *int64                           `json:"lowPriorityCoreQuota,omitempty"`
	PoolAllocationMode                    *PoolAllocationMode              `json:"poolAllocationMode,omitempty"`
	PoolQuota                             *int64                           `json:"poolQuota,omitempty"`
	PrivateEndpointConnections            *[]PrivateEndpointConnection     `json:"privateEndpointConnections,omitempty"`
	ProvisioningState                     *ProvisioningState               `json:"provisioningState,omitempty"`
	PublicNetworkAccess                   *PublicNetworkAccessType         `json:"publicNetworkAccess,omitempty"`
}

type BatchAccountRegenerateKeyParameters

type BatchAccountRegenerateKeyParameters struct {
	KeyName AccountKeyType `json:"keyName"`
}

type BatchAccountUpdateParameters

type BatchAccountUpdateParameters struct {
	Identity   *identity.SystemOrUserAssignedMap `json:"identity,omitempty"`
	Properties *BatchAccountUpdateProperties     `json:"properties,omitempty"`
	Tags       *map[string]string                `json:"tags,omitempty"`
}

type BatchAccountUpdateProperties

type BatchAccountUpdateProperties struct {
	AllowedAuthenticationModes *[]AuthenticationMode      `json:"allowedAuthenticationModes,omitempty"`
	AutoStorage                *AutoStorageBaseProperties `json:"autoStorage,omitempty"`
	Encryption                 *EncryptionProperties      `json:"encryption,omitempty"`
}

type ComputeNodeIdentityReference

type ComputeNodeIdentityReference struct {
	ResourceId *string `json:"resourceId,omitempty"`
}

type CreateOperationResponse

type CreateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type EncryptionProperties

type EncryptionProperties struct {
	KeySource          *KeySource          `json:"keySource,omitempty"`
	KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}

type EndpointDependency

type EndpointDependency struct {
	Description     *string           `json:"description,omitempty"`
	DomainName      *string           `json:"domainName,omitempty"`
	EndpointDetails *[]EndpointDetail `json:"endpointDetails,omitempty"`
}

type EndpointDetail

type EndpointDetail struct {
	Port *int64 `json:"port,omitempty"`
}

type GetKeysOperationResponse

type GetKeysOperationResponse struct {
	HttpResponse *http.Response
	Model        *BatchAccountKeys
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *BatchAccount
}

type KeySource

type KeySource string
const (
	KeySourceMicrosoftPointBatch    KeySource = "Microsoft.Batch"
	KeySourceMicrosoftPointKeyVault KeySource = "Microsoft.KeyVault"
)

type KeyVaultProperties

type KeyVaultProperties struct {
	KeyIdentifier *string `json:"keyIdentifier,omitempty"`
}

type KeyVaultReference

type KeyVaultReference struct {
	Id  string `json:"id"`
	Url string `json:"url"`
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	Items []BatchAccount
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]BatchAccount
	// contains filtered or unexported fields
}

func (ListByResourceGroupOperationResponse) HasMore

func (ListByResourceGroupOperationResponse) LoadMore

type ListCompleteResult

type ListCompleteResult struct {
	Items []BatchAccount
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]BatchAccount
	// contains filtered or unexported fields
}

func (ListOperationResponse) HasMore

func (r ListOperationResponse) HasMore() bool

func (ListOperationResponse) LoadMore

func (r ListOperationResponse) LoadMore(ctx context.Context) (resp ListOperationResponse, err error)

type ListOutboundNetworkDependenciesEndpointsCompleteResult

type ListOutboundNetworkDependenciesEndpointsCompleteResult struct {
	Items []OutboundEnvironmentEndpoint
}

type ListOutboundNetworkDependenciesEndpointsOperationResponse

type ListOutboundNetworkDependenciesEndpointsOperationResponse struct {
	HttpResponse *http.Response
	Model        *[]OutboundEnvironmentEndpoint
	// contains filtered or unexported fields
}

func (ListOutboundNetworkDependenciesEndpointsOperationResponse) HasMore

func (ListOutboundNetworkDependenciesEndpointsOperationResponse) LoadMore

type OutboundEnvironmentEndpoint

type OutboundEnvironmentEndpoint struct {
	Category  *string               `json:"category,omitempty"`
	Endpoints *[]EndpointDependency `json:"endpoints,omitempty"`
}

type OutboundEnvironmentEndpointOperationPredicate

type OutboundEnvironmentEndpointOperationPredicate struct {
	Category *string
}

func (OutboundEnvironmentEndpointOperationPredicate) Matches

type PoolAllocationMode

type PoolAllocationMode string
const (
	PoolAllocationModeBatchService     PoolAllocationMode = "BatchService"
	PoolAllocationModeUserSubscription PoolAllocationMode = "UserSubscription"
)

type PrivateEndpoint

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection

type PrivateEndpointConnection struct {
	Etag       *string                              `json:"etag,omitempty"`
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties

type PrivateEndpointConnectionProperties struct {
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState *PrivateLinkServiceConnectionState          `json:"privateLinkServiceConnectionState,omitempty"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
	PrivateEndpointConnectionProvisioningStateUpdating  PrivateEndpointConnectionProvisioningState = "Updating"
)

type PrivateLinkServiceConnectionState

type PrivateLinkServiceConnectionState struct {
	ActionRequired *string                            `json:"actionRequired,omitempty"`
	Description    *string                            `json:"description,omitempty"`
	Status         PrivateLinkServiceConnectionStatus `json:"status"`
}

type PrivateLinkServiceConnectionStatus

type PrivateLinkServiceConnectionStatus string
const (
	PrivateLinkServiceConnectionStatusApproved     PrivateLinkServiceConnectionStatus = "Approved"
	PrivateLinkServiceConnectionStatusDisconnected PrivateLinkServiceConnectionStatus = "Disconnected"
	PrivateLinkServiceConnectionStatusPending      PrivateLinkServiceConnectionStatus = "Pending"
	PrivateLinkServiceConnectionStatusRejected     PrivateLinkServiceConnectionStatus = "Rejected"
)

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCancelled ProvisioningState = "Cancelled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateInvalid   ProvisioningState = "Invalid"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

type PublicNetworkAccessType

type PublicNetworkAccessType string
const (
	PublicNetworkAccessTypeDisabled PublicNetworkAccessType = "Disabled"
	PublicNetworkAccessTypeEnabled  PublicNetworkAccessType = "Enabled"
)

type RegenerateKeyOperationResponse

type RegenerateKeyOperationResponse struct {
	HttpResponse *http.Response
	Model        *BatchAccountKeys
}

type SynchronizeAutoStorageKeysOperationResponse

type SynchronizeAutoStorageKeysOperationResponse struct {
	HttpResponse *http.Response
}

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	Model        *BatchAccount
}

type VirtualMachineFamilyCoreQuota

type VirtualMachineFamilyCoreQuota struct {
	CoreQuota *int64  `json:"coreQuota,omitempty"`
	Name      *string `json:"name,omitempty"`
}

Jump to

Keyboard shortcuts

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