<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="AddRemoveIncrementalNamedPartitionScalingMechanism" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Defines a mechanism for adding or removing named partitions.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="MinPartitionCount" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The minimum number of partitions.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="MaxPartitionCount" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The maximum number of partitions.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ScaleIncrement" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The number of partitions by which to perform the upshift/downshift.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
MinPartitionCount
The minimum number of partitions.
Attribute
Value
name
MinPartitionCount
type
xs:string
use
required
MaxPartitionCount
The maximum number of partitions.
Attribute
Value
name
MaxPartitionCount
type
xs:string
use
required
ScaleIncrement
The number of partitions by which to perform the upshift/downshift.
Attribute
Value
name
ScaleIncrement
type
xs:string
use
required
Application element
Application Instance specific information like application name and application parameter values used to create application. Parameter values in this file overrides the default parameter values defined in Application Manifest.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Application" type="AppInstanceDefinitionType">
<xs:annotation>
<xs:documentation>Application Instance specific information like application name and application parameter values used to create application. Parameter values in this file overrides the default parameter values defined in Application Manifest.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ApplicationInstance" type="ApplicationInstanceType">
<xs:annotation>
<xs:documentation>Describes an instance of an Azure Service Fabric application.</xs:documentation>
</xs:annotation>
</xs:element>
ApplicationManifest element
Declaratively describes the application type and version. One or more service manifests of the constituent services are referenced to compose an application type. Configuration settings of the constituent services can be overridden using parameterized application settings. Default services, service templates, principals, policies, diagnostics set-up, and certificates can also declared at the application level.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ApplicationPackage" type="ApplicationPackageType">
<xs:annotation>
<xs:documentation>ApplicationPackage represents the versioned Application information required by the node.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="AveragePartitionLoadScalingTrigger" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Defines a scaling mechanism based on the average load of replicas of a partition.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="MetricName" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of metric which should be used for scaling operations.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="LowerLoadThreshold" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The lower limit of the load value of a metric.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="UpperLoadThreshold" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The upper limit of the load value of a metric.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ScaleIntervalInSeconds" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The time interval in seconds to be considered for scaling.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
MetricName
The name of metric which should be used for scaling operations.
Attribute
Value
name
MetricName
type
xs:string
use
required
LowerLoadThreshold
The lower limit of the load value of a metric.
Attribute
Value
name
LowerLoadThreshold
type
xs:string
use
required
UpperLoadThreshold
The upper limit of the load value of a metric.
Attribute
Value
name
UpperLoadThreshold
type
xs:string
use
required
ScaleIntervalInSeconds
The time interval in seconds to be considered for scaling.
Attribute
Value
name
ScaleIntervalInSeconds
type
xs:string
use
required
AverageServiceLoadScalingTrigger element
Defines a scaling mechanism based on the average load of partitions of a service.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="AverageServiceLoadScalingTrigger" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Defines a scaling mechanism based on the average load of partitions of a service.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="MetricName" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of metric which should be used for scaling operations.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="LowerLoadThreshold" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The lower limit of the load value of a metric.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="UpperLoadThreshold" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The upper limit of the load value of a metric.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ScaleIntervalInSeconds" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The time interval in seconds to be considered for scaling.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="UseOnlyPrimaryLoad" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Use load of primary replica as average load of partition.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
MetricName
The name of metric which should be used for scaling operations.
Attribute
Value
name
MetricName
type
xs:string
use
required
LowerLoadThreshold
The lower limit of the load value of a metric.
Attribute
Value
name
LowerLoadThreshold
type
xs:string
use
required
UpperLoadThreshold
The upper limit of the load value of a metric.
Attribute
Value
name
UpperLoadThreshold
type
xs:string
use
required
ScaleIntervalInSeconds
The time interval in seconds to be considered for scaling.
Attribute
Value
name
ScaleIntervalInSeconds
type
xs:string
use
required
UseOnlyPrimaryLoad
Use load of primary replica as average load of partition.
Attribute
Value
name
UseOnlyPrimaryLoad
type
xs:string
use
optional
AzureBlob element (type AzureBlobETWType)
Describes an Azure blob store destination for ETW events. Works only in Azure environment.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="CertificateRef" type="ContainerCertificateType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Specifies information for a certificate which will be exposed to the container.</xs:documentation>
</xs:annotation>
</xs:element>
Certificates element (type CertificatesType)
Describe the certificates associated with this node type
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Certificates" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares certificates used to secure endpoints or encrypt secrets within the application manifest or a cluster manifest.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence maxOccurs="unbounded">
<xs:element name="SecretsCertificate" type="FabricCertificateType" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares a certificate used to encrypt sensitive information within the application manifest. The application author uses the Invoke-ServiceFabricEncryptSecret cmdlet to encrypt the sensitive information, which is copied to a Parameter in the ConfigOverrides section.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EndpointCertificate" type="EndpointCertificateType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
SecretsCertificate
Declares a certificate used to encrypt sensitive information within the application manifest. The application author uses the Invoke-ServiceFabricEncryptSecret cmdlet to encrypt the sensitive information, which is copied to a Parameter in the ConfigOverrides section.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ClusterCertificate" type="FabricCertificateType" minOccurs="0">
<xs:annotation>
<xs:documentation>The certificate used to secure the intra cluster communication.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ClusterManifest" type="ClusterManifestType">
<xs:annotation>
<xs:documentation>Describes an Azure Service Fabric Cluster.</xs:documentation>
</xs:annotation>
</xs:element>
CodePackage element
Describes a code package that supports a defined service type. When a service is instantiated against one of these service types, all code packages declared in this manifest are activated by running their entry points. The resulting processes are expected to register the supported service types at run time. When there are multiple code packages, they are all activated whenever the system looks for any one of the declared service types.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Commands" type="xs:string" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Pass a comma delimited list of commands to the container.</xs:documentation>
</xs:annotation>
</xs:element>
ConfigOverride element
Describes the configuration overrides for a particular config package in the imported service manifest.
Describes configuration overrides for the imported service manifest. Configuration overrides allow the flexibility of re-using the same service manifests across multiple application types by overriding the service manifest's configuration only when used with a particular application type. Configuration overrides can change any default configuration in a service manifest as long as default configuration is defined using the Settings.xml in the ConfigPackage folder.
Attribute
Value
type
anonymous complexType
content
1 element(s), 0 attribute(s)
defined
locally in ServiceManifestImport element
name
ConfigOverrides
minOccurs
0
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ConfigOverrides" minOccurs="0">
<xs:annotation>
<xs:documentation>Describes configuration overrides for the imported service manifest. Configuration overrides allow the flexibility of re-using the same service manifests across multiple application types by overriding the service manifest's configuration only when used with a particular application type. Configuration overrides can change any default configuration in a service manifest as long as default configuration is defined using the Settings.xml in the ConfigPackage folder. </xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ConfigOverride" type="ConfigOverrideType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
ConfigPackage element (type ConfigPackageDescriptionType)
Declares a folder, named by the Name attribute, that contains a Settings.xml file. This file contains sections of user-defined, key-value pair settings that the process can read back at run time. During an upgrade, if only the ConfigPackage version has changed, then the running process is not restarted. Instead, a callback notifies the process that configuration settings have changed so they can be reloaded dynamically.
Declares a folder, named by the Name attribute, and PackageRoot that contains a Settings.xml file. This file contains sections of user-defined, key-value pair settings that the process can read back at run time. During an upgrade, if only the ConfigPackage version has changed, then the running process is not restarted. Instead, a callback notifies the process that configuration settings have changed so they can be reloaded dynamically.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ConfigPackagePolicies" type="ConfigPackagePoliciesType" minOccurs="0">
<xs:annotation>
<xs:documentation>Config Packages to be mounted inside the container.</xs:documentation>
</xs:annotation>
</xs:element>
ConsoleRedirection element
Warning! Do not use console redirection in a production application, only use it for local development and debugging. Redirects console output from the startup script to an output file in the application folder called "log" on the cluster node where the application is deployed and run.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ConsoleRedirection" minOccurs="0">
<xs:annotation>
<xs:documentation>Warning! Do not use console redirection in a production application, only use it for local development and debugging. Redirects console output from the startup script to an output file in the application folder called "log" on the cluster node where the application is deployed and run.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="FileRetentionCount" default="2">
<xs:annotation>
<xs:documentation>Sets the number of console redirection output files to retain. Must be a positive integer, the default value is "2".</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="FileMaxSizeInKb" default="20480">
<xs:annotation>
<xs:documentation>Set the maximum size of a console redirection output file. Must be a positive integer greater than 128KB, the default value is "20480".</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="128"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
FileRetentionCount
Sets the number of console redirection output files to retain. Must be a positive integer, the default value is "2".
Attribute
Value
name
FileRetentionCount
default
2
FileMaxSizeInKb
Set the maximum size of a console redirection output file. Must be a positive integer greater than 128KB, the default value is "20480".
Attribute
Value
name
FileMaxSizeInKb
default
20480
ContainerEntryPoint element
Overridden entrypoint for containers so debugger can be launched.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ContainerEntryPoint" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Overridden entrypoint for containers so debugger can be launched.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="CrashDumpSource" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies crash dump collection. Crash dumps are collected for executables that host the code packages of all services belonging to the application.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Destinations" minOccurs="0">
<xs:annotation>
<xs:documentation>Destinations to which the crash dumps need to be transferred.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LocalStore" type="LocalStoreType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="FileStore" type="FileStoreType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="AzureBlob" type="AzureBlobType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element ref="Parameters" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="IsEnabled" type="xs:string">
<xs:annotation>
<xs:documentation>Whether or not crash dump collection is enabled. By default, it is not enabled.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
IsEnabled
Whether or not crash dump collection is enabled. By default, it is not enabled.
Attribute
Value
name
IsEnabled
type
xs:string
Content element details
Destinations
Destinations to which the crash dumps need to be transferred.
Declares a folder, named by the Name attribute, under PackageRoot which contains static data files to be consumed by the process at runtime. Service Fabric will recycle all EXEs and DLLHOSTs specified in the host and support packages when any of the data packages listed in the service manifest are upgraded.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DefaultRunAsPolicy" minOccurs="0">
<xs:annotation>
<xs:documentation>Specify a default user account for all service code packages that don't have a specific RunAsPolicy defined in the ServiceManifestImport section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="UserRef" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The user account that the service code packages will run as. The user account must be declared in the Principals section. Often it is preferable to run the setup entry point using a local system account rather than an administrators account.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
UserRef
The user account that the service code packages will run as. The user account must be declared in the Principals section. Often it is preferable to run the setup entry point using a local system account rather than an administrators account.
Attribute
Value
name
UserRef
type
xs:string
use
required
DefaultServiceTypeHealthPolicy element
Specifies the default service type health policy, which will replace the default health policy for all service types in the application.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DefaultServiceTypeHealthPolicy" type="ServiceTypeHealthPolicyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies the default service type health policy, which will replace the default health policy for all service types in the application.</xs:documentation>
</xs:annotation>
</xs:element>
DefaultServices element
Declares service instances that are automatically created whenever an application is instantiated against this application type.
Unsupported, do not use. DLL hosting support (assembly entry point) is provided through the FWP.exe process. Service Fabric starts the Fabric Worker Process (FWP.exe) and loads the assembly as part of the activation process.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ETW" minOccurs="0">
<xs:annotation>
<xs:documentation>Describes the ETW settings for the components of this service manifest.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ProviderGuids" minOccurs="0">
<xs:annotation>
<xs:documentation>Lists the ETW provider GUIDs for the components of this service manifest.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ProviderGuid" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Value" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ManifestDataPackages" minOccurs="0">
<xs:annotation>
<xs:documentation>Lists the data packages containing ETW manifests for the components of this service manifest. The data package containing ETW manifests should not contain any other files. </xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ManifestDataPackage" type="DataPackageType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
ProviderGuids
Lists the ETW provider GUIDs for the components of this service manifest.
Attribute
Value
name
ProviderGuids
minOccurs
0
ManifestDataPackages
Lists the data packages containing ETW manifests for the components of this service manifest. The data package containing ETW manifests should not contain any other files.
Attribute
Value
name
ManifestDataPackages
minOccurs
0
ETWSource element
Specifies ETW trace collection. ETW traces are collected for the providers that are registered by all services belonging to the application.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ETWSource" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies ETW trace collection. ETW traces are collected for the providers that are registered by all services belonging to the application.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Destinations" minOccurs="0">
<xs:annotation>
<xs:documentation>Destinations to which the crash dumps need to be transferred.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LocalStore" type="LocalStoreETWType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="FileStore" type="FileStoreETWType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="AzureBlob" type="AzureBlobETWType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element ref="Parameters" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="IsEnabled" type="xs:string">
<xs:annotation>
<xs:documentation>Whether or not ETW trace collection is enabled. By default, it is not enabled.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
IsEnabled
Whether or not ETW trace collection is enabled. By default, it is not enabled.
Attribute
Value
name
IsEnabled
type
xs:string
Content element details
Destinations
Destinations to which the crash dumps need to be transferred.
Attribute
Value
name
Destinations
minOccurs
0
None
Attribute
Value
ref
Parameters
minOccurs
0
maxOccurs
1
Endpoint element (type EndpointOverrideType)
The endpoint, declared in the service manifest, to override.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Endpoint" type="EndpointOverrideType" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The endpoint, declared in the service manifest, to override.</xs:documentation>
</xs:annotation>
</xs:element>
Endpoint element (type EndpointType)
Defines an endpoint for the service. Specific ports can be requested. If a port is not explicitly specified, a port is assigned from the reserved application port range. Service replicas running on different cluster nodes can be assigned different port numbers, while replicas of the same service running on the same node share the same port. Such ports can be used by the service replicas for various purposes such as replication or listening for client requests.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EndpointBinding" type="ContainerNetworkPolicyEndpointBindingType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Specifies an endpoint that should be exposed on the container network.</xs:documentation>
</xs:annotation>
</xs:element>
EndpointBindingPolicy element
Specifies a certificate that should be returned to a client for an HTTPS endpoint.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EndpointBindingPolicy" type="EndpointBindingPolicyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies a certificate that should be returned to a client for an HTTPS endpoint.</xs:documentation>
</xs:annotation>
</xs:element>
EndpointCertificate element
Specifies information about an X509 certificate used to secure an endpoint.
EntryPoint element (type EntryPointDescriptionType)
The executable specified by EntryPoint is typically the long-running service host. The presence of a separate setup entry point avoids having to run the service host with high privileges for extended periods of time. The executable specified by EntryPoint is run after SetupEntryPoint exits successfully. The resulting process is monitored and restarted (beginning again with SetupEntryPoint) if it ever terminates or crashes.
Declares configuration settings in a service manifest to be overridden. It consists of one or more sections of key-value pairs. Parameter values can be encrypted using the Invoke-ServiceFabricEncryptSecret cmdlet.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="FolderSource" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Specifies the collection of the contents of a particular folder on the local node.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Destinations" minOccurs="0">
<xs:annotation>
<xs:documentation>Destinations to which the folder contents need to be transferred.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LocalStore" type="LocalStoreType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="FileStore" type="FileStoreType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="AzureBlob" type="AzureBlobType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element ref="Parameters" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="IsEnabled" type="xs:string">
<xs:annotation>
<xs:documentation>Whether or not collection of the contents of this folder is enabled. By default, it is not enabled.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="RelativeFolderPath"/>
<xs:attributeGroup ref="DataDeletionAgeInDays"/>
</xs:complexType>
</xs:element>
Attribute details
IsEnabled
Whether or not collection of the contents of this folder is enabled. By default, it is not enabled.
Attribute
Value
name
IsEnabled
type
xs:string
Content element details
Destinations
Destinations to which the folder contents need to be transferred.
Declares a group as a security principal, which can be referenced in policies.
Attribute
Value
type
anonymous complexType
content
2 element(s), 1 attribute(s)
defined
locally in Groups element
name
Group
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Group" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Declares a group as a security principal, which can be referenced in policies.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="NTLMAuthenticationPolicy" minOccurs="0">
<xs:complexType>
<xs:attribute name="IsEnabled" type="xs:boolean" use="optional" default="true"/>
</xs:complexType>
</xs:element>
<xs:element name="Membership" minOccurs="0">
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element name="DomainGroup" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="SystemGroup" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="DomainUser" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the local group account. The name will be prefixed with the application ID.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
Name
Name of the local group account. The name will be prefixed with the application ID.
Attribute
Value
name
Name
type
xs:string
use
required
Content element details
NTLMAuthenticationPolicy
Attribute
Value
name
NTLMAuthenticationPolicy
minOccurs
0
Membership
Attribute
Value
name
Membership
minOccurs
0
Group element (defined in MemberOf)
The group to add the user to. The group must be defined in the Groups section.
Attribute
Value
type
anonymous complexType
content
0 element(s), 1 attribute(s)
defined
locally in MemberOf element
name
Group
minOccurs
0
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Group" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The group to add the user to. The group must be defined in the Groups section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="NameRef" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the group.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
NameRef
The name of the group.
Attribute
Value
name
NameRef
type
xs:string
use
required
Groups element
Declares a set of groups as security principals, which can be referenced in policies. Groups are useful if there are multiple users for different service entry points and they need to have certain common privileges that are available at the group level.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Groups" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares a set of groups as security principals, which can be referenced in policies. Groups are useful if there are multiple users for different service entry points and they need to have certain common privileges that are available at the group level.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Group" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Declares a group as a security principal, which can be referenced in policies.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="NTLMAuthenticationPolicy" minOccurs="0">
<xs:complexType>
<xs:attribute name="IsEnabled" type="xs:boolean" use="optional" default="true"/>
</xs:complexType>
</xs:element>
<xs:element name="Membership" minOccurs="0">
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element name="DomainGroup" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="SystemGroup" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="DomainUser" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the local group account. The name will be prefixed with the application ID.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Group
Declares a group as a security principal, which can be referenced in policies.
Attribute
Value
name
Group
maxOccurs
unbounded
HealthConfig element
Specifies docker HEALTHCHECK integration options for the container.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="HealthConfig" type="ContainerHealthConfigType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Specifies docker HEALTHCHECK integration options for the container.</xs:documentation>
</xs:annotation>
</xs:element>
HealthPolicy element
Describes the policy for evaluating health events reported on various application-related entities. If no policy is specified, an entity is assumed to be unhealthy if the health report is a warning or error.
Container image corresponding to OS build version number to be launched. If the Os attribute is not specified, the container image
is assumed to work across all versions of the OS and overrides the image specified in the service manifest.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Image" type="ImageType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Container image corresponding to OS build version number to be launched. If the Os attribute is not specified, the container image
is assumed to work across all versions of the OS and overrides the image specified in the service manifest.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ImageOverrides" type="ImageOverridesType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Image names corresponding to OS build number to be launched.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="InfrastructureInformation" type="InfrastructureInformationType">
<xs:annotation>
<xs:documentation>Describes the infrastructure on which fabric needs to run.</xs:documentation>
</xs:annotation>
</xs:element>
InstanceCountScalingMechanism element
Defines a mechanism for increasing the instance count of a partition. This is for stateless services only.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="InstanceCountScalingMechanism" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Defines a mechanism for increasing the instance count of a partition. This is for stateless services only.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="MinInstanceCount" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The minimum number of instances.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="MaxInstanceCount" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The maximum number of instances..</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ScaleIncrement" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The number of instances by which to perform the upshift/downshift.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
MinInstanceCount
The minimum number of instances.
Attribute
Value
name
MinInstanceCount
type
xs:string
use
required
MaxInstanceCount
The maximum number of instances..
Attribute
Value
name
MaxInstanceCount
type
xs:string
use
required
ScaleIncrement
The number of instances by which to perform the upshift/downshift.
Attribute
Value
name
ScaleIncrement
type
xs:string
use
required
KtlLoggerSettings element
Describe the KtlLogger information associated with this node type
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="KtlLoggerSettings" type="FabricKtlLoggerSettingsType" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the KtlLogger information associated with this node type</xs:documentation>
</xs:annotation>
</xs:element>
A resource that this service should be balanced on, such as memory or CPU usage. Includes information about how much of that resource each replica or instance of this service consumes by default.
Declares a folder, named by the Name attribute, under PackageRoot which contains static data files to be consumed by the process at runtime. Service Fabric will recycle all EXEs and DLLHOSTs specified in the host and support packages when any of the data packages listed in the service manifest are upgraded.
Lists the data packages containing ETW manifests for the components of this service manifest. The data package containing ETW manifests should not contain any other files.
Attribute
Value
type
anonymous complexType
content
1 element(s), 0 attribute(s)
defined
locally in ETW element
name
ManifestDataPackages
minOccurs
0
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ManifestDataPackages" minOccurs="0">
<xs:annotation>
<xs:documentation>Lists the data packages containing ETW manifests for the components of this service manifest. The data package containing ETW manifests should not contain any other files. </xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ManifestDataPackage" type="DataPackageType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Users can be added to any existing membership group, so it can inherit all the properties and security settings of that membership group. The membership group can be used to secure external resources that need to be accessed by different services or the same service (on a different machine).
Attribute
Value
type
anonymous complexType
content
2 element(s), 0 attribute(s)
defined
locally in User element
name
MemberOf
minOccurs
0
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="MemberOf" minOccurs="0">
<xs:annotation>
<xs:documentation>Users can be added to any existing membership group, so it can inherit all the properties and security settings of that membership group. The membership group can be used to secure external resources that need to be accessed by different services or the same service (on a different machine).</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element name="SystemGroup" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The system group to add the user to. The system group must be defined in the Groups section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the system group.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="Group" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The group to add the user to. The group must be defined in the Groups section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="NameRef" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the group.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
Content element details
SystemGroup
The system group to add the user to. The system group must be defined in the Groups section.
Attribute
Value
name
SystemGroup
minOccurs
0
maxOccurs
unbounded
Group
The group to add the user to. The group must be defined in the Groups section.
Attribute
Value
name
Group
minOccurs
0
maxOccurs
unbounded
Members element (defined in StatefulServiceGroupType)
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NamedPartition">
<xs:annotation>
<xs:documentation>Describes a named partitioning scheme based on names for each partition.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence maxOccurs="unbounded">
<xs:element name="Partition">
<xs:annotation>
<xs:documentation>Describes a partition by name.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Name" use="required">
<xs:annotation>
<xs:documentation>The name of the partition</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
An application parameter to be used in this manifest. The parameter value can be changed during application instantiation, or, if no value is supplied the default value is used.
Attribute
Value
type
anonymous complexType
content
0 element(s), 2 attribute(s)
defined
locally in Parameters element
name
Parameter
block
minOccurs
0
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Parameter" block="" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>An application parameter to be used in this manifest. The parameter value can be changed during application instantiation, or, if no value is supplied the default value is used.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Name" use="required">
<xs:annotation>
<xs:documentation>The name of the parameter to be used in the manifest as "[Name]".</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="DefaultValue" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Default value for the parameter, used if the parameter value is not provided during application instantiation.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
Name
The name of the parameter to be used in the manifest as "[Name]".
Attribute
Value
name
Name
use
required
DefaultValue
Default value for the parameter, used if the parameter value is not provided during application instantiation.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Parameter" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The setting to override.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="NameValuePair"/>
<xs:attribute name="IsEncrypted" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>
If true, the value of this parameter is encrypted. The application developer is responsible for creating a certificate and using the Invoke-ServiceFabricEncryptSecret cmdlet to encrypt sensitive information. The certificate information that will be used to encrypt the value is specified in the Certificates section. This attribute is deprecated. Please use Type attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Type" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
This value defines the type of value you have specified in the 'Value' Attribute. It can be SecretsStoreRef/Encrypted/PlainText.
If set to SecretsStoreRef, we retrieve the reference value from the SecretStore.
If set to Encrypted, the application developer is responsible for creating a certificate and using the Invoke-ServiceFabricEncryptSecret cmdlet to encrypt sensitive information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
IsEncrypted
If true, the value of this parameter is encrypted. The application developer is responsible for creating a certificate and using the Invoke-ServiceFabricEncryptSecret cmdlet to encrypt sensitive information. The certificate information that will be used to encrypt the value is specified in the Certificates section. This attribute is deprecated. Please use Type attribute.
Attribute
Value
name
IsEncrypted
type
xs:boolean
default
false
Type
This value defines the type of value you have specified in the 'Value' Attribute. It can be SecretsStoreRef/Encrypted/PlainText.
If set to SecretsStoreRef, we retrieve the reference value from the SecretStore.
If set to Encrypted, the application developer is responsible for creating a certificate and using the Invoke-ServiceFabricEncryptSecret cmdlet to encrypt sensitive information.
Attribute
Value
name
Type
type
xs:string
use
optional
Parameter element (defined in Section)
Attribute
Value
type
anonymous complexType
content
0 element(s), 5 attribute(s)
defined
locally in Section element
name
Parameter
minOccurs
0
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Parameter" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
<xs:attribute name="Value" type="xs:string" use="required"/>
<xs:attribute name="MustOverride" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>If true, the value of this parameter must be overridden by higher level configuration.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="IsEncrypted" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>If true, the value of this parameter is encrypted.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Type" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
Attribute details
Name
Attribute
Value
name
Name
type
xs:string
use
required
Value
Attribute
Value
name
Value
type
xs:string
use
required
MustOverride
If true, the value of this parameter must be overridden by higher level configuration.
Attribute
Value
name
MustOverride
type
xs:boolean
default
false
IsEncrypted
If true, the value of this parameter is encrypted.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Parameters">
<xs:annotation>
<xs:documentation>List of parameters for the application as defined in application manifest and their respective values.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Parameter" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attributeGroup ref="NameValuePair"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Parameter
Attribute
Value
name
Parameter
minOccurs
0
maxOccurs
unbounded
Parameters element (defined in ApplicationManifestType)
Declares the parameters that are used in this application manifest. The value of these parameters can be supplied when the application is instantiated and can be used to override application or service configuration settings.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Parameters" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares the parameters that are used in this application manifest. The value of these parameters can be supplied when the application is instantiated and can be used to override application or service configuration settings.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Parameter" block="" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>An application parameter to be used in this manifest. The parameter value can be changed during application instantiation, or, if no value is supplied the default value is used.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Name" use="required">
<xs:annotation>
<xs:documentation>The name of the parameter to be used in the manifest as "[Name]".</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="DefaultValue" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Default value for the parameter, used if the parameter value is not provided during application instantiation.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Parameter
An application parameter to be used in this manifest. The parameter value can be changed during application instantiation, or, if no value is supplied the default value is used.
Attribute
Value
name
Parameter
block
minOccurs
0
maxOccurs
unbounded
Partition element
Describes a partition by name.
Attribute
Value
type
anonymous complexType
content
0 element(s), 1 attribute(s)
defined
locally in NamedPartition element
name
Partition
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Partition">
<xs:annotation>
<xs:documentation>Describes a partition by name.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Name" use="required">
<xs:annotation>
<xs:documentation>The name of the partition</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Used to control which nodes in the cluster a service can run on. A key/value pair which describes the node property name and the service's requirements for the value. Individual statements can be grouped together with simple boolean logic to create the necessary constraint. For example, "(FirmwareVersion>12 && InDMZ == True)".
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="PlacementConstraints" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Used to control which nodes in the cluster a service can run on. A key/value pair which describes the node property name and the service's requirements for the value. Individual statements can be grouped together with simple boolean logic to create the necessary constraint. For example, "(FirmwareVersion>12 && InDMZ == True)".</xs:documentation>
</xs:annotation>
</xs:element>
PlacementProperties element
Describe the properties for this NodeType that will be used as placement constraints
Attribute
Value
type
anonymous complexType
content
1 element(s), 0 attribute(s)
defined
locally in NodeType element
name
PlacementProperties
minOccurs
0
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="PlacementProperties" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the properties for this NodeType that will be used as placement constraints</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Property" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="PortBinding" type="PortBindingType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Specifies which endpoint resource to bind container exposed port.</xs:documentation>
</xs:annotation>
</xs:element>
Principals element
Describes the security principals (users, groups) required for this application to run services and secure resources. Principals are referenced in the policies sections.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Program" type="xs:string">
<xs:annotation>
<xs:documentation>The executable name. For example, "MySetup.bat" or "MyServiceHost.exe".</xs:documentation>
</xs:annotation></xs:element>
Properties element
Defines Properties for the Persistence and Eviction policies.
Describes the resources used by this service, which can be declared without modifying compiled code and changed when the service is deployed. Access to these resources is controlled through the Principals and Policies sections of the application manifest.
Specifies the local user or local system account that a service code package will run as. Domain accounts are supported on Windows Server deployments where Microsoft Entra ID is available. By default, applications run under the account that the Fabric.exe process runs under. Applications can also run as other accounts, which must be declared in the Principals section. If you apply a RunAs policy to a service, and the service manifest declares endpoint resources with the HTTP protocol, you must also specify a SecurityAccessPolicy to ensure that ports allocated to these endpoints are correctly access-control listed for the RunAs user account that the service runs under. For an HTTPS endpoint, you also have to define a EndpointBindingPolicy to indicate the name of the certificate to return to the client.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Section" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A section in the Settings.xml file to override.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Parameter" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The setting to override.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attributeGroup ref="NameValuePair"/>
<xs:attribute name="IsEncrypted" type="xs:boolean" default="false">
<xs:annotation>
<xs:documentation>
If true, the value of this parameter is encrypted. The application developer is responsible for creating a certificate and using the Invoke-ServiceFabricEncryptSecret cmdlet to encrypt sensitive information. The certificate information that will be used to encrypt the value is specified in the Certificates section. This attribute is deprecated. Please use Type attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Type" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
This value defines the type of value you have specified in the 'Value' Attribute. It can be SecretsStoreRef/Encrypted/PlainText.
If set to SecretsStoreRef, we retrieve the reference value from the SecretStore.
If set to Encrypted, the application developer is responsible for creating a certificate and using the Invoke-ServiceFabricEncryptSecret cmdlet to encrypt sensitive information.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="Name" use="required">
<xs:annotation>
<xs:documentation>The name of the section in the Settings.xml file to override.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
Name
The name of the section in the Settings.xml file to override.
Grants access permissions to a principal on a resource (such as an endpoint) defined in a service manifest. Typically, it is very useful to control and restrict access of services to different resources in order to minimize security risks. This is especially important when the application is built from a collection of services from a marketplace which are developed by different developers.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServerCertificate" type="FabricCertificateType" minOccurs="0">
<xs:annotation>
<xs:documentation>The certificate used to secure the intra cluster communication.</xs:documentation>
</xs:annotation>
</xs:element>
Service element
Declares a service to be created automatically when the application is instantiated.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Service">
<xs:annotation>
<xs:documentation>Declares a service to be created automatically when the application is instantiated.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0">
<xs:element name="StatelessService" type="StatelessServiceType"/>
<xs:element name="StatefulService" type="StatefulServiceType"/>
</xs:choice>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The service name, used to form the fully qualified application name URI. The fully qualified name URI of the service would be: fabric:/ApplicationName/ServiceName.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="GeneratedIdRef" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Reference to the auto generated id used by Visual Studio tooling.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ServiceDnsName" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The DNS name of the service.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ServicePackageActivationMode" type="xs:string" use="optional" default="SharedProcess">
<xs:annotation>
<xs:documentation>ServicePackageActivationMode to be used when creating the service. Allowed values are 'SharedProcess' and 'ExclusiveProcess'. With SharedProcess mode, replica(s) or instance(s) from different partition(s) of service will share same activation of service package on a node. With ExclusiveProcess mode, each replica or instance of service will have its own dedicated activation of service package.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
Name
The service name, used to form the fully qualified application name URI. The fully qualified name URI of the service would be: fabric:/ApplicationName/ServiceName.
Attribute
Value
name
Name
type
xs:string
use
required
GeneratedIdRef
Reference to the auto generated id used by Visual Studio tooling.
Attribute
Value
name
GeneratedIdRef
type
xs:string
use
optional
ServiceDnsName
The DNS name of the service.
Attribute
Value
name
ServiceDnsName
type
xs:string
use
optional
ServicePackageActivationMode
ServicePackageActivationMode to be used when creating the service. Allowed values are 'SharedProcess' and 'ExclusiveProcess'. With SharedProcess mode, replica(s) or instance(s) from different partition(s) of service will share same activation of service package on a node. With ExclusiveProcess mode, each replica or instance of service will have its own dedicated activation of service package.
Defines an affinity relationship with another service. Useful when splitting a previously-monolithic application into microservices. One service has a local dependency on another service and both services need to run on the same node in order to work.
Attribute
Value
type
anonymous complexType
content
0 element(s), 2 attribute(s)
defined
locally in ServiceCorrelations element
name
ServiceCorrelation
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceCorrelation" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Defines an affinity relationship with another service. Useful when splitting a previously-monolithic application into microservices. One service has a local dependency on another service and both services need to run on the same node in order to work.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="ServiceName" use="required">
<xs:annotation>
<xs:documentation>The name of the other service as a URI. Example, "fabric:/otherApplication/parentService".</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Scheme" use="required">
<xs:annotation>
<xs:documentation>In NonAlignedAffinity the replicas or instances of the different services are placed on the same nodes. AlignedAffinity is used with stateful services. Configuring one stateful service as having aligned affinity with another stateful service ensures that the primaries of those services are placed on the same nodes as each other, and that each pair of secondaries are also placed on the same nodes.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Affinity"/>
<xs:enumeration value="AlignedAffinity"/>
<xs:enumeration value="NonAlignedAffinity"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
ServiceName
The name of the other service as a URI. Example, "fabric:/otherApplication/parentService".
Attribute
Value
name
ServiceName
use
required
Scheme
In NonAlignedAffinity the replicas or instances of the different services are placed on the same nodes. AlignedAffinity is used with stateful services. Configuring one stateful service as having aligned affinity with another stateful service ensures that the primaries of those services are placed on the same nodes as each other, and that each pair of secondaries are also placed on the same nodes.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceCorrelations" minOccurs="0">
<xs:annotation>
<xs:documentation>Defines affinity relationships between services.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ServiceCorrelation" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Defines an affinity relationship with another service. Useful when splitting a previously-monolithic application into microservices. One service has a local dependency on another service and both services need to run on the same node in order to work.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="ServiceName" use="required">
<xs:annotation>
<xs:documentation>The name of the other service as a URI. Example, "fabric:/otherApplication/parentService".</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Scheme" use="required">
<xs:annotation>
<xs:documentation>In NonAlignedAffinity the replicas or instances of the different services are placed on the same nodes. AlignedAffinity is used with stateful services. Configuring one stateful service as having aligned affinity with another stateful service ensures that the primaries of those services are placed on the same nodes as each other, and that each pair of secondaries are also placed on the same nodes.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Affinity"/>
<xs:enumeration value="AlignedAffinity"/>
<xs:enumeration value="NonAlignedAffinity"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
ServiceCorrelation
Defines an affinity relationship with another service. Useful when splitting a previously-monolithic application into microservices. One service has a local dependency on another service and both services need to run on the same node in order to work.
Attribute
Value
name
ServiceCorrelation
maxOccurs
unbounded
ServiceFabricRuntimeAccessPolicy element
Specifies policies that determine how the service fabric runtime is exposed to the replicas.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceFabricRuntimeAccessPolicy" type="ServiceFabricRuntimeAccessPolicyType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Specifies policies that determine how the service fabric runtime is exposed to the replicas.</xs:documentation>
</xs:annotation>
</xs:element>
ServiceGroup element
A collection of services that are automatically located together, so they are also moved together during fail-over or resource management.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceGroup">
<xs:annotation>
<xs:documentation>A collection of services that are automatically located together, so they are also moved together during fail-over or resource management.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0">
<xs:element name="StatelessServiceGroup" type="StatelessServiceGroupType"/>
<xs:element name="StatefulServiceGroup" type="StatefulServiceGroupType"/>
</xs:choice>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of this service relative to this application Name URI. Fully qualified Name of the service is a combination of Name Uri of the Application and this Name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ServicePackageActivationMode" type="xs:string" use="optional" default="SharedProcess">
<xs:annotation>
<xs:documentation>ServicePackageActivationMode to be used when creating the service. Allowed values are 'SharedProcess' and 'ExclusiveProcess'. With SharedProcess mode, replica(s) or instance(s) from different partition(s) of service will share same activation of service package on a node. With ExclusiveProcess mode, each replica or instance of service will have its own dedicated activation of service package.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
Name
Name of this service relative to this application Name URI. Fully qualified Name of the service is a combination of Name Uri of the Application and this Name.
Attribute
Value
name
Name
type
xs:string
use
required
ServicePackageActivationMode
ServicePackageActivationMode to be used when creating the service. Allowed values are 'SharedProcess' and 'ExclusiveProcess'. With SharedProcess mode, replica(s) or instance(s) from different partition(s) of service will share same activation of service package on a node. With ExclusiveProcess mode, each replica or instance of service will have its own dedicated activation of service package.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceGroupMembers" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Member types of this service group type.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="ServiceGroupTypeMember" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
None
Attribute
Value
ref
ServiceGroupTypeMember
minOccurs
1
maxOccurs
unbounded
ServiceGroupTypeMember element
Describes the member type of the service group.
Attribute
Value
type
anonymous complexType
content
1 element(s), 1 attribute(s)
defined
globally
name
ServiceGroupTypeMember
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceGroupTypeMember">
<xs:annotation>
<xs:documentation>Describes the member type of the service group.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LoadMetrics" minOccurs="0">
<xs:annotation>
<xs:documentation>Load metrics reported by this service, used for resource balancing services.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LoadMetric" type="LoadMetricType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="ServiceTypeName" use="required">
<xs:annotation>
<xs:documentation>User-defined type identifier for an Azure Service Fabric ServiceGroup Member, .e.g Actor</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
ServiceTypeName
User-defined type identifier for an Azure Service Fabric ServiceGroup Member, .e.g Actor
Attribute
Value
name
ServiceTypeName
use
required
Content element details
LoadMetrics
Load metrics reported by this service, used for resource balancing services.
Attribute
Value
name
LoadMetrics
minOccurs
0
ServiceManifest element
Declaratively describes the service type and version. It lists the independently upgradeable code, configuration, and data packages that together compose a service package to support one or more service types. Resources, diagnostics settings, and service metadata, such as service type, health properties, and load-balancing metrics, are also specified.
Imports a service manifest created by the service developer. A service manifest must be imported for each constituent service in the application. Configuration overrides and policies can be declared for the service manifest.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceManifestImport" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Imports a service manifest created by the service developer. A service manifest must be imported for each constituent service in the application. Configuration overrides and policies can be declared for the service manifest.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ServiceManifestRef" type="ServiceManifestRefType"/>
<xs:element name="ConfigOverrides" minOccurs="0">
<xs:annotation>
<xs:documentation>Describes configuration overrides for the imported service manifest. Configuration overrides allow the flexibility of re-using the same service manifests across multiple application types by overriding the service manifest's configuration only when used with a particular application type. Configuration overrides can change any default configuration in a service manifest as long as default configuration is defined using the Settings.xml in the ConfigPackage folder. </xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ConfigOverride" type="ConfigOverrideType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ResourceOverrides" type="ResourceOverridesType" minOccurs="0"/>
<xs:element name="EnvironmentOverrides" type="EnvironmentOverridesType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="Policies" type="ServiceManifestImportPoliciesType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Describes configuration overrides for the imported service manifest. Configuration overrides allow the flexibility of re-using the same service manifests across multiple application types by overriding the service manifest's configuration only when used with a particular application type. Configuration overrides can change any default configuration in a service manifest as long as default configuration is defined using the Settings.xml in the ConfigPackage folder.
ServicePackage represents a versioned unit of deployment and activation. The version of the ServicePackage is determined based on the manifest version and the version of the overrides.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServicePackage" type="ServicePackageType">
<xs:annotation>
<xs:documentation>ServicePackage represents a versioned unit of deployment and activation. The version of the ServicePackage is determined based on the manifest version and the version of the overrides.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServicePackageResourceGovernancePolicy" type="ServicePackageResourceGovernancePolicyType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Defines the resource governance policy that is applied at the level of the entire service package.</xs:documentation>
</xs:annotation>
</xs:element>
ServicePlacementPolicies element (defined in ServiceTypeType)
Declares placement policies for a service. Useful when the cluster spans geographic distances or and/or geopolitical regions.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServicePlacementPolicies" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares placement policies for a service. Useful when the cluster spans geographic distances or and/or geopolitical regions.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ServicePlacementPolicy" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Defines a service placement policy, which specifies that the service should or should not run in certain cluster fault domains. Useful when the cluster spans geographic distances or and/or geopolitical regions.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="DomainName">
<xs:annotation>
<xs:documentation>The fault domain where the service should or should not be placed, depending on the Type value.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Type" use="required">
<xs:annotation>
<xs:documentation>InvalidDomain allows you to specify that a particular Fault Domain is invalid for this workload. RequiredDomain requires that all of the replicas be present in the specified domain. Multiple required domains can be specified. PreferredPrimaryDomain specifies the preferred Fault Domain for primary replicas. Useful in geographically spanned clusters where you are using other locations for redundancy, but would prefer that the primary replicas be placed in a certain location in order to provider lower latency for operations which go to the primary. RequiredDomainDistribution specifies that replicas are required to be distributed among the available fault domains. NonPartiallyPlace controls if the service replicas will be partially place if not all of them can be placed. </xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="InvalidDomain"/>
<xs:enumeration value="RequiredDomain"/>
<xs:enumeration value="PreferredPrimaryDomain"/>
<xs:enumeration value="RequiredDomainDistribution"/>
<xs:enumeration value="NonPartiallyPlace"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
ServicePlacementPolicy
Defines a service placement policy, which specifies that the service should or should not run in certain cluster fault domains. Useful when the cluster spans geographic distances or and/or geopolitical regions.
Attribute
Value
name
ServicePlacementPolicy
maxOccurs
unbounded
ServicePlacementPolicies element (defined in ServiceType)
Declares placement policies for a service. Useful when the cluster spans geographic distances or and/or geopolitical regions.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServicePlacementPolicies" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares placement policies for a service. Useful when the cluster spans geographic distances or and/or geopolitical regions.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ServicePlacementPolicy" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Defines a service placement policy, which specifies that the service should or should not run in certain cluster fault domains. Useful when the cluster spans geographic distances or and/or geopolitical regions.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="DomainName">
<xs:annotation>
<xs:documentation>The fault domain where the service should or should not be placed, depending on the Type value.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Type" use="required">
<xs:annotation>
<xs:documentation>InvalidDomain allows you to specify that a particular Fault Domain is invalid for this workload. RequiredDomain requires that all of the replicas be present in the specified domain. Multiple required domains can be specified. PreferredPrimaryDomain specifies the preferred Fault Domain for primary replicas. Useful in geographically spanned clusters where you are using other locations for redundancy, but would prefer that the primary replicas be placed in a certain location in order to provider lower latency for operations which go to the primary. RequiredDomainDistribution specifies that replicas are required to be distributed among the available fault domains. NonPartiallyPlace controls if the service replicas will be partially place if not all of them can be placed.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="InvalidDomain"/>
<xs:enumeration value="RequiredDomain"/>
<xs:enumeration value="PreferredPrimaryDomain"/>
<xs:enumeration value="RequiredDomainDistribution"/>
<xs:enumeration value="NonPartiallyPlace"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
ServicePlacementPolicy
Defines a service placement policy, which specifies that the service should or should not run in certain cluster fault domains. Useful when the cluster spans geographic distances or and/or geopolitical regions.
Attribute
Value
name
ServicePlacementPolicy
maxOccurs
unbounded
ServicePlacementPolicy element defined in ServicePlacementPolicies
Defines a service placement policy, which specifies that the service should or should not run in certain cluster fault domains. Useful when the cluster spans geographic distances or and/or geopolitical regions.
Attribute
Value
type
anonymous complexType
content
0 element(s), 2 attribute(s)
defined
locally in ServicePlacementPolicies element
name
ServicePlacementPolicy
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServicePlacementPolicy" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Defines a service placement policy, which specifies that the service should or should not run in certain cluster fault domains. Useful when the cluster spans geographic distances or and/or geopolitical regions.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="DomainName">
<xs:annotation>
<xs:documentation>The fault domain where the service should or should not be placed, depending on the Type value.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Type" use="required">
<xs:annotation>
<xs:documentation>InvalidDomain allows you to specify that a particular Fault Domain is invalid for this workload. RequiredDomain requires that all of the replicas be present in the specified domain. Multiple required domains can be specified. PreferredPrimaryDomain specifies the preferred Fault Domain for primary replicas. Useful in geographically spanned clusters where you are using other locations for redundancy, but would prefer that the primary replicas be placed in a certain location in order to provider lower latency for operations which go to the primary. RequiredDomainDistribution specifies that replicas are required to be distributed among the available fault domains. NonPartiallyPlace controls if the service replicas will be partially place if not all of them can be placed.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="InvalidDomain"/>
<xs:enumeration value="RequiredDomain"/>
<xs:enumeration value="PreferredPrimaryDomain"/>
<xs:enumeration value="RequiredDomainDistribution"/>
<xs:enumeration value="NonPartiallyPlace"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
DomainName
The fault domain where the service should or should not be placed, depending on the Type value.
Attribute
Value
name
DomainName
Type
InvalidDomain allows you to specify that a particular Fault Domain is invalid for this workload. RequiredDomain requires that all of the replicas be present in the specified domain. Multiple required domains can be specified. PreferredPrimaryDomain specifies the preferred Fault Domain for primary replicas. Useful in geographically spanned clusters where you are using other locations for redundancy, but would prefer that the primary replicas be placed in a certain location in order to provider lower latency for operations which go to the primary. RequiredDomainDistribution specifies that replicas are required to be distributed among the available fault domains. NonPartiallyPlace controls if the service replicas will be partially place if not all of them can be placed.
Attribute
Value
name
Type
use
required
ServicePlacementPolicy element (defined in ServicePlacementPolicies)
Defines a service placement policy, which specifies that the service should or should not run in certain cluster fault domains. Useful when the cluster spans geographic distances or and/or geopolitical regions.
Attribute
Value
type
anonymous complexType
content
0 element(s), 2 attribute(s)
defined
locally in ServicePlacementPolicies element
name
ServicePlacementPolicy
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServicePlacementPolicy" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Defines a service placement policy, which specifies that the service should or should not run in certain cluster fault domains. Useful when the cluster spans geographic distances or and/or geopolitical regions.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="DomainName">
<xs:annotation>
<xs:documentation>The fault domain where the service should or should not be placed, depending on the Type value.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Type" use="required">
<xs:annotation>
<xs:documentation>InvalidDomain allows you to specify that a particular Fault Domain is invalid for this workload. RequiredDomain requires that all of the replicas be present in the specified domain. Multiple required domains can be specified. PreferredPrimaryDomain specifies the preferred Fault Domain for primary replicas. Useful in geographically spanned clusters where you are using other locations for redundancy, but would prefer that the primary replicas be placed in a certain location in order to provider lower latency for operations which go to the primary. RequiredDomainDistribution specifies that replicas are required to be distributed among the available fault domains. NonPartiallyPlace controls if the service replicas will be partially place if not all of them can be placed. </xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="InvalidDomain"/>
<xs:enumeration value="RequiredDomain"/>
<xs:enumeration value="PreferredPrimaryDomain"/>
<xs:enumeration value="RequiredDomainDistribution"/>
<xs:enumeration value="NonPartiallyPlace"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
DomainName
The fault domain where the service should or should not be placed, depending on the Type value.
Attribute
Value
name
DomainName
Type
InvalidDomain allows you to specify that a particular Fault Domain is invalid for this workload. RequiredDomain requires that all of the replicas be present in the specified domain. Multiple required domains can be specified. PreferredPrimaryDomain specifies the preferred Fault Domain for primary replicas. Useful in geographically spanned clusters where you are using other locations for redundancy, but would prefer that the primary replicas be placed in a certain location in order to provider lower latency for operations which go to the primary. RequiredDomainDistribution specifies that replicas are required to be distributed among the available fault domains. NonPartiallyPlace controls if the service replicas will be partially place if not all of them can be placed.
Attribute
Value
name
Type
use
required
ServiceScalingPolicies element
Declares scaling policies for a service. Useful for dynamically scaling the service based on needs.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceScalingPolicies" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares scaling policies for a service. Useful for dynamically scaling the service based on needs. </xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ScalingPolicy" type="ScalingPolicyType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Declares the set of permitted service types that can be created dynamically inside the application instance. Default configuration values, such as replication factor, are specified and used as a template for creating service instances.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceTemplates" type="ServiceTemplatesType" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares the set of permitted service types that can be created dynamically inside the application instance. Default configuration values, such as replication factor, are specified and used as a template for creating service instances.</xs:documentation>
</xs:annotation>
</xs:element>
ServiceTypeHealthPolicy element
Describes the policy for evaluating health events reported on services, partitions and replicas of a particular service type.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceTypeHealthPolicy" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Describes the policy for evaluating health events reported on services, partitions and replicas of a particular service type.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:complexContent>
<xs:extension base="ServiceTypeHealthPolicyType">
<xs:attribute name="ServiceTypeName" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the service type that the policy will be applied to.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
ServiceTypes element (type ServiceAndServiceGroupTypesType)
Defines what service types are supported by a CodePackage in this manifest. When a service is instantiated against one of these service types, all code packages declared in this manifest are activated by running their entry points. Service types are declared at the manifest level and not the code package level.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceTypes" type="ServiceAndServiceGroupTypesType">
<xs:annotation>
<xs:documentation>Defines what service types are supported by a CodePackage in this manifest. When a service is instantiated against one of these service types, all code packages declared in this manifest are activated by running their entry points. Service types are declared at the manifest level and not the code package level.</xs:documentation>
</xs:annotation>
</xs:element>
Declares configuration settings in a service manifest to be overridden. It consists of one or more sections of key-value pairs. Parameter values can be encrypted using the Invoke-ServiceFabricEncryptSecret cmdlet.
Defiles configurable settings for the code packages of a service. Azure Service Fabric does not interpret the settings, however it makes them available via Runtime APIs for use by the code components.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Settings" type="SettingsType">
<xs:annotation>
<xs:documentation>Defiles configurable settings for the code packages of a service. Azure Service Fabric does not interpret the settings, however it makes them available via Runtime APIs for use by the code components.</xs:documentation>
</xs:annotation>
</xs:element>
SetupEntryPoint element
A privileged entry point that by default runs with the same credentials as Service Fabric (typically the NETWORKSERVICE account) before any other entry point. The executable specified by EntryPoint is typically the long-running service host. The presence of a separate setup entry point avoids having to run the service host with high privileges for extended periods of time.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SetupEntryPoint" minOccurs="0">
<xs:annotation>
<xs:documentation>A privileged entry point that by default runs with the same credentials as Service Fabric (typically the NETWORKSERVICE account) before any other entry point. The executable specified by EntryPoint is typically the long-running service host. The presence of a separate setup entry point avoids having to run the service host with high privileges for extended periods of time.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ExeHost" type="ExeHostEntryPointType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SingletonPartition">
<xs:annotation>
<xs:documentation>Declares that this service has only one partition.</xs:documentation>
</xs:annotation>
<xs:complexType/>
</xs:element>
The system group to add the user to. The system group must be defined in the Groups section.
Attribute
Value
type
anonymous complexType
content
0 element(s), 1 attribute(s)
defined
locally in MemberOf element
name
SystemGroup
minOccurs
0
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SystemGroup" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The system group to add the user to. The system group must be defined in the Groups section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the system group.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="UniformInt64Partition">
<xs:annotation>
<xs:documentation>Describes a uniform partitioning scheme based on Int64 keys.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="PartitionCount" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Total number of partitions (positive integer). Each partition is responsible for a non-overlapping subrange of the overall partition key range.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="LowKey" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Inclusive low range of the partition key (long).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="HighKey" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Inclusive high range of the partition key (long).</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
PartitionCount
Total number of partitions (positive integer). Each partition is responsible for a non-overlapping subrange of the overall partition key range.
Attribute
Value
name
PartitionCount
type
xs:string
use
required
LowKey
Inclusive low range of the partition key (long).
Attribute
Value
name
LowKey
type
xs:string
use
required
HighKey
Inclusive high range of the partition key (long).
Attribute
Value
name
HighKey
type
xs:string
use
required
UnmanagedDll element
Unsupported, do not use. The name of unmanaged assembly (for example, Queue.dll), to host.
Declares a user as a security principal, which can be referenced in policies.
Attribute
Value
type
anonymous complexType
content
2 element(s), 5 attribute(s)
defined
locally in Users element
name
User
maxOccurs
unbounded
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="User" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Declares a user as a security principal, which can be referenced in policies.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="NTLMAuthenticationPolicy" minOccurs="0">
<xs:complexType>
<xs:attribute name="IsEnabled" type="xs:boolean" use="optional" default="true"/>
<xs:attribute name="PasswordSecret" type="xs:string" use="required"/>
<xs:attribute name="PasswordSecretEncrypted" type="xs:boolean" use="optional" default="false"/>
<xs:attribute name="X509StoreLocation" use="optional" default="LocalMachine">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="LocalMachine"/>
<xs:enumeration value="CurrentUser"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="X509StoreName" default="My">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="X509Thumbprint" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="MemberOf" minOccurs="0">
<xs:annotation>
<xs:documentation>Users can be added to any existing membership group, so it can inherit all the properties and security settings of that membership group. The membership group can be used to secure external resources that need to be accessed by different services or the same service (on a different machine).</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element name="SystemGroup" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The system group to add the user to. The system group must be defined in the Groups section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the system group.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="Group" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The group to add the user to. The group must be defined in the Groups section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="NameRef" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the group.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the user account.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="AccountType" use="optional" default="LocalUser">
<xs:annotation>
<xs:documentation>Specifies the type of account: LocalUser, DomainUser, NetworkService, LocalService, ManagedServiceAccount, or LocalSystem. The default is LocalUser. Local user accounts are created on the machines where the application is deployed. By default, these accounts do not have the same names as those specified here. Instead, they are dynamically generated and have random passwords. Supported local system account types are LocalUser, NetworkService, LocalService and LocalSystem. Domain accounts are supported on Windows Server deployments where Azure Active Directory is available.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="LocalUser"/>
<xs:enumeration value="DomainUser"/>
<xs:enumeration value="NetworkService"/>
<xs:enumeration value="LocalService"/>
<xs:enumeration value="ManagedServiceAccount"/>
<xs:enumeration value="LocalSystem"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="LoadUserProfile" type="xs:boolean" use="optional" default="false"/>
<xs:attribute name="PerformInteractiveLogon" type="xs:boolean" use="optional" default="false"/>
<xs:attributeGroup ref="AccountCredentialsGroup"/>
<xs:attribute name="PasswordEncrypted" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>True if the password is encrypted; false if in plain text.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
Name
Name of the user account.
Attribute
Value
name
Name
type
xs:string
use
required
AccountType
Specifies the type of account: LocalUser, DomainUser, NetworkService, LocalService, ManagedServiceAccount, or LocalSystem. The default is LocalUser. Local user accounts are created on the machines where the application is deployed. By default, these accounts do not have the same names as those specified here. Instead, they are dynamically generated and have random passwords. Supported local system account types are LocalUser, NetworkService, LocalService and LocalSystem. Domain accounts are supported on Windows Server deployments where Microsoft Entra ID is available.
Attribute
Value
name
AccountType
use
optional
default
LocalUser
LoadUserProfile
Attribute
Value
name
LoadUserProfile
type
xs:boolean
use
optional
default
false
PerformInteractiveLogon
Attribute
Value
name
PerformInteractiveLogon
type
xs:boolean
use
optional
default
false
PasswordEncrypted
True if the password is encrypted; false if in plain text.
Attribute
Value
name
PasswordEncrypted
type
xs:boolean
use
optional
Content element details
NTLMAuthenticationPolicy
Attribute
Value
name
NTLMAuthenticationPolicy
minOccurs
0
MemberOf
Users can be added to any existing membership group, so it can inherit all the properties and security settings of that membership group. The membership group can be used to secure external resources that need to be accessed by different services or the same service (on a different machine).
Attribute
Value
name
MemberOf
minOccurs
0
UserRoleClientCertificate element
The default user role client certificate used to secure client server communication.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="UserRoleClientCertificate" type="FabricCertificateType" minOccurs="0">
<xs:annotation>
<xs:documentation>The default user role client certificate used to secure client server communication.</xs:documentation>
</xs:annotation>
</xs:element>
Users element
Declares a set of users as security principals, which can be referenced in policies.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Users" minOccurs="0">
<xs:annotation>
<xs:documentation>Declares a set of users as security principals, which can be referenced in policies.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="User" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Declares a user as a security principal, which can be referenced in policies.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="NTLMAuthenticationPolicy" minOccurs="0">
<xs:complexType>
<xs:attribute name="IsEnabled" type="xs:boolean" use="optional" default="true"/>
<xs:attribute name="PasswordSecret" type="xs:string" use="required"/>
<xs:attribute name="PasswordSecretEncrypted" type="xs:boolean" use="optional" default="false"/>
<xs:attribute name="X509StoreLocation" use="optional" default="LocalMachine">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="LocalMachine"/>
<xs:enumeration value="CurrentUser"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="X509StoreName" default="My">
<xs:simpleType>
<xs:restriction base="xs:string"/>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="X509Thumbprint" type="xs:string"/>
</xs:complexType>
</xs:element>
<xs:element name="MemberOf" minOccurs="0">
<xs:annotation>
<xs:documentation>Users can be added to any existing membership group, so it can inherit all the properties and security settings of that membership group. The membership group can be used to secure external resources that need to be accessed by different services or the same service (on a different machine).</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element name="SystemGroup" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The system group to add the user to. The system group must be defined in the Groups section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the system group.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="Group" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The group to add the user to. The group must be defined in the Groups section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="NameRef" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name of the group.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the user account.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="AccountType" use="optional" default="LocalUser">
<xs:annotation>
<xs:documentation>Specifies the type of account: LocalUser, DomainUser, NetworkService, LocalService, ManagedServiceAccount, or LocalSystem. The default is LocalUser. Local user accounts are created on the machines where the application is deployed. By default, these accounts do not have the same names as those specified here. Instead, they are dynamically generated and have random passwords. Supported local system account types are LocalUser, NetworkService, LocalService and LocalSystem. Domain accounts are supported on Windows Server deployments where Azure Active Directory is available.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="LocalUser"/>
<xs:enumeration value="DomainUser"/>
<xs:enumeration value="NetworkService"/>
<xs:enumeration value="LocalService"/>
<xs:enumeration value="ManagedServiceAccount"/>
<xs:enumeration value="LocalSystem"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="LoadUserProfile" type="xs:boolean" use="optional" default="false"/>
<xs:attribute name="PerformInteractiveLogon" type="xs:boolean" use="optional" default="false"/>
<xs:attributeGroup ref="AccountCredentialsGroup"/>
<xs:attribute name="PasswordEncrypted" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>True if the password is encrypted; false if in plain text.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
User
Declares a user as a security principal, which can be referenced in policies.
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Volume" type="ContainerVolumeType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Specifies the volume to be bound to container.</xs:documentation>
</xs:annotation>
</xs:element>