@azure/arm-servicefabricmanagedclusters package
Interfaces
| AddRemoveIncrementalNamedPartitionScalingMechanism |
Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1'...'N-1'. |
| AdditionalNetworkInterfaceConfiguration |
Specifies the settings for a network interface to attach to the node type. |
| ApplicationHealthPolicy |
Defines a health policy used to evaluate the health of an application or one of its children entities. |
| ApplicationResource |
The application resource. |
| ApplicationResourceProperties |
The application resource properties. |
| ApplicationTypeResource |
The application type name resource |
| ApplicationTypeResourceProperties |
The application type name properties |
| ApplicationTypeUpdateParameters |
Application type update request |
| ApplicationTypeVersionResource |
An application type version resource for the specified application type name resource. |
| ApplicationTypeVersionResourceProperties |
The properties of the application type version resource. |
| ApplicationTypeVersionUpdateParameters |
Application type version update request |
| ApplicationTypeVersionsCleanupPolicy |
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. |
| ApplicationTypeVersionsCreateOrUpdateOptionalParams |
Optional parameters. |
| ApplicationTypeVersionsDeleteOptionalParams |
Optional parameters. |
| ApplicationTypeVersionsGetOptionalParams |
Optional parameters. |
| ApplicationTypeVersionsListByApplicationTypesOptionalParams |
Optional parameters. |
| ApplicationTypeVersionsOperations |
Interface representing a ApplicationTypeVersions operations. |
| ApplicationTypeVersionsUpdateOptionalParams |
Optional parameters. |
| ApplicationTypesCreateOrUpdateOptionalParams |
Optional parameters. |
| ApplicationTypesDeleteOptionalParams |
Optional parameters. |
| ApplicationTypesGetOptionalParams |
Optional parameters. |
| ApplicationTypesListOptionalParams |
Optional parameters. |
| ApplicationTypesOperations |
Interface representing a ApplicationTypes operations. |
| ApplicationTypesUpdateOptionalParams |
Optional parameters. |
| ApplicationUpdateParameters |
Application update request. |
| ApplicationUpgradePolicy |
Describes the policy for a monitored application upgrade. |
| ApplicationUserAssignedIdentity |
User assigned identity for the application. |
| ApplicationsCreateOrUpdateOptionalParams |
Optional parameters. |
| ApplicationsDeleteOptionalParams |
Optional parameters. |
| ApplicationsGetOptionalParams |
Optional parameters. |
| ApplicationsListOptionalParams |
Optional parameters. |
| ApplicationsOperations |
Interface representing a Applications operations. |
| ApplicationsReadUpgradeOptionalParams |
Optional parameters. |
| ApplicationsResumeUpgradeOptionalParams |
Optional parameters. |
| ApplicationsStartRollbackOptionalParams |
Optional parameters. |
| ApplicationsUpdateOptionalParams |
Optional parameters. |
| ApplicationsUpdateUpgradeOptionalParams |
Optional parameters. |
| AvailableOperationDisplay |
Operation supported by the Service Fabric resource provider |
| AveragePartitionLoadScalingTrigger |
Represents a scaling trigger related to an average load of a metric/resource of a partition. |
| AverageServiceLoadScalingTrigger |
Represents a scaling policy related to an average load of a metric/resource of a service. |
| AzureActiveDirectory |
The settings to enable AAD authentication on the cluster. |
| ClientCertificate |
Client certificate definition. |
| ClusterHealthPolicy |
Defines a health policy used to evaluate the health of the cluster or of a cluster node. |
| ClusterMonitoringPolicy |
Describes the monitoring policies for the cluster upgrade. |
| ClusterUpgradeDeltaHealthPolicy |
Describes the delta health policies for the cluster upgrade. |
| ClusterUpgradePolicy |
Describes the policy used when upgrading the cluster. |
| EndpointRangeDescription |
Port range details |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorModelError |
The error details. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. |
| FaultSimulation |
Fault simulation object with status. |
| FaultSimulationConstraints |
Constraints for Fault Simulation action. |
| FaultSimulationContent |
Parameters for Fault Simulation action. |
| FaultSimulationContentWrapper |
Fault Simulation Request for Start action. |
| FaultSimulationDetails |
Details for Fault Simulation. |
| FaultSimulationIdContent |
Parameters for Fault Simulation id. |
| FrontendConfiguration |
Describes the frontend configurations for the node type. |
| IPConfigurationPublicIPAddressConfiguration |
The public IP address configuration of the network interface. |
| IpConfiguration |
Specifies an IP configuration of the network interface. |
| IpTag |
The IP tag associated with the public IP address. |
| LoadBalancingRule |
Describes a load balancing rule. |
| LongRunningOperationResult |
Long running operation result. |
| ManagedApplyMaintenanceWindowOperations |
Interface representing a ManagedApplyMaintenanceWindow operations. |
| ManagedApplyMaintenanceWindowPostOptionalParams |
Optional parameters. |
| ManagedAzResiliencyStatus |
Describes the result of the request to list Managed VM Sizes for Service Fabric Managed Clusters. |
| ManagedAzResiliencyStatusGetOptionalParams |
Optional parameters. |
| ManagedAzResiliencyStatusOperations |
Interface representing a ManagedAzResiliencyStatus operations. |
| ManagedCluster |
The managed cluster resource |
| ManagedClusterCodeVersionResult |
The result of the Service Fabric runtime versions |
| ManagedClusterProperties |
Describes the managed cluster resource properties. |
| ManagedClusterUpdateParameters |
Managed cluster update request |
| ManagedClusterVersionDetails |
The detail of the Service Fabric runtime version result |
| ManagedClusterVersionGetByEnvironmentOptionalParams |
Optional parameters. |
| ManagedClusterVersionGetOptionalParams |
Optional parameters. |
| ManagedClusterVersionListByEnvironmentOptionalParams |
Optional parameters. |
| ManagedClusterVersionListOptionalParams |
Optional parameters. |
| ManagedClusterVersionOperations |
Interface representing a ManagedClusterVersion operations. |
| ManagedClustersCreateOrUpdateOptionalParams |
Optional parameters. |
| ManagedClustersDeleteOptionalParams |
Optional parameters. |
| ManagedClustersGetFaultSimulationOptionalParams |
Optional parameters. |
| ManagedClustersGetOptionalParams |
Optional parameters. |
| ManagedClustersListByResourceGroupOptionalParams |
Optional parameters. |
| ManagedClustersListBySubscriptionOptionalParams |
Optional parameters. |
| ManagedClustersListFaultSimulationOptionalParams |
Optional parameters. |
| ManagedClustersOperations |
Interface representing a ManagedClusters operations. |
| ManagedClustersStartFaultSimulationOptionalParams |
Optional parameters. |
| ManagedClustersStopFaultSimulationOptionalParams |
Optional parameters. |
| ManagedClustersUpdateOptionalParams |
Optional parameters. |
| ManagedIdentity |
Describes the managed identities for an Azure resource. |
| ManagedMaintenanceWindowStatus |
Describes the maintenance window status of the Service Fabric Managed Cluster. |
| ManagedMaintenanceWindowStatusGetOptionalParams |
Optional parameters. |
| ManagedMaintenanceWindowStatusOperations |
Interface representing a ManagedMaintenanceWindowStatus operations. |
| ManagedUnsupportedVMSizesGetOptionalParams |
Optional parameters. |
| ManagedUnsupportedVMSizesListOptionalParams |
Optional parameters. |
| ManagedUnsupportedVMSizesOperations |
Interface representing a ManagedUnsupportedVMSizes operations. |
| ManagedVMSize |
Describes a VM Sizes. |
| NamedPartitionScheme |
Describes the named partition scheme of the service. |
| NetworkSecurityRule |
Describes a network security rule. |
| NodeType |
Describes a node type in the cluster, each node type represents sub set of nodes in the cluster. |
| NodeTypeActionParameters |
Parameters for Node type action. If nodes are not specified on the parameters, the operation will be performed in all nodes of the node type one upgrade domain at a time. |
| NodeTypeAvailableSku |
Defines the type of sku available for a node type |
| NodeTypeFaultSimulation |
Node type fault simulation object with status. |
| NodeTypeNatConfig |
Provides information about NAT configuration on the default public Load Balancer for the node type. |
| NodeTypeProperties |
Describes a node type in the cluster, each node type represents sub set of nodes in the cluster. |
| NodeTypeSku |
Describes a node type sku. |
| NodeTypeSkuCapacity |
Provides information about how node type can be scaled. |
| NodeTypeSkusListOptionalParams |
Optional parameters. |
| NodeTypeSkusOperations |
Interface representing a NodeTypeSkus operations. |
| NodeTypeSupportedSku |
Describes a node type supported sku. |
| NodeTypeUpdateParameters |
Node type update request |
| NodeTypesCreateOrUpdateOptionalParams |
Optional parameters. |
| NodeTypesDeallocateOptionalParams |
Optional parameters. |
| NodeTypesDeleteNodeOptionalParams |
Optional parameters. |
| NodeTypesDeleteOptionalParams |
Optional parameters. |
| NodeTypesGetFaultSimulationOptionalParams |
Optional parameters. |
| NodeTypesGetOptionalParams |
Optional parameters. |
| NodeTypesListByManagedClustersOptionalParams |
Optional parameters. |
| NodeTypesListFaultSimulationOptionalParams |
Optional parameters. |
| NodeTypesOperations |
Interface representing a NodeTypes operations. |
| NodeTypesRedeployOptionalParams |
Optional parameters. |
| NodeTypesReimageOptionalParams |
Optional parameters. |
| NodeTypesRestartOptionalParams |
Optional parameters. |
| NodeTypesStartFaultSimulationOptionalParams |
Optional parameters. |
| NodeTypesStartOptionalParams |
Optional parameters. |
| NodeTypesStopFaultSimulationOptionalParams |
Optional parameters. |
| NodeTypesUpdateOptionalParams |
Optional parameters. |
| OperationResult |
Available operation list result |
| OperationResultsGetOptionalParams |
Optional parameters. |
| OperationResultsOperations |
Interface representing a OperationResults operations. |
| OperationStatusGetOptionalParams |
Optional parameters. |
| OperationStatusOperations |
Interface representing a OperationStatus operations. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| Partition |
Describes how the service is partitioned. |
| PartitionInstanceCountScaleMechanism |
Represents a scaling mechanism for adding or removing instances of stateless service partition. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceAzStatus |
Describes Az Resiliency status of Base resources |
| RestorePollerOptions | |
| RollingUpgradeMonitoringPolicy |
The policy used for monitoring the application upgrade |
| RuntimeApplicationHealthPolicy |
Cluster level definition for a health policy used to evaluate the health of an application or one of its children entities. |
| RuntimeResumeApplicationUpgradeParameters |
Parameters for Resume Upgrade action. The upgrade domain name must be specified. |
| RuntimeRollingUpgradeUpdateMonitoringPolicy |
Describes the parameters for updating a rolling upgrade of application or cluster. |
| RuntimeServiceTypeHealthPolicy |
Cluster level definition that represents the health policy used to evaluate the health of services belonging to a service type. |
| RuntimeUpdateApplicationUpgradeParameters |
Parameters for the Update Upgrade action. |
| ScalingMechanism |
Describes the mechanism for performing a scaling operation. |
| ScalingPolicy |
Specifies a metric to load balance a service during runtime. |
| ScalingTrigger |
Describes the trigger for performing a scaling operation. |
| ServiceCorrelation |
Creates a particular correlation between services. |
| ServiceEndpoint |
The service endpoint properties. |
| ServiceFabricManagedClustersManagementClientOptionalParams |
Optional parameters for the client. |
| ServiceLoadMetric |
Specifies a metric to load balance a service during runtime. |
| ServicePlacementInvalidDomainPolicy |
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. |
| ServicePlacementNonPartiallyPlaceServicePolicy |
The type of placement policy for a service fabric service. Following are the possible values. |
| ServicePlacementPolicy |
Describes the policy to be used for placement of a Service Fabric service. |
| ServicePlacementPreferPrimaryDomainPolicy |
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. |
| ServicePlacementRequireDomainDistributionPolicy |
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. |
| ServicePlacementRequiredDomainPolicy |
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. |
| ServiceResource |
The service resource. |
| ServiceResourceProperties |
The service resource properties. |
| ServiceResourcePropertiesBase |
The common service resource properties. |
| ServiceTypeHealthPolicy |
Represents the health policy used to evaluate the health of services belonging to a service type. |
| ServiceUpdateParameters |
Service update request |
| ServicesCreateOrUpdateOptionalParams |
Optional parameters. |
| ServicesDeleteOptionalParams |
Optional parameters. |
| ServicesGetOptionalParams |
Optional parameters. |
| ServicesListByApplicationsOptionalParams |
Optional parameters. |
| ServicesOperations |
Interface representing a Services operations. |
| ServicesUpdateOptionalParams |
Optional parameters. |
| SettingsParameterDescription |
Describes a parameter in fabric settings of the cluster. |
| SettingsSectionDescription |
Describes a section in the fabric settings of the cluster. |
| SingletonPartitionScheme |
Describes the partition scheme of a singleton-partitioned, or non-partitioned service. |
| Sku |
Service Fabric managed cluster Sku definition |
| StatefulServiceProperties |
The properties of a stateful service resource. |
| StatelessServiceProperties |
The properties of a stateless service resource. |
| SubResource |
Azure resource identifier. |
| Subnet |
Describes a Subnet. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| UniformInt64RangePartitionScheme |
Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions. |
| UserAssignedIdentity |
User assigned identity. |
| VMSize |
VM Sizes properties. |
| VaultCertificate |
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. |
| VaultSecretGroup |
Specifies set of certificates that should be installed onto the virtual machines. |
| VmApplication |
Specifies the gallery application that should be made available to the underlying VMSS. |
| VmImagePlan |
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. |
| VmManagedIdentity |
Identities for the virtual machine scale set under the node type. |
| VmssDataDisk |
Managed data disk description. |
| VmssExtension |
Specifies set of extensions that should be installed onto the virtual machines. |
| VmssExtensionProperties |
Describes the properties of a Virtual Machine Scale Set Extension. |
| ZoneFaultSimulationContent |
Parameters for Zone Fault Simulation action. |
Type Aliases
| Access |
The network traffic is allowed or denied. Known values supported by the serviceallow: The network traffic is allowed. |
| AutoGeneratedDomainNameLabelScope |
This enum is the entrypoint to using a certificate from a public CA for your cluster. This property was introduced to solve the
domain squatting problem with new domains. A domain name will be generated in the following format: {clustername}.{hash}.{regionname}.sfmcdomain.
The hash portion comes from Azure DNS' Deterministic Name Library. The library creates a hash using the cluster's Tenant, Subscription, Resource Group
and Resource Name using the AutoGeneratedDomainNameLabelScope/reuse policy chosen. Known values supported by the serviceTenantReuse: TenantReuse allows for the same hash to be created if the resource is created in the same Tenant with the same resource name. |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| ClusterState |
The current state of the cluster. Known values supported by the serviceWaitingForNodes: Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it. |
| ClusterUpgradeCadence |
Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Known values supported by the serviceWave0: Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters. |
| ClusterUpgradeMode |
The upgrade mode of the cluster when new Service Fabric runtime version is available. Known values supported by the serviceAutomatic: The cluster will be automatically upgraded to the latest Service Fabric runtime version, clusterUpgradeCadence will determine when the upgrade starts after the new version becomes available. |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| Direction |
Network security rule direction. Known values supported by the serviceinbound: Inbound direction. |
| DiskType |
Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. Known values supported by the serviceStandard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access. |
| EvictionPolicyType |
Specifies the eviction policy for virtual machines in a SPOT node type. Known values supported by the serviceDelete: Eviction policy will be Delete for SPOT vms. |
| FailureAction |
The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Known values supported by the serviceRollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. |
| FaultKind |
The kind of fault simulation. Known values supported by the serviceZone: Simulates an availability zone down. |
| FaultSimulationContentUnion |
Alias for FaultSimulationContentUnion |
| FaultSimulationStatus |
Fault simulation status. Known values supported by the serviceStarting: Indicates the fault simulation is starting. The simulation will have this status while the start operation is in progress. |
| IPAddressType |
The IP address type. Known values supported by the serviceIPv4: IPv4 address type. |
| ManagedClusterAddOnFeature |
Available cluster add-on features Known values supported by the serviceDnsService: Dns service |
| ManagedClusterVersionEnvironment |
The operating system of the cluster. The default means all. Known values supported by the serviceWindows: Indicates os is Windows. |
| ManagedIdentityType |
The type of managed identity for the resource. |
| ManagedResourceProvisioningState |
The provisioning state of the managed resource. Known values supported by the serviceNone: The resource does not have a provisioning state. |
| MoveCost |
Specifies the move cost for the service. Known values supported by the serviceZero: Zero move cost. This value is zero. |
| NodeTypeSkuScaleType |
Node type capacity scale type. Known values supported by the serviceNone: Node count is not adjustable in any way (e.g. it is fixed). |
| NsgProtocol |
Network protocol this rule applies to. Known values supported by the servicehttp: Protocol applies to HTTP. |
| OsType |
Cluster operating system, the default will be Windows Known values supported by the serviceWindows: Indicates os is Windows. |
| PartitionScheme |
Enumerates the ways that a service can be partitioned. Known values supported by the serviceSingleton: Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0. |
| PartitionUnion |
Alias for PartitionUnion |
| PrivateEndpointNetworkPolicies |
Enable or Disable apply network policies on private end point in the subnet. Known values supported by the serviceenabled: Enable apply network policies on private end point in the subnet. |
| PrivateIPAddressVersion |
Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. Known values supported by the serviceIPv4: The IP configuration's private IP is IPv4. |
| PrivateLinkServiceNetworkPolicies |
Enable or Disable apply network policies on private link service in the subnet. Known values supported by the serviceenabled: Enable apply network policies on private link service in the subnet. |
| ProbeProtocol |
The reference to the load balancer probe used by the load balancing rule. Known values supported by the servicetcp: Probe protocol is TCP. |
| Protocol |
The reference to the transport protocol used by the load balancing rule. Known values supported by the servicetcp: Transport protocol is TCP. |
| PublicIPAddressVersion |
Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. Known values supported by the serviceIPv4: The IP configuration's public IP is IPv4. |
| RollingUpgradeMode |
The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. Known values supported by the serviceMonitored: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. |
| RuntimeFailureAction |
Cluster level definition for the compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Known values supported by the serviceRollback: Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails. |
| RuntimeRollingUpgradeMode |
Cluster level definition for the mode used to monitor health during a rolling upgrade. Known values supported by the serviceUnmonitoredAuto: The upgrade will proceed automatically without performing any health monitoring. |
| RuntimeUpgradeKind |
Cluster level definition for the kind of upgrade. Known values supported by the serviceRolling: The upgrade progresses one upgrade domain at a time. |
| ScalingMechanismUnion |
Alias for ScalingMechanismUnion |
| ScalingTriggerUnion |
Alias for ScalingTriggerUnion |
| SecurityEncryptionType |
Specifies the securityEncryptionType type of the nodeType. Only DiskWithVMGuestState and VMGuestStateOnly are currently supported Known values supported by the serviceDiskWithVMGuestState: For encryption of the managed disk along with VMGuestState blob. |
| SecurityType |
Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported Known values supported by the serviceTrustedLaunch: Trusted Launch is a security type that secures generation 2 virtual machines. |
| ServiceCorrelationScheme |
The service correlation scheme. Known values supported by the serviceAlignedAffinity: Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 0. |
| ServiceKind |
The kind of service (Stateless or Stateful). Known values supported by the serviceStateless: Does not use Service Fabric to make its state highly available or reliable. The value is 0. |
| ServiceLoadMetricWeight |
Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. Known values supported by the serviceZero: Disables resource balancing for this metric. This value is zero. |
| ServicePackageActivationMode |
The activation Mode of the service package Known values supported by the serviceSharedProcess: Indicates the application package activation mode will use shared process. |
| ServicePlacementPolicyType |
The type of placement policy for a service fabric service. Following are the possible values. Known values supported by the serviceInvalidDomain: Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 0. |
| ServicePlacementPolicyUnion |
Alias for ServicePlacementPolicyUnion |
| ServiceResourcePropertiesUnion |
Alias for ServiceResourcePropertiesUnion |
| ServiceScalingMechanismKind |
Enumerates the ways that a service can be partitioned. Known values supported by the serviceScalePartitionInstanceCount: Represents a scaling mechanism for adding or removing instances of stateless service partition. The value is 0. |
| ServiceScalingTriggerKind |
Enumerates the ways that a service can be partitioned. Known values supported by the serviceAveragePartitionLoadTrigger: Represents a scaling trigger related to an average load of a metric/resource of a partition. The value is 0. |
| SfmcOperationStatus |
Sfmc operation status. Known values supported by the serviceCreated: Operation created. |
| SkuName |
Sku Name. Known values supported by the serviceBasic: Basic requires a minimum of 3 nodes and allows only 1 node type. |
| UpdateType |
Specifies the way the operation will be performed. Known values supported by the serviceDefault: The operation will proceed in all specified nodes at the same time. |
| VmSetupAction |
action to be performed on the vms before bootstrapping the service fabric runtime. Known values supported by the serviceEnableContainers: Enable windows containers feature. |
| VmssExtensionSetupOrder |
Vm extension setup order. Known values supported by the serviceBeforeSFRuntime: Indicates that the vm extension should run before the service fabric runtime starts. |
| ZonalUpdateMode |
Indicates the update mode for Cross Az clusters. Known values supported by the serviceStandard: The cluster will use 5 upgrade domains for Cross Az Node types. |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownAccess |
The network traffic is allowed or denied. |
| KnownAutoGeneratedDomainNameLabelScope |
This enum is the entrypoint to using a certificate from a public CA for your cluster. This property was introduced to solve the domain squatting problem with new domains. A domain name will be generated in the following format: {clustername}.{hash}.{regionname}.sfmcdomain. The hash portion comes from Azure DNS' Deterministic Name Library. The library creates a hash using the cluster's Tenant, Subscription, Resource Group and Resource Name using the AutoGeneratedDomainNameLabelScope/reuse policy chosen. |
| KnownClusterState |
The current state of the cluster. |
| KnownClusterUpgradeCadence |
Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. |
| KnownClusterUpgradeMode |
The upgrade mode of the cluster when new Service Fabric runtime version is available. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDirection |
Network security rule direction. |
| KnownDiskType |
Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types. |
| KnownEvictionPolicyType |
Specifies the eviction policy for virtual machines in a SPOT node type. |
| KnownFailureAction |
The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. |
| KnownFaultKind |
The kind of fault simulation. |
| KnownFaultSimulationStatus |
Fault simulation status. |
| KnownIPAddressType |
The IP address type. |
| KnownManagedClusterAddOnFeature |
Available cluster add-on features |
| KnownManagedClusterVersionEnvironment |
The operating system of the cluster. The default means all. |
| KnownManagedResourceProvisioningState |
The provisioning state of the managed resource. |
| KnownMoveCost |
Specifies the move cost for the service. |
| KnownNodeTypeSkuScaleType |
Node type capacity scale type. |
| KnownNsgProtocol |
Network protocol this rule applies to. |
| KnownOsType |
Cluster operating system, the default will be Windows |
| KnownPartitionScheme |
Enumerates the ways that a service can be partitioned. |
| KnownPrivateEndpointNetworkPolicies |
Enable or Disable apply network policies on private end point in the subnet. |
| KnownPrivateIPAddressVersion |
Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. |
| KnownPrivateLinkServiceNetworkPolicies |
Enable or Disable apply network policies on private link service in the subnet. |
| KnownProbeProtocol |
The reference to the load balancer probe used by the load balancing rule. |
| KnownProtocol |
The reference to the transport protocol used by the load balancing rule. |
| KnownPublicIPAddressVersion |
Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. |
| KnownRollingUpgradeMode |
The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. |
| KnownRuntimeFailureAction |
Cluster level definition for the compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. |
| KnownRuntimeRollingUpgradeMode |
Cluster level definition for the mode used to monitor health during a rolling upgrade. |
| KnownRuntimeUpgradeKind |
Cluster level definition for the kind of upgrade. |
| KnownSecurityEncryptionType |
Specifies the securityEncryptionType type of the nodeType. Only DiskWithVMGuestState and VMGuestStateOnly are currently supported |
| KnownSecurityType |
Specifies the security type of the nodeType. Only Standard and TrustedLaunch are currently supported |
| KnownServiceCorrelationScheme |
The service correlation scheme. |
| KnownServiceKind |
The kind of service (Stateless or Stateful). |
| KnownServiceLoadMetricWeight |
Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight. |
| KnownServicePackageActivationMode |
The activation Mode of the service package |
| KnownServicePlacementPolicyType |
The type of placement policy for a service fabric service. Following are the possible values. |
| KnownServiceScalingMechanismKind |
Enumerates the ways that a service can be partitioned. |
| KnownServiceScalingTriggerKind |
Enumerates the ways that a service can be partitioned. |
| KnownSfmcOperationStatus |
Sfmc operation status. |
| KnownSkuName |
Sku Name. |
| KnownUpdateType |
Specifies the way the operation will be performed. |
| KnownVersions |
The available API versions. |
| KnownVmSetupAction |
action to be performed on the vms before bootstrapping the service fabric runtime. |
| KnownVmssExtensionSetupOrder |
Vm extension setup order. |
| KnownZonalUpdateMode |
Indicates the update mode for Cross Az clusters. |
Functions
| restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Function Details
restorePoller<TResponse, TResult>(ServiceFabricManagedClustersManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: ServiceFabricManagedClustersManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>