Package-level declarations

Types

Link copied to clipboard
data class ApplicationDeltaHealthPolicyResponse(val defaultServiceTypeDeltaHealthPolicy: ServiceTypeDeltaHealthPolicyResponse? = null, val serviceTypeDeltaHealthPolicies: Map<String, ServiceTypeDeltaHealthPolicyResponse>? = null)

Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.

Link copied to clipboard
data class ApplicationHealthPolicyResponse(val defaultServiceTypeHealthPolicy: ServiceTypeHealthPolicyResponse? = null, val serviceTypeHealthPolicies: Map<String, ServiceTypeHealthPolicyResponse>? = null)

Defines a health policy used to evaluate the health of an application or one of its children entities.

Link copied to clipboard
data class ApplicationMetricDescriptionResponse(val maximumCapacity: Double? = null, val name: String? = null, val reservationCapacity: Double? = null, val totalApplicationCapacity: Double? = null)

Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.

data class ApplicationTypeVersionsCleanupPolicyResponse(val maxUnusedVersionsToKeep: Double)
Link copied to clipboard
data class ApplicationUpgradePolicyResponse(val applicationHealthPolicy: ArmApplicationHealthPolicyResponse? = null, val forceRestart: Boolean? = null, val recreateApplication: Boolean? = null, val rollingUpgradeMonitoringPolicy: ArmRollingUpgradeMonitoringPolicyResponse? = null, val upgradeMode: String? = null, val upgradeReplicaSetCheckTimeout: String? = null)

Describes the policy for a monitored application upgrade.

Link copied to clipboard
data class ApplicationUserAssignedIdentityResponse(val name: String, val principalId: String)
Link copied to clipboard
data class ArmApplicationHealthPolicyResponse(val considerWarningAsError: Boolean? = null, val defaultServiceTypeHealthPolicy: ArmServiceTypeHealthPolicyResponse? = null, val maxPercentUnhealthyDeployedApplications: Int? = null, val serviceTypeHealthPolicyMap: Map<String, ArmServiceTypeHealthPolicyResponse>? = null)

Defines a health policy used to evaluate the health of an application or one of its children entities.

data class ArmRollingUpgradeMonitoringPolicyResponse(val failureAction: String? = null, val healthCheckRetryTimeout: String? = null, val healthCheckStableDuration: String? = null, val healthCheckWaitDuration: String? = null, val upgradeDomainTimeout: String? = null, val upgradeTimeout: String? = null)

The policy used for monitoring the application upgrade

Link copied to clipboard
data class ArmServiceTypeHealthPolicyResponse(val maxPercentUnhealthyPartitionsPerService: Int? = null, val maxPercentUnhealthyReplicasPerPartition: Int? = null, val maxPercentUnhealthyServices: Int? = null)

Represents the health policy used to evaluate the health of services belonging to a service type.

Link copied to clipboard
data class AzureActiveDirectoryResponse(val clientApplication: String? = null, val clusterApplication: String? = null, val tenantId: String? = null)

The settings to enable AAD authentication on the cluster.

Link copied to clipboard
data class CertificateDescriptionResponse(val thumbprint: String, val thumbprintSecondary: String? = null, val x509StoreName: String? = null)

Describes the certificate details.

Link copied to clipboard
data class ClientCertificateCommonNameResponse(val certificateCommonName: String, val certificateIssuerThumbprint: String, val isAdmin: Boolean)

Describes the client certificate details using common name.

Link copied to clipboard
data class ClientCertificateResponse(val commonName: String? = null, val isAdmin: Boolean, val issuerThumbprint: String? = null, val thumbprint: String? = null)

Client Certificate definition.

Link copied to clipboard
data class ClientCertificateThumbprintResponse(val certificateThumbprint: String, val isAdmin: Boolean)

Describes the client certificate details using thumbprint.

Link copied to clipboard
data class ClusterHealthPolicyResponse(val applicationHealthPolicies: Map<String, ApplicationHealthPolicyResponse>? = null, val maxPercentUnhealthyApplications: Int? = null, val maxPercentUnhealthyNodes: Int? = null)

Defines a health policy used to evaluate the health of the cluster or of a cluster node.

Link copied to clipboard
data class ClusterUpgradeDeltaHealthPolicyResponse(val applicationDeltaHealthPolicies: Map<String, ApplicationDeltaHealthPolicyResponse>? = null, val maxPercentDeltaUnhealthyApplications: Int, val maxPercentDeltaUnhealthyNodes: Int, val maxPercentUpgradeDomainDeltaUnhealthyNodes: Int)

Describes the delta health policies for the cluster upgrade.

Link copied to clipboard
data class ClusterUpgradePolicyResponse(val deltaHealthPolicy: ClusterUpgradeDeltaHealthPolicyResponse? = null, val forceRestart: Boolean? = null, val healthCheckRetryTimeout: String, val healthCheckStableDuration: String, val healthCheckWaitDuration: String, val healthPolicy: ClusterHealthPolicyResponse, val upgradeDomainTimeout: String, val upgradeReplicaSetCheckTimeout: String, val upgradeTimeout: String)

Describes the policy used when upgrading the cluster.

Link copied to clipboard
data class ClusterVersionDetailsResponse(val codeVersion: String? = null, val environment: String? = null, val supportExpiryUtc: String? = null)

The detail of the Service Fabric runtime version result

Link copied to clipboard
data class DiagnosticsStorageAccountConfigResponse(val blobEndpoint: String, val protectedAccountKeyName: String, val protectedAccountKeyName2: String? = null, val queueEndpoint: String, val storageAccountName: String, val tableEndpoint: String)

The storage account information for storing Service Fabric diagnostic logs.

Link copied to clipboard
data class EndpointRangeDescriptionResponse(val endPort: Int, val startPort: Int)

Port range details

Link copied to clipboard
data class GetApplicationResult(val etag: String, val id: String, val identity: ManagedIdentityResponse? = null, val location: String? = null, val managedIdentities: List<ApplicationUserAssignedIdentityResponse>? = null, val maximumNodes: Double? = null, val metrics: List<ApplicationMetricDescriptionResponse>? = null, val minimumNodes: Double? = null, val name: String, val parameters: Map<String, String>? = null, val provisioningState: String, val removeApplicationCapacity: Boolean? = null, val tags: Map<String, String>? = null, val type: String, val typeName: String? = null, val typeVersion: String? = null, val upgradePolicy: ApplicationUpgradePolicyResponse? = null)

The application resource.

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

The application type name resource

Link copied to clipboard
data class GetApplicationTypeVersionResult(val appPackageUrl: String, val defaultParameterList: Map<String, String>, val etag: String, val id: String, val location: String? = null, val name: String, val provisioningState: String, val tags: Map<String, String>? = null, val type: String)

An application type version resource for the specified application type name resource.

Link copied to clipboard
data class GetClusterResult(val addOnFeatures: List<String>? = null, val applicationTypeVersionsCleanupPolicy: ApplicationTypeVersionsCleanupPolicyResponse? = null, val availableClusterVersions: List<ClusterVersionDetailsResponse>, val azureActiveDirectory: AzureActiveDirectoryResponse? = null, val certificate: CertificateDescriptionResponse? = null, val certificateCommonNames: ServerCertificateCommonNamesResponse? = null, val clientCertificateCommonNames: List<ClientCertificateCommonNameResponse>? = null, val clientCertificateThumbprints: List<ClientCertificateThumbprintResponse>? = null, val clusterCodeVersion: String? = null, val clusterEndpoint: String, val clusterId: String, val clusterState: String, val diagnosticsStorageAccountConfig: DiagnosticsStorageAccountConfigResponse? = null, val etag: String, val eventStoreServiceEnabled: Boolean? = null, val fabricSettings: List<SettingsSectionDescriptionResponse>? = null, val id: String, val location: String, val managementEndpoint: String, val name: String, val nodeTypes: List<NodeTypeDescriptionResponse>, val provisioningState: String, val reliabilityLevel: String? = null, val reverseProxyCertificate: CertificateDescriptionResponse? = null, val reverseProxyCertificateCommonNames: ServerCertificateCommonNamesResponse? = null, val tags: Map<String, String>? = null, val type: String, val upgradeDescription: ClusterUpgradePolicyResponse? = null, val upgradeMode: String? = null, val vmImage: String? = null)

The cluster resource

Link copied to clipboard
data class GetmanagedAzResiliencyStatusResult(val baseResourceStatus: List<ResourceAzStatusResponse>? = null, val isClusterZoneResilient: Boolean)

Describes the result of the request to list Managed VM Sizes for Service Fabric Managed Clusters.

Link copied to clipboard
data class GetManagedClusterResult(val addonFeatures: List<String>? = null, val adminPassword: String? = null, val adminUserName: String, val azureActiveDirectory: AzureActiveDirectoryResponse? = null, val clientConnectionPort: Int? = null, val clients: List<ClientCertificateResponse>? = null, val clusterCertificateThumbprint: String, val clusterCodeVersion: String? = null, val clusterId: String, val clusterState: String, val dnsName: String, val etag: String, val fabricSettings: List<SettingsSectionDescriptionResponse>? = null, val fqdn: String, val httpGatewayConnectionPort: Int? = null, val id: String, val loadBalancingRules: List<LoadBalancingRuleResponse>? = null, val location: String, val name: String, val provisioningState: String, val sku: SkuResponse? = null, val tags: Map<String, String>? = null, val type: String)

The manged cluster resource

Link copied to clipboard
data class GetNodeTypeResult(val applicationPorts: EndpointRangeDescriptionResponse? = null, val capacities: Map<String, String>? = null, val dataDiskSizeGB: Int, val ephemeralPorts: EndpointRangeDescriptionResponse? = null, val id: String, val isPrimary: Boolean, val name: String, val placementProperties: Map<String, String>? = null, val provisioningState: String, val tags: Map<String, String>? = null, val type: String, val vmExtensions: List<VMSSExtensionResponse>? = null, val vmImageOffer: String? = null, val vmImagePublisher: String? = null, val vmImageSku: String? = null, val vmImageVersion: String? = null, val vmInstanceCount: Int, val vmSecrets: List<VaultSecretGroupResponse>? = null, val vmSize: String? = null)

Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.

Link copied to clipboard
data class GetServiceResult(val correlationScheme: List<ServiceCorrelationDescriptionResponse>? = null, val defaultMoveCost: String? = null, val etag: String, val id: String, val location: String? = null, val name: String, val partitionDescription: Any? = null, val placementConstraints: String? = null, val provisioningState: String, val serviceDnsName: String? = null, val serviceKind: String, val serviceLoadMetrics: List<ServiceLoadMetricDescriptionResponse>? = null, val servicePackageActivationMode: String? = null, val servicePlacementPolicies: List<ServicePlacementPolicyDescriptionResponse>? = null, val serviceTypeName: String? = null, val tags: Map<String, String>? = null, val type: String)

The service resource.

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

The list of intermediate cluster code versions for an upgrade or downgrade. Or minimum and maximum upgradable version if no target was given

Link copied to clipboard
data class LoadBalancingRuleResponse(val backendPort: Int, val frontendPort: Int, val probeProtocol: String, val probeRequestPath: String? = null, val protocol: String)

Describes a load balancing rule.

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

Describes the managed identities for an Azure resource.

Link copied to clipboard
data class NamedPartitionSchemeDescriptionResponse(val count: Int, val names: List<String>, val partitionScheme: String)

Describes the named partition scheme of the service.

Link copied to clipboard
data class NodeTypeDescriptionResponse(val applicationPorts: EndpointRangeDescriptionResponse? = null, val capacities: Map<String, String>? = null, val clientConnectionEndpointPort: Int, val durabilityLevel: String? = null, val ephemeralPorts: EndpointRangeDescriptionResponse? = null, val httpGatewayEndpointPort: Int, val isPrimary: Boolean, val name: String, val placementProperties: Map<String, String>? = null, val reverseProxyEndpointPort: Int? = null, val vmInstanceCount: Int)

Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.

Link copied to clipboard
data class ResourceAzStatusResponse(val isZoneResilient: Boolean, val resourceName: String, val resourceType: String)

Describes Az Resiliency status of Base resources

Link copied to clipboard
data class ServerCertificateCommonNameResponse(val certificateCommonName: String, val certificateIssuerThumbprint: String)

Describes the server certificate details using common name.

Link copied to clipboard
data class ServerCertificateCommonNamesResponse(val commonNames: List<ServerCertificateCommonNameResponse>? = null, val x509StoreName: String? = null)

Describes a list of server certificates referenced by common name that are used to secure the cluster.

Link copied to clipboard
data class ServiceCorrelationDescriptionResponse(val scheme: String, val serviceName: String)

Creates a particular correlation between services.

Link copied to clipboard
data class ServiceLoadMetricDescriptionResponse(val defaultLoad: Int? = null, val name: String, val primaryDefaultLoad: Int? = null, val secondaryDefaultLoad: Int? = null, val weight: String? = null)

Specifies a metric to load balance a service during runtime.

Describes the policy to be used for placement of a Service Fabric service.

Link copied to clipboard
data class ServiceTypeDeltaHealthPolicyResponse(val maxPercentDeltaUnhealthyServices: Int? = null)

Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.

Link copied to clipboard
data class ServiceTypeHealthPolicyResponse(val maxPercentUnhealthyServices: Int? = null)

Represents the health policy used to evaluate the health of services belonging to a service type.

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

Describes a parameter in fabric settings of the cluster.

Link copied to clipboard

Describes a section in the fabric settings of the cluster.

data class SingletonPartitionSchemeDescriptionResponse(val partitionScheme: String)

Describes the partition scheme of a singleton-partitioned, or non-partitioned service.

Link copied to clipboard
data class SkuResponse(val name: String)

Sku definition

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

Azure resource identifier.

data class UniformInt64RangePartitionSchemeDescriptionResponse(val count: Int, val highKey: String, val lowKey: String, val partitionScheme: String)

Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.

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

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Link copied to clipboard
data class VaultSecretGroupResponse(val sourceVault: SubResourceResponse, val vaultCertificates: List<VaultCertificateResponse>)

Specifies set of certificates that should be installed onto the virtual machines.

Link copied to clipboard
data class VMSSExtensionResponse(val autoUpgradeMinorVersion: Boolean? = null, val forceUpdateTag: String? = null, val name: String, val protectedSettings: Any? = null, val provisionAfterExtensions: List<String>? = null, val provisioningState: String, val publisher: String, val settings: Any? = null, val type: String, val typeHandlerVersion: String)

Specifies set of extensions that should be installed onto the virtual machines.