Package-level declarations

Types

Link copied to clipboard
data class ApiEntityReferenceResponse(val id: String? = null)

The API entity reference.

Link copied to clipboard
data class AzureFileVolumeResponse(val readOnly: Boolean? = null, val shareName: String, val storageAccountKey: String? = null, val storageAccountKeyReference: String? = null, val storageAccountName: String)

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

Link copied to clipboard
data class ConfidentialComputePropertiesResponse(val ccePolicy: String? = null)

The properties for confidential container group

Link copied to clipboard
data class ConfigMapResponse(val keyValuePairs: Map<String, String>? = null)

The container config map.

Link copied to clipboard
data class ContainerExecResponse(val command: List<String>? = null)

The container execution command, for liveness or readiness probe

Link copied to clipboard
data class ContainerGroupDiagnosticsResponse(val logAnalytics: LogAnalyticsResponse? = null)

Container group diagnostic information.

Link copied to clipboard
data class ContainerGroupIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentitiesResponse>? = null)

Identity for the container group.

Link copied to clipboard

The object that contains a reference to a Container Group Profile

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

Link copied to clipboard
data class ContainerGroupSubnetIdResponse(val id: String, val name: String? = null)

Container group subnet information.

Link copied to clipboard
data class ContainerHttpGetResponse(val httpHeaders: List<HttpHeaderResponse>? = null, val path: String? = null, val port: Int, val scheme: String? = null)

The container Http Get settings, for liveness or readiness probe

Link copied to clipboard
data class ContainerPortResponse(val port: Int, val protocol: String? = null)

The port exposed on the container instance.

Link copied to clipboard
data class ContainerProbeResponse(val exec: ContainerExecResponse? = null, val failureThreshold: Int? = null, val httpGet: ContainerHttpGetResponse? = null, val initialDelaySeconds: Int? = null, val periodSeconds: Int? = null, val successThreshold: Int? = null, val timeoutSeconds: Int? = null)

The container probe, for liveness or readiness

Link copied to clipboard
data class ContainerPropertiesResponseInstanceView(val currentState: ContainerStateResponse, val events: List<EventResponse>, val previousState: ContainerStateResponse, val restartCount: Int)

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

Link copied to clipboard
data class ContainerResponse(val command: List<String>? = null, val configMap: ConfigMapResponse? = null, val environmentVariables: List<EnvironmentVariableResponse>? = null, val image: String? = null, val instanceView: ContainerPropertiesResponseInstanceView, val livenessProbe: ContainerProbeResponse? = null, val name: String, val ports: List<ContainerPortResponse>? = null, val readinessProbe: ContainerProbeResponse? = null, val resources: ResourceRequirementsResponse? = null, val securityContext: SecurityContextDefinitionResponse? = null, val volumeMounts: List<VolumeMountResponse>? = null)

A container instance.

Link copied to clipboard
data class ContainerStateResponse(val detailStatus: String, val exitCode: Int, val finishTime: String, val startTime: String, val state: String)

The container instance state.

Link copied to clipboard
data class DeploymentExtensionSpecResponse(val extensionType: String, val name: String, val protectedSettings: Any? = null, val settings: Any? = null, val version: String)

Extension sidecars to be added to the deployment.

Link copied to clipboard
data class DnsConfigurationResponse(val nameServers: List<String>, val options: String? = null, val searchDomains: String? = null)

DNS configuration for the container group.

Link copied to clipboard
data class ElasticProfileResponse(val desiredCount: Int? = null)

Describes the elastic profile of the Container Scale Set

Link copied to clipboard
data class EncryptionPropertiesResponse(val identity: String? = null, val keyName: String, val keyVersion: String, val vaultBaseUrl: String)

The container group encryption properties.

Link copied to clipboard
data class EnvironmentVariableResponse(val name: String, val secureValue: String? = null, val secureValueReference: String? = null, val value: String? = null)

The environment variable to set within the container instance.

Link copied to clipboard
data class EventResponse(val count: Int, val firstTimestamp: String, val lastTimestamp: String, val message: String, val name: String, val type: String)

A container group or container instance event.

Link copied to clipboard
data class GetCGProfileResult(val confidentialComputeProperties: ConfidentialComputePropertiesResponse? = null, val containers: List<ContainerResponse>? = null, val diagnostics: ContainerGroupDiagnosticsResponse? = null, val encryptionProperties: EncryptionPropertiesResponse? = null, val extensions: List<DeploymentExtensionSpecResponse>? = null, val id: String, val imageRegistryCredentials: List<ImageRegistryCredentialResponse>? = null, val initContainers: List<InitContainerDefinitionResponse>? = null, val ipAddress: IpAddressResponse? = null, val location: String? = null, val name: String, val osType: String? = null, val priority: String? = null, val registeredRevisions: List<Double>? = null, val restartPolicy: String? = null, val revision: Double? = null, val securityContext: SecurityContextDefinitionResponse? = null, val shutdownGracePeriod: String? = null, val sku: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val timeToLive: String? = null, val type: String, val useKrypton: Boolean? = null, val volumes: List<VolumeResponse>? = null, val zones: List<String>? = null)

container group profile object

Link copied to clipboard
data class GetContainerGroupProfileResult(val confidentialComputeProperties: ConfidentialComputePropertiesResponse? = null, val containers: List<ContainerResponse>, val diagnostics: ContainerGroupDiagnosticsResponse? = null, val encryptionProperties: EncryptionPropertiesResponse? = null, val extensions: List<DeploymentExtensionSpecResponse>? = null, val id: String, val imageRegistryCredentials: List<ImageRegistryCredentialResponse>? = null, val initContainers: List<InitContainerDefinitionResponse>? = null, val ipAddress: IpAddressResponse? = null, val location: String? = null, val name: String, val osType: String, val priority: String? = null, val restartPolicy: String? = null, val revision: Int, val sku: String? = null, val tags: Map<String, String>? = null, val type: String, val volumes: List<VolumeResponse>? = null, val zones: List<String>? = null)

A container group profile.

Link copied to clipboard
data class GetContainerGroupResult(val confidentialComputeProperties: ConfidentialComputePropertiesResponse? = null, val containers: List<ContainerResponse>, val diagnostics: ContainerGroupDiagnosticsResponse? = null, val dnsConfig: DnsConfigurationResponse? = null, val encryptionProperties: EncryptionPropertiesResponse? = null, val extensions: List<DeploymentExtensionSpecResponse>? = null, val id: String, val identity: ContainerGroupIdentityResponse? = null, val imageRegistryCredentials: List<ImageRegistryCredentialResponse>? = null, val initContainers: List<InitContainerDefinitionResponse>? = null, val instanceView: ContainerGroupPropertiesResponseInstanceView, val ipAddress: IpAddressResponse? = null, val location: String? = null, val name: String, val osType: String, val priority: String? = null, val provisioningState: String, val restartPolicy: String? = null, val sku: String? = null, val subnetIds: List<ContainerGroupSubnetIdResponse>? = null, val tags: Map<String, String>? = null, val type: String, val volumes: List<VolumeResponse>? = null, val zones: List<String>? = null)

A container group.

Link copied to clipboard
data class GetNGroupResult(val containerGroupProfiles: List<ContainerGroupProfileStubResponse>? = null, val elasticProfile: ElasticProfileResponse? = null, val id: String, val identity: NGroupIdentityResponse? = null, val location: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val zones: List<String>? = null)

Describes a nGroup.

Link copied to clipboard
data class GitRepoVolumeResponse(val directory: String? = null, val repository: String, val revision: String? = null)

Represents a volume that is populated with the contents of a git repository

Link copied to clipboard
data class GpuResourceResponse(val count: Int, val sku: String)

The GPU resource.

Link copied to clipboard
data class HttpHeaderResponse(val name: String? = null, val value: String? = null)

The HTTP header.

Link copied to clipboard
data class ImageRegistryCredentialResponse(val identity: String? = null, val identityUrl: String? = null, val password: String? = null, val passwordReference: String? = null, val server: String, val username: String? = null)

Image registry credential.

Link copied to clipboard
data class InitContainerDefinitionResponse(val command: List<String>? = null, val environmentVariables: List<EnvironmentVariableResponse>? = null, val image: String? = null, val instanceView: InitContainerPropertiesDefinitionResponseInstanceView, val name: String, val securityContext: SecurityContextDefinitionResponse? = null, val volumeMounts: List<VolumeMountResponse>? = null)

The init container definition.

data class InitContainerPropertiesDefinitionResponseInstanceView(val currentState: ContainerStateResponse, val events: List<EventResponse>, val previousState: ContainerStateResponse, val restartCount: Int)

The instance view of the init container. Only valid in response.

Link copied to clipboard
data class IpAddressResponse(val autoGeneratedDomainNameLabelScope: String? = null, val dnsNameLabel: String? = null, val fqdn: String, val ip: String? = null, val ports: List<PortResponse>, val type: String)

IP address for the container group.

Link copied to clipboard
data class LogAnalyticsResponse(val logType: String? = null, val metadata: Map<String, String>? = null, val workspaceId: String, val workspaceKey: String, val workspaceResourceId: String? = null)

Container group log analytics information.

Link copied to clipboard
data class NGroupIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Identity for the nGroup.

Link copied to clipboard
data class PortResponse(val port: Int, val protocol: String? = null)

The port exposed on the container group.

Link copied to clipboard
data class ResourceLimitsResponse(val cpu: Double? = null, val gpu: GpuResourceResponse? = null, val memoryInGB: Double? = null)

The resource limits.

Link copied to clipboard
data class ResourceRequestsResponse(val cpu: Double, val gpu: GpuResourceResponse? = null, val memoryInGB: Double)

The resource requests.

Link copied to clipboard

The resource requirements.

data class SecurityContextCapabilitiesDefinitionResponse(val add: List<String>? = null, val drop: List<String>? = null)

The capabilities to add or drop from a container.

Link copied to clipboard
data class SecurityContextDefinitionResponse(val allowPrivilegeEscalation: Boolean? = null, val capabilities: SecurityContextCapabilitiesDefinitionResponse? = null, val privileged: Boolean? = null, val runAsGroup: Int? = null, val runAsUser: Int? = null, val seccompProfile: String? = null)

The security context for the container.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserAssignedIdentitiesResponse(val clientId: String, val principalId: String)

The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties

Link copied to clipboard
data class VolumeMountResponse(val mountPath: String, val name: String, val readOnly: Boolean? = null)

The properties of the volume mount.

Link copied to clipboard
data class VolumeResponse(val azureFile: AzureFileVolumeResponse? = null, val emptyDir: Any? = null, val gitRepo: GitRepoVolumeResponse? = null, val name: String, val secret: Map<String, String>? = null, val secretReference: Map<String, String>? = null)

The properties of the volume.