Package-level declarations

Types

data class AddRemoveIncrementalNamedPartitionScalingMechanismResponse(val kind: String, val maxPartitionCount: Int, val minPartitionCount: Int, val scaleIncrement: Int)

Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1'...'N-1'.

Link copied to clipboard
data class ApplicationHealthPolicyResponse(val considerWarningAsError: Boolean, val defaultServiceTypeHealthPolicy: ServiceTypeHealthPolicyResponse? = null, val maxPercentUnhealthyDeployedApplications: Int, val serviceTypeHealthPolicyMap: Map<String, ServiceTypeHealthPolicyResponse>? = null)

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

data class ApplicationTypeVersionsCleanupPolicyResponse(val maxUnusedVersionsToKeep: Int)

The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3.

Link copied to clipboard
data class ApplicationUpgradePolicyResponse(val applicationHealthPolicy: ApplicationHealthPolicyResponse? = null, val forceRestart: Boolean? = null, val instanceCloseDelayDuration: Double? = null, val recreateApplication: Boolean? = null, val rollingUpgradeMonitoringPolicy: RollingUpgradeMonitoringPolicyResponse? = null, val upgradeMode: String? = null, val upgradeReplicaSetCheckTimeout: Double? = null)

Describes the policy for a monitored application upgrade.

Link copied to clipboard
data class ApplicationUserAssignedIdentityResponse(val name: String, val principalId: String)
data class AveragePartitionLoadScalingTriggerResponse(val kind: String, val lowerLoadThreshold: Double, val metricName: String, val scaleInterval: String, val upperLoadThreshold: Double)

Represents a scaling trigger related to an average load of a metric/resource of a partition.

Link copied to clipboard
data class AverageServiceLoadScalingTriggerResponse(val kind: String, val lowerLoadThreshold: Double, val metricName: String, val scaleInterval: String, val upperLoadThreshold: Double, val useOnlyPrimaryLoad: Boolean)

Represents a scaling policy related to an average load of a metric/resource of a service.

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 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 EndpointRangeDescriptionResponse(val endPort: Int, val startPort: Int)

Port range details

Link copied to clipboard
data class FaultSimulationConstraintsResponse(val expirationTime: String? = null)

Constraints for Fault Simulation action.

Link copied to clipboard
data class FaultSimulationDetailsResponse(val clusterId: String? = null, val nodeTypeFaultSimulation: List<NodeTypeFaultSimulationResponse>? = null, val operationId: String? = null, val parameters: ZoneFaultSimulationContentResponse? = null)

Details for Fault Simulation.

Link copied to clipboard
data class FaultSimulationResponse(val details: FaultSimulationDetailsResponse? = null, val endTime: String? = null, val simulationId: String? = null, val startTime: String? = null, val status: String? = null)

Fault simulation object with status.

Link copied to clipboard
data class FrontendConfigurationResponse(val applicationGatewayBackendAddressPoolId: String? = null, val ipAddressType: String? = null, val loadBalancerBackendAddressPoolId: String? = null, val loadBalancerInboundNatPoolId: String? = null)

Describes the frontend configurations for the node type.

Link copied to clipboard
data class GetApplicationResult(val id: String, val identity: ManagedIdentityResponse? = null, val location: String? = null, val managedIdentities: List<ApplicationUserAssignedIdentityResponse>? = null, val name: String, val parameters: Map<String, String>? = null, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val upgradePolicy: ApplicationUpgradePolicyResponse? = null, val version: String? = null)

The application resource.

Link copied to clipboard
data class GetApplicationTypeResult(val id: String, val location: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, 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 id: String, val location: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, 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 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 GetManagedClusterApplicationResult(val id: String, val identity: ManagedIdentityResponse? = null, val location: String? = null, val managedIdentities: List<ApplicationUserAssignedIdentityResponse>? = null, val name: String, val parameters: Map<String, String>? = null, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val upgradePolicy: ApplicationUpgradePolicyResponse? = null, val version: String? = null)

The application resource.

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

The application type name resource

data class GetManagedClusterApplicationTypeVersionResult(val appPackageUrl: String, val id: String, val location: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, 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 GetManagedClusterFaultSimulationResult(val details: FaultSimulationDetailsResponse? = null, val endTime: String? = null, val simulationId: String? = null, val startTime: String? = null, val status: String? = null)

Fault simulation object with status.

Link copied to clipboard
data class GetManagedClusterResult(val addonFeatures: List<String>? = null, val adminPassword: String? = null, val adminUserName: String, val allowRdpAccess: Boolean? = null, val applicationTypeVersionsCleanupPolicy: ApplicationTypeVersionsCleanupPolicyResponse? = null, val auxiliarySubnets: List<SubnetResponse>? = null, val azureActiveDirectory: AzureActiveDirectoryResponse? = null, val clientConnectionPort: Int? = null, val clients: List<ClientCertificateResponse>? = null, val clusterCertificateThumbprints: List<String>, val clusterCodeVersion: String? = null, val clusterId: String, val clusterState: String, val clusterUpgradeCadence: String? = null, val clusterUpgradeMode: String? = null, val dnsName: String, val enableAutoOSUpgrade: Boolean? = null, val enableIpv6: Boolean? = null, val enableServicePublicIP: Boolean? = null, val etag: String, val fabricSettings: List<SettingsSectionDescriptionResponse>? = null, val fqdn: String, val httpGatewayConnectionPort: Int? = null, val id: String, val ipTags: List<IPTagResponse>? = null, val ipv4Address: String, val ipv6Address: String, val loadBalancingRules: List<LoadBalancingRuleResponse>? = null, val location: String, val name: String, val networkSecurityRules: List<NetworkSecurityRuleResponse>? = null, val provisioningState: String, val publicIPPrefixId: String? = null, val serviceEndpoints: List<ServiceEndpointResponse>? = null, val sku: SkuResponse, val subnetId: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val useCustomVnet: Boolean? = null, val zonalResiliency: Boolean? = null, val zonalUpdateMode: String? = null)

The managed cluster resource

Link copied to clipboard
data class GetManagedClusterServiceResult(val id: String, val location: String? = null, val name: String, val properties: Either<StatefulServicePropertiesResponse, StatelessServicePropertiesResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The service resource.

Link copied to clipboard
data class GetmanagedMaintenanceWindowStatusResult(val canApplyUpdates: Boolean, val isRegionReady: Boolean, val isWindowActive: Boolean, val isWindowEnabled: Boolean, val lastWindowEndTimeUTC: String, val lastWindowStartTimeUTC: String, val lastWindowStatusUpdateAtUTC: String)

Describes the maintenance window status of the Service Fabric Managed Cluster.

Link copied to clipboard
data class GetNodeTypeFaultSimulationResult(val details: FaultSimulationDetailsResponse? = null, val endTime: String? = null, val simulationId: String? = null, val startTime: String? = null, val status: String? = null)

Fault simulation object with status.

Link copied to clipboard
data class GetNodeTypeResult(val additionalDataDisks: List<VmssDataDiskResponse>? = null, val applicationPorts: EndpointRangeDescriptionResponse? = null, val capacities: Map<String, String>? = null, val dataDiskLetter: String? = null, val dataDiskSizeGB: Int? = null, val dataDiskType: String? = null, val enableAcceleratedNetworking: Boolean? = null, val enableEncryptionAtHost: Boolean? = null, val enableNodePublicIP: Boolean? = null, val enableOverProvisioning: Boolean? = null, val ephemeralPorts: EndpointRangeDescriptionResponse? = null, val evictionPolicy: String? = null, val frontendConfigurations: List<FrontendConfigurationResponse>? = null, val hostGroupId: String? = null, val id: String, val isPrimary: Boolean, val isSpotVM: Boolean? = null, val isStateless: Boolean? = null, val multiplePlacementGroups: Boolean? = null, val name: String, val natGatewayId: String? = null, val networkSecurityRules: List<NetworkSecurityRuleResponse>? = null, val placementProperties: Map<String, String>? = null, val provisioningState: String, val secureBootEnabled: Boolean? = null, val securityType: String? = null, val sku: NodeTypeSkuResponse? = null, val spotRestoreTimeout: String? = null, val subnetId: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val useDefaultPublicLoadBalancer: Boolean? = null, val useEphemeralOSDisk: Boolean? = null, val useTempDataDisk: Boolean? = null, val vmExtensions: List<VMSSExtensionResponse>? = null, val vmImageOffer: String? = null, val vmImagePlan: VmImagePlanResponse? = null, val vmImagePublisher: String? = null, val vmImageResourceId: String? = null, val vmImageSku: String? = null, val vmImageVersion: String? = null, val vmInstanceCount: Int, val vmManagedIdentity: VmManagedIdentityResponse? = null, val vmSecrets: List<VaultSecretGroupResponse>? = null, val vmSetupActions: List<String>? = null, val vmSharedGalleryImageId: String? = null, val vmSize: String? = null, val zones: List<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 id: String, val location: String? = null, val name: String, val properties: Either<StatefulServicePropertiesResponse, StatelessServicePropertiesResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The service resource.

Link copied to clipboard
data class IPTagResponse(val ipTagType: String, val tag: String)

IPTag associated with the object.

Link copied to clipboard
data class ListManagedClusterFaultSimulationResult(val nextLink: String? = null, val value: List<FaultSimulationResponse>)

Fault simulation list results

Link copied to clipboard
data class ListNodeTypeFaultSimulationResult(val nextLink: String? = null, val value: List<FaultSimulationResponse>)

Fault simulation list results

Link copied to clipboard
data class LoadBalancingRuleResponse(val backendPort: Int, val frontendPort: Int, val loadDistribution: String? = null, val probePort: Int? = null, 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 NamedPartitionSchemeResponse(val names: List<String>, val partitionScheme: String)

Describes the named partition scheme of the service.

Link copied to clipboard
data class NetworkSecurityRuleResponse(val access: String, val description: String? = null, val destinationAddressPrefix: String? = null, val destinationAddressPrefixes: List<String>? = null, val destinationPortRange: String? = null, val destinationPortRanges: List<String>? = null, val direction: String, val name: String, val priority: Int, val protocol: String, val sourceAddressPrefix: String? = null, val sourceAddressPrefixes: List<String>? = null, val sourcePortRange: String? = null, val sourcePortRanges: List<String>? = null)

Describes a network security rule.

Link copied to clipboard
data class NodeTypeFaultSimulationResponse(val nodeTypeName: String? = null, val operationId: String? = null, val operationStatus: String, val status: String? = null)

Node type fault simulation object with status.

Link copied to clipboard
data class NodeTypeSkuResponse(val capacity: Int, val name: String? = null, val tier: String? = null)

Describes a node type sku.

data class PartitionInstanceCountScaleMechanismResponse(val kind: String, val maxInstanceCount: Int, val minInstanceCount: Int, val scaleIncrement: Int)

Represents a scaling mechanism for adding or removing instances of stateless service partition.

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 RollingUpgradeMonitoringPolicyResponse(val failureAction: String, val healthCheckRetryTimeout: String, val healthCheckStableDuration: String, val healthCheckWaitDuration: String, val upgradeDomainTimeout: String, val upgradeTimeout: String)

The policy used for monitoring the application upgrade

Link copied to clipboard

Specifies a metric to load balance a service during runtime.

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

Creates a particular correlation between services.

Link copied to clipboard
data class ServiceEndpointResponse(val locations: List<String>? = null, val service: String)

The service endpoint properties.

Link copied to clipboard
data class ServiceLoadMetricResponse(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.

data class ServicePlacementInvalidDomainPolicyResponse(val domainName: String, val type: String)

Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.

The type of placement policy for a service fabric service. Following are the possible values.

data class ServicePlacementPreferPrimaryDomainPolicyResponse(val domainName: String, val type: String)

Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain. This placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service's primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.

data class ServicePlacementRequiredDomainPolicyResponse(val domainName: String, val type: String)

Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain.

Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain. While this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.

Link copied to clipboard
data class ServiceTypeHealthPolicyResponse(val maxPercentUnhealthyPartitionsPerService: Int, val maxPercentUnhealthyReplicasPerPartition: Int, val maxPercentUnhealthyServices: Int)

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.

Link copied to clipboard
data class SingletonPartitionSchemeResponse(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)

Service Fabric managed cluster Sku definition

Link copied to clipboard
data class StatefulServicePropertiesResponse(val correlationScheme: List<ServiceCorrelationResponse>? = null, val defaultMoveCost: String? = null, val hasPersistedState: Boolean? = null, val minReplicaSetSize: Int? = null, val partitionDescription: Any, val placementConstraints: String? = null, val provisioningState: String, val quorumLossWaitDuration: String? = null, val replicaRestartWaitDuration: String? = null, val scalingPolicies: List<ScalingPolicyResponse>? = null, val serviceDnsName: String? = null, val serviceKind: String, val serviceLoadMetrics: List<ServiceLoadMetricResponse>? = null, val servicePackageActivationMode: String? = null, val servicePlacementPolicies: List<Any>? = null, val servicePlacementTimeLimit: String? = null, val serviceTypeName: String, val standByReplicaKeepDuration: String? = null, val targetReplicaSetSize: Int? = null)

The properties of a stateful service resource.

Link copied to clipboard
data class StatelessServicePropertiesResponse(val correlationScheme: List<ServiceCorrelationResponse>? = null, val defaultMoveCost: String? = null, val instanceCount: Int, val minInstanceCount: Int? = null, val minInstancePercentage: Int? = null, val partitionDescription: Any, val placementConstraints: String? = null, val provisioningState: String, val scalingPolicies: List<ScalingPolicyResponse>? = null, val serviceDnsName: String? = null, val serviceKind: String, val serviceLoadMetrics: List<ServiceLoadMetricResponse>? = null, val servicePackageActivationMode: String? = null, val servicePlacementPolicies: List<Any>? = null, val serviceTypeName: String)

The properties of a stateless service resource.

Link copied to clipboard
data class SubnetResponse(val enableIpv6: Boolean? = null, val name: String, val networkSecurityGroupId: String? = null, val privateEndpointNetworkPolicies: String? = null, val privateLinkServiceNetworkPolicies: String? = null)

Describes a Subnet.

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

Azure resource identifier.

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 UniformInt64RangePartitionSchemeResponse(val count: Int, val highKey: Double, val lowKey: Double, 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 VmImagePlanResponse(val name: String? = null, val product: String? = null, val promotionCode: String? = null, val publisher: String? = null)

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

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

Identities for the virtual machine scale set under the node type.

Link copied to clipboard
data class VmssDataDiskResponse(val diskLetter: String, val diskSizeGB: Int, val diskType: String, val lun: Int)

Managed data disk description.

Link copied to clipboard
data class VMSSExtensionResponse(val autoUpgradeMinorVersion: Boolean? = null, val enableAutomaticUpgrade: 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.

Link copied to clipboard
data class ZoneFaultSimulationContentResponse(val constraints: FaultSimulationConstraintsResponse? = null, val faultKind: String, val force: Boolean? = null, val zones: List<String>? = null)

Parameters for Zone Fault Simulation action.