Documentation
¶
Overview ¶
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Index ¶
- Constants
- type AutoStorageBaseProperties
- type AutoStorageProperties_STATUS
- type BatchAccountCreateProperties
- type BatchAccountIdentity
- type BatchAccountIdentity_STATUS
- type BatchAccountIdentity_Type
- type BatchAccountIdentity_Type_STATUS
- type BatchAccountIdentity_UserAssignedIdentities_STATUS
- type BatchAccountProperties_ProvisioningState_STATUS
- type BatchAccountProperties_STATUS
- type BatchAccount_STATUS
- type BatchAccount_Spec
- type EncryptionProperties
- type EncryptionProperties_KeySource
- type EncryptionProperties_KeySource_STATUS
- type EncryptionProperties_STATUS
- type KeyVaultProperties
- type KeyVaultProperties_STATUS
- type KeyVaultReference
- type KeyVaultReference_STATUS
- type PoolAllocationMode
- type PoolAllocationMode_STATUS
- type PrivateEndpointConnection_STATUS
- type PublicNetworkAccessType
- type PublicNetworkAccessType_STATUS
- type UserAssignedIdentityDetails
- type VirtualMachineFamilyCoreQuota_STATUS
Constants ¶
const ( BatchAccountIdentity_Type_None = BatchAccountIdentity_Type("None") BatchAccountIdentity_Type_SystemAssigned = BatchAccountIdentity_Type("SystemAssigned") BatchAccountIdentity_Type_UserAssigned = BatchAccountIdentity_Type("UserAssigned") )
const ( PoolAllocationMode_BatchService = PoolAllocationMode("BatchService") PoolAllocationMode_UserSubscription = PoolAllocationMode("UserSubscription") )
const ( PublicNetworkAccessType_Disabled = PublicNetworkAccessType("Disabled") PublicNetworkAccessType_Enabled = PublicNetworkAccessType("Enabled") )
const ( EncryptionProperties_KeySource_MicrosoftBatch = EncryptionProperties_KeySource("Microsoft.Batch") EncryptionProperties_KeySource_MicrosoftKeyVault = EncryptionProperties_KeySource("Microsoft.KeyVault") )
const ( BatchAccountIdentity_Type_STATUS_None = BatchAccountIdentity_Type_STATUS("None") BatchAccountIdentity_Type_STATUS_SystemAssigned = BatchAccountIdentity_Type_STATUS("SystemAssigned") BatchAccountIdentity_Type_STATUS_UserAssigned = BatchAccountIdentity_Type_STATUS("UserAssigned") )
const ( BatchAccountProperties_ProvisioningState_STATUS_Cancelled = BatchAccountProperties_ProvisioningState_STATUS("Cancelled") BatchAccountProperties_ProvisioningState_STATUS_Creating = BatchAccountProperties_ProvisioningState_STATUS("Creating") BatchAccountProperties_ProvisioningState_STATUS_Deleting = BatchAccountProperties_ProvisioningState_STATUS("Deleting") BatchAccountProperties_ProvisioningState_STATUS_Failed = BatchAccountProperties_ProvisioningState_STATUS("Failed") BatchAccountProperties_ProvisioningState_STATUS_Invalid = BatchAccountProperties_ProvisioningState_STATUS("Invalid") BatchAccountProperties_ProvisioningState_STATUS_Succeeded = BatchAccountProperties_ProvisioningState_STATUS("Succeeded") )
const ( PoolAllocationMode_STATUS_BatchService = PoolAllocationMode_STATUS("BatchService") PoolAllocationMode_STATUS_UserSubscription = PoolAllocationMode_STATUS("UserSubscription") )
const ( PublicNetworkAccessType_STATUS_Disabled = PublicNetworkAccessType_STATUS("Disabled") PublicNetworkAccessType_STATUS_Enabled = PublicNetworkAccessType_STATUS("Enabled") )
const ( EncryptionProperties_KeySource_STATUS_MicrosoftBatch = EncryptionProperties_KeySource_STATUS("Microsoft.Batch") EncryptionProperties_KeySource_STATUS_MicrosoftKeyVault = EncryptionProperties_KeySource_STATUS("Microsoft.KeyVault") )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AutoStorageBaseProperties ¶
type AutoStorageBaseProperties struct {
StorageAccountId *string `json:"storageAccountId,omitempty"`
}
The properties related to the auto-storage account.
type AutoStorageProperties_STATUS ¶
type AutoStorageProperties_STATUS struct {
// LastKeySync: The UTC time at which storage keys were last synchronized with the Batch account.
LastKeySync *string `json:"lastKeySync,omitempty"`
// StorageAccountId: The resource ID of the storage account to be used for auto-storage account.
StorageAccountId *string `json:"storageAccountId,omitempty"`
}
Contains information about the auto-storage account associated with a Batch account.
type BatchAccountCreateProperties ¶
type BatchAccountCreateProperties struct {
// AutoStorage: The properties related to the auto-storage account.
AutoStorage *AutoStorageBaseProperties `json:"autoStorage,omitempty"`
// Encryption: Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using
// a Microsoft managed key. For additional control, a customer-managed key can be used instead.
Encryption *EncryptionProperties `json:"encryption,omitempty"`
// KeyVaultReference: A reference to the Azure key vault associated with the Batch account.
KeyVaultReference *KeyVaultReference `json:"keyVaultReference,omitempty"`
// PoolAllocationMode: The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the
// mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is
// UserSubscription, clients must use Azure Active Directory. The default is BatchService.
PoolAllocationMode *PoolAllocationMode `json:"poolAllocationMode,omitempty"`
// PublicNetworkAccess: If not specified, the default value is 'enabled'.
PublicNetworkAccess *PublicNetworkAccessType `json:"publicNetworkAccess,omitempty"`
}
The properties of a Batch account.
type BatchAccountIdentity ¶
type BatchAccountIdentity struct {
// Type: The type of identity used for the Batch account.
Type *BatchAccountIdentity_Type `json:"type,omitempty"`
UserAssignedIdentities map[string]UserAssignedIdentityDetails `json:"userAssignedIdentities,omitempty"`
}
The identity of the Batch account, if configured. This is only used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration.
type BatchAccountIdentity_STATUS ¶
type BatchAccountIdentity_STATUS struct {
// PrincipalId: The principal id of the Batch account. This property will only be provided for a system assigned identity.
PrincipalId *string `json:"principalId,omitempty"`
// TenantId: The tenant id associated with the Batch account. This property will only be provided for a system assigned
// identity.
TenantId *string `json:"tenantId,omitempty"`
// Type: The type of identity used for the Batch account.
Type *BatchAccountIdentity_Type_STATUS `json:"type,omitempty"`
// UserAssignedIdentities: The list of user identities associated with the Batch account. The user identity dictionary key
// references will be ARM resource ids in the form:
// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
UserAssignedIdentities map[string]BatchAccountIdentity_UserAssignedIdentities_STATUS `json:"userAssignedIdentities,omitempty"`
}
The identity of the Batch account, if configured. This is only used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration.
type BatchAccountIdentity_Type ¶
type BatchAccountIdentity_Type string
+kubebuilder:validation:Enum={"None","SystemAssigned","UserAssigned"}
type BatchAccountIdentity_Type_STATUS ¶
type BatchAccountIdentity_Type_STATUS string
type BatchAccountProperties_ProvisioningState_STATUS ¶
type BatchAccountProperties_ProvisioningState_STATUS string
type BatchAccountProperties_STATUS ¶
type BatchAccountProperties_STATUS struct {
// AccountEndpoint: The account endpoint used to interact with the Batch service.
AccountEndpoint *string `json:"accountEndpoint,omitempty"`
ActiveJobAndJobScheduleQuota *int `json:"activeJobAndJobScheduleQuota,omitempty"`
// AutoStorage: Contains information about the auto-storage account associated with a Batch account.
AutoStorage *AutoStorageProperties_STATUS `json:"autoStorage,omitempty"`
// DedicatedCoreQuota: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription
// so this value is not returned.
DedicatedCoreQuota *int `json:"dedicatedCoreQuota,omitempty"`
// DedicatedCoreQuotaPerVMFamily: A list of the dedicated core quota per Virtual Machine family for the Batch account. For
// accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not
// returned.
DedicatedCoreQuotaPerVMFamily []VirtualMachineFamilyCoreQuota_STATUS `json:"dedicatedCoreQuotaPerVMFamily,omitempty"`
// DedicatedCoreQuotaPerVMFamilyEnforced: Batch is transitioning its core quota system for dedicated cores to be enforced
// per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not
// yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the
// account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the
// dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
DedicatedCoreQuotaPerVMFamilyEnforced *bool `json:"dedicatedCoreQuotaPerVMFamilyEnforced,omitempty"`
// Encryption: Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using
// a Microsoft managed key. For additional control, a customer-managed key can be used instead.
Encryption *EncryptionProperties_STATUS `json:"encryption,omitempty"`
// KeyVaultReference: Identifies the Azure key vault associated with a Batch account.
KeyVaultReference *KeyVaultReference_STATUS `json:"keyVaultReference,omitempty"`
// LowPriorityCoreQuota: For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription
// so this value is not returned.
LowPriorityCoreQuota *int `json:"lowPriorityCoreQuota,omitempty"`
// PoolAllocationMode: The allocation mode for creating pools in the Batch account.
PoolAllocationMode *PoolAllocationMode_STATUS `json:"poolAllocationMode,omitempty"`
PoolQuota *int `json:"poolQuota,omitempty"`
// PrivateEndpointConnections: List of private endpoint connections associated with the Batch account
PrivateEndpointConnections []PrivateEndpointConnection_STATUS `json:"privateEndpointConnections,omitempty"`
// ProvisioningState: The provisioned state of the resource
ProvisioningState *BatchAccountProperties_ProvisioningState_STATUS `json:"provisioningState,omitempty"`
// PublicNetworkAccess: If not specified, the default value is 'enabled'.
PublicNetworkAccess *PublicNetworkAccessType_STATUS `json:"publicNetworkAccess,omitempty"`
}
Account specific properties.
type BatchAccount_STATUS ¶
type BatchAccount_STATUS struct {
// Id: The ID of the resource.
Id *string `json:"id,omitempty"`
// Identity: The identity of the Batch account.
Identity *BatchAccountIdentity_STATUS `json:"identity,omitempty"`
// Location: The location of the resource.
Location *string `json:"location,omitempty"`
// Name: The name of the resource.
Name *string `json:"name,omitempty"`
// Properties: The properties associated with the account.
Properties *BatchAccountProperties_STATUS `json:"properties,omitempty"`
// Tags: The tags of the resource.
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of the resource.
Type *string `json:"type,omitempty"`
}
Contains information about an Azure Batch account.
type BatchAccount_Spec ¶
type BatchAccount_Spec struct {
// Identity: The identity of the Batch account.
Identity *BatchAccountIdentity `json:"identity,omitempty"`
// Location: The region in which to create the account.
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: The properties of the Batch account.
Properties *BatchAccountCreateProperties `json:"properties,omitempty"`
// Tags: The user-specified tags associated with the account.
Tags map[string]string `json:"tags,omitempty"`
}
func (BatchAccount_Spec) GetAPIVersion ¶
func (account BatchAccount_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2021-01-01"
func (*BatchAccount_Spec) GetName ¶
func (account *BatchAccount_Spec) GetName() string
GetName returns the Name of the resource
func (*BatchAccount_Spec) GetType ¶
func (account *BatchAccount_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.Batch/batchAccounts"
type EncryptionProperties ¶
type EncryptionProperties struct {
// KeySource: Type of the key source.
KeySource *EncryptionProperties_KeySource `json:"keySource,omitempty"`
// KeyVaultProperties: Additional details when using Microsoft.KeyVault
KeyVaultProperties *KeyVaultProperties `json:"keyVaultProperties,omitempty"`
}
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
type EncryptionProperties_KeySource ¶
type EncryptionProperties_KeySource string
+kubebuilder:validation:Enum={"Microsoft.Batch","Microsoft.KeyVault"}
type EncryptionProperties_KeySource_STATUS ¶
type EncryptionProperties_KeySource_STATUS string
type EncryptionProperties_STATUS ¶
type EncryptionProperties_STATUS struct {
// KeySource: Type of the key source.
KeySource *EncryptionProperties_KeySource_STATUS `json:"keySource,omitempty"`
// KeyVaultProperties: Additional details when using Microsoft.KeyVault
KeyVaultProperties *KeyVaultProperties_STATUS `json:"keyVaultProperties,omitempty"`
}
Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
type KeyVaultProperties ¶
type KeyVaultProperties struct {
// KeyIdentifier: Full path to the versioned secret. Example
// https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following
// prerequisites must be met:
// The Batch Account has a System Assigned identity
// The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions
// The KeyVault has soft-delete and purge protection enabled
KeyIdentifier *string `json:"keyIdentifier,omitempty"`
}
KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
type KeyVaultProperties_STATUS ¶
type KeyVaultProperties_STATUS struct {
// KeyIdentifier: Full path to the versioned secret. Example
// https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following
// prerequisites must be met:
// The Batch Account has a System Assigned identity
// The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions
// The KeyVault has soft-delete and purge protection enabled
KeyIdentifier *string `json:"keyIdentifier,omitempty"`
}
KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
type KeyVaultReference ¶
type KeyVaultReference struct {
Id *string `json:"id,omitempty"`
// Url: The URL of the Azure key vault associated with the Batch account.
Url *string `json:"url,omitempty"`
}
Identifies the Azure key vault associated with a Batch account.
type KeyVaultReference_STATUS ¶
type KeyVaultReference_STATUS struct {
// Id: The resource ID of the Azure key vault associated with the Batch account.
Id *string `json:"id,omitempty"`
// Url: The URL of the Azure key vault associated with the Batch account.
Url *string `json:"url,omitempty"`
}
Identifies the Azure key vault associated with a Batch account.
type PoolAllocationMode ¶
type PoolAllocationMode string
The allocation mode for creating pools in the Batch account. +kubebuilder:validation:Enum={"BatchService","UserSubscription"}
type PoolAllocationMode_STATUS ¶
type PoolAllocationMode_STATUS string
The allocation mode for creating pools in the Batch account.
type PrivateEndpointConnection_STATUS ¶
type PrivateEndpointConnection_STATUS struct {
// Id: The ID of the resource.
Id *string `json:"id,omitempty"`
}
Contains information about a private link resource.
type PublicNetworkAccessType ¶
type PublicNetworkAccessType string
The network access type for operating on the resources in the Batch account. +kubebuilder:validation:Enum={"Disabled","Enabled"}
type PublicNetworkAccessType_STATUS ¶
type PublicNetworkAccessType_STATUS string
The network access type for operating on the resources in the Batch account.
type UserAssignedIdentityDetails ¶
type UserAssignedIdentityDetails struct {
}
Information about the user assigned identity for the resource
type VirtualMachineFamilyCoreQuota_STATUS ¶
type VirtualMachineFamilyCoreQuota_STATUS struct {
// CoreQuota: The core quota for the VM family for the Batch account.
CoreQuota *int `json:"coreQuota,omitempty"`
// Name: The Virtual Machine family name.
Name *string `json:"name,omitempty"`
}
A VM Family and its associated core quota for the Batch account.