Package-level declarations

Types

Link copied to clipboard
data class AddRemoveReplicaScalingMechanismResponse(val kind: String, val maxCount: Int, val minCount: Int, val scaleIncrement: Int)

Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).

data class ApplicationScopedVolumeCreationParametersServiceFabricVolumeDiskResponse(val description: String? = null, val kind: String, val sizeDisk: String)

Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks

Link copied to clipboard
data class ApplicationScopedVolumeResponse(val creationParameters: ApplicationScopedVolumeCreationParametersServiceFabricVolumeDiskResponse, val destinationPath: String, val name: String, val readOnly: Boolean? = null)

Describes a volume whose lifetime is scoped to the application's lifetime.

Link copied to clipboard

Describes the auto scaling policy

Link copied to clipboard
data class AutoScalingResourceMetricResponse(val kind: String, val name: String)

Describes the resource that is used for triggering auto scaling.

Link copied to clipboard
data class AverageLoadScalingTriggerResponse(val kind: String, val lowerLoadThreshold: Double, val metric: AutoScalingResourceMetricResponse, val scaleIntervalInSeconds: Int, val upperLoadThreshold: Double)

Describes the average load trigger used for auto scaling.

data class AzureInternalMonitoringPipelineSinkDescriptionResponse(val accountName: String? = null, val autoKeyConfigUrl: String? = null, val description: String? = null, val fluentdConfigUrl: Any? = null, val kind: String, val maConfigUrl: String? = null, val name: String? = null, val namespace: String? = null)

Diagnostics settings for Geneva.

Link copied to clipboard
data class ContainerCodePackagePropertiesResponse(val commands: List<String>? = null, val diagnostics: DiagnosticsRefResponse? = null, val endpoints: List<EndpointPropertiesResponse>? = null, val entrypoint: String? = null, val environmentVariables: List<EnvironmentVariableResponse>? = null, val image: String, val imageRegistryCredential: ImageRegistryCredentialResponse? = null, val instanceView: ContainerInstanceViewResponse, val labels: List<ContainerLabelResponse>? = null, val name: String, val reliableCollectionsRefs: List<ReliableCollectionsRefResponse>? = null, val resources: ResourceRequirementsResponse, val settings: List<SettingResponse>? = null, val volumeRefs: List<VolumeReferenceResponse>? = null, val volumes: List<ApplicationScopedVolumeResponse>? = null)

Describes a container and its runtime properties.

Link copied to clipboard
data class ContainerEventResponse(val count: Int? = null, val firstTimestamp: String? = null, val lastTimestamp: String? = null, val message: String? = null, val name: String? = null, val type: String? = null)

A container event.

Link copied to clipboard
data class ContainerInstanceViewResponse(val currentState: ContainerStateResponse? = null, val events: List<ContainerEventResponse>? = null, val previousState: ContainerStateResponse? = null, val restartCount: Int? = null)

Runtime information of a container instance.

Link copied to clipboard
data class ContainerLabelResponse(val name: String, val value: String)

Describes a container label.

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

The container state.

Link copied to clipboard
data class DiagnosticsDescriptionResponse(val defaultSinkRefs: List<String>? = null, val enabled: Boolean? = null, val sinks: List<AzureInternalMonitoringPipelineSinkDescriptionResponse>? = null)

Describes the diagnostics options available

Link copied to clipboard
data class DiagnosticsRefResponse(val enabled: Boolean? = null, val sinkRefs: List<String>? = null)

Reference to sinks in DiagnosticsDescription.

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

Describes a container endpoint.

Link copied to clipboard
data class EndpointRefResponse(val name: String? = null)

Describes a reference to a service endpoint.

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

Describes an environment variable for the container.

Link copied to clipboard
data class GatewayDestinationResponse(val applicationName: String, val endpointName: String, val serviceName: String)

Describes destination endpoint for routing traffic.

Link copied to clipboard
data class GetApplicationResult(val azureApiVersion: String, val debugParams: String? = null, val description: String? = null, val diagnostics: DiagnosticsDescriptionResponse? = null, val healthState: String, val id: String, val location: String, val name: String, val provisioningState: String, val serviceNames: List<String>, val services: List<ServiceResourceDescriptionResponse>? = null, val status: String, val statusDetails: String, val tags: Map<String, String>? = null, val type: String, val unhealthyEvaluation: String)

This type describes an application resource.

Link copied to clipboard
data class GetGatewayResult(val azureApiVersion: String, val description: String? = null, val destinationNetwork: NetworkRefResponse, val http: List<HttpConfigResponse>? = null, val id: String, val ipAddress: String, val location: String, val name: String, val provisioningState: String, val sourceNetwork: NetworkRefResponse, val status: String, val statusDetails: String, val tags: Map<String, String>? = null, val tcp: List<TcpConfigResponse>? = null, val type: String)

This type describes a gateway resource.

Link copied to clipboard
data class GetNetworkResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: NetworkResourcePropertiesResponse, val tags: Map<String, String>? = null, val type: String)

This type describes a network resource.

Link copied to clipboard
data class GetSecretResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val properties: SecretResourcePropertiesResponse, val tags: Map<String, String>? = null, val type: String)

This type describes a secret resource.

Link copied to clipboard
data class GetSecretValueResult(val azureApiVersion: String, val id: String, val location: String, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val value: String? = null)

This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.

Link copied to clipboard
data class GetVolumeResult(val azureApiVersion: String, val azureFileParameters: VolumeProviderParametersAzureFileResponse? = null, val description: String? = null, val id: String, val location: String, val name: String, val provider: String, val provisioningState: String, val status: String, val statusDetails: String, val tags: Map<String, String>? = null, val type: String)

This type describes a volume resource.

Link copied to clipboard
data class HttpConfigResponse(val hosts: List<HttpHostConfigResponse>, val name: String, val port: Int)

Describes the http configuration for external connectivity for this network.

Link copied to clipboard
data class HttpHostConfigResponse(val name: String, val routes: List<HttpRouteConfigResponse>)

Describes the hostname properties for http routing.

Link copied to clipboard
data class HttpRouteConfigResponse(val destination: GatewayDestinationResponse, val match: HttpRouteMatchRuleResponse, val name: String)

Describes the hostname properties for http routing.

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

Describes header information for http route matching.

Link copied to clipboard
data class HttpRouteMatchPathResponse(val rewrite: String? = null, val type: String, val value: String)

Path to match for routing.

Link copied to clipboard

Describes a rule for http route matching.

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

Image registry credential.

Link copied to clipboard
data class ListSecretValueResult(val value: String? = null)

This type represents the unencrypted value of the secret.

Link copied to clipboard
data class NetworkRefResponse(val endpointRefs: List<EndpointRefResponse>? = null, val name: String? = null)

Describes a network reference in a service.

Link copied to clipboard
data class NetworkResourcePropertiesResponse(val description: String? = null, val kind: String, val provisioningState: String, val status: String, val statusDetails: String)

Describes properties of a network resource.

Link copied to clipboard
data class ReliableCollectionsRefResponse(val doNotPersistState: Boolean? = null, val name: String)

Specifying this parameter adds support for reliable collections

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

This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.

Link copied to clipboard
data class ResourceRequestsResponse(val cpu: Double, val memoryInGB: Double)

This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.

Link copied to clipboard

This type describes the resource requirements for a container or a service.

Link copied to clipboard
data class SecretResourcePropertiesResponse(val contentType: String? = null, val description: String? = null, val kind: String, val provisioningState: String, val status: String, val statusDetails: String)

Describes the properties of a secret resource.

Link copied to clipboard
data class ServiceResourceDescriptionResponse(val autoScalingPolicies: List<AutoScalingPolicyResponse>? = null, val codePackages: List<ContainerCodePackagePropertiesResponse>, val description: String? = null, val diagnostics: DiagnosticsRefResponse? = null, val healthState: String, val id: String, val name: String? = null, val networkRefs: List<NetworkRefResponse>? = null, val osType: String, val provisioningState: String, val replicaCount: Int? = null, val status: String, val statusDetails: String, val type: String, val unhealthyEvaluation: String)

This type describes a service resource.

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

Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets".

Link copied to clipboard
data class TcpConfigResponse(val destination: GatewayDestinationResponse, val name: String, val port: Int)

Describes the tcp configuration for external connectivity for this network.

data class VolumeProviderParametersAzureFileResponse(val accountKey: String? = null, val accountName: String, val shareName: String)

This type describes a volume provided by an Azure Files file share.

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

Describes a reference to a volume resource.