AddRemoveIncrementalNamedPartitionScalingMechanism element
Defines a mechanism for adding or removing named partitions.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 3 attribute(s) |
| defined |
locally in ScalingPolicyMechanismGroup group |
| name |
AddRemoveIncrementalNamedPartitionScalingMechanism |
| minOccurs |
0 |
| maxOccurs |
1 |
XML source
<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.
XML source
<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>
ApplicationEndpoints element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 2 attribute(s) |
| defined |
locally in FabricEndpointsType complexType |
| name |
ApplicationEndpoints |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ApplicationEndpoints" minOccurs="0">
<xs:complexType>
<xs:attribute name="StartPort" type="xs:int" use="required"/>
<xs:attribute name="EndPort" type="xs:int" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
StartPort
| Attribute |
Value |
| name |
StartPort |
| type |
xs:int |
| use |
required |
EndPort
| Attribute |
Value |
| name |
EndPort |
| type |
xs:int |
| use |
required |
ApplicationInstance element
Describes an instance of an Azure Service Fabric application.
| Attribute |
Value |
| type |
ApplicationInstanceType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
ApplicationInstance |
XML source
<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.
| Attribute |
Value |
| type |
ApplicationManifestType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
ApplicationManifest |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ApplicationManifest" type="ApplicationManifestType"/>
ApplicationPackage element
ApplicationPackage represents the versioned Application information required by the node.
| Attribute |
Value |
| type |
ApplicationPackageType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
ApplicationPackage |
XML source
<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>
ApplicationPackageRef element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ApplicationPackageRef">
<xs:complexType>
<xs:attributeGroup ref="VersionedItemAttrGroup"/>
</xs:complexType>
</xs:element>
Arguments element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Arguments" type="xs:string" minOccurs="0"/>
AveragePartitionLoadScalingTrigger element
Defines a scaling mechanism based on the average load of replicas of a partition.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 4 attribute(s) |
| defined |
locally in ScalingPolicyTriggerGroup group |
| name |
AveragePartitionLoadScalingTrigger |
| minOccurs |
0 |
| maxOccurs |
1 |
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 5 attribute(s) |
| defined |
locally in ScalingPolicyTriggerGroup group |
| name |
AverageServiceLoadScalingTrigger |
| minOccurs |
0 |
| maxOccurs |
1 |
XML source
<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.
| Attribute |
Value |
| type |
AzureBlobETWType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Destinations element |
| name |
AzureBlob |
| 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="AzureBlob" type="AzureBlobETWType" minOccurs="0" maxOccurs="unbounded"/>
AzureBlob element (type AzureBlobType)
Describes an Azure blob store destination for diagnostics data. Works only in Azure cluster environment.
| Attribute |
Value |
| type |
AzureBlobType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Destinations element, Destinations element |
| name |
AzureBlob |
| 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="AzureBlob" type="AzureBlobType" minOccurs="0" maxOccurs="unbounded"/>
BackupRestoreServiceReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="BackupRestoreServiceReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
Blackbird element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in Infrastructure element |
| name |
Blackbird |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Blackbird">
<xs:complexType>
<xs:sequence>
<xs:element name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="BlackbirdRoleType" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Roles
| Attribute |
Value |
| name |
Roles |
Capacities element
The capacities of various metrics for this node type
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in NodeType element |
| name |
Capacities |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Capacities" minOccurs="0">
<xs:annotation>
<xs:documentation>The capacities of various metrics for this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Capacity" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Capacity
| Attribute |
Value |
| name |
Capacity |
| type |
KeyValuePairType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
Capacity element
| Attribute |
Value |
| type |
KeyValuePairType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Capacities element |
| name |
Capacity |
| 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="Capacity" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
CentralSecretServiceReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="CentralSecretServiceReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
CertificateRef element
Specifies information for a certificate which will be exposed to the container.
XML source
<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
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Certificates" type="CertificatesType" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the certificates associated with this node type</xs:documentation>
</xs:annotation>
</xs:element>
Certificates element (defined in ApplicationManifestType)
Declares certificates used to secure endpoints or encrypt secrets within the application manifest or a cluster manifest.
XML source
<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.
EndpointCertificate
Certificates element (defined in ClusterManifestType)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ClusterManifestType complexType |
| name |
Certificates |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Certificates" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="SecretsCertificate" type="FabricCertificateType" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
SecretsCertificate
ClientCertificate element
The default admin role client certificate used to secure client server communication.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ClientCertificate" type="FabricCertificateType" minOccurs="0">
<xs:annotation>
<xs:documentation>The default admin role client certificate used to secure client server communication.</xs:documentation>
</xs:annotation>
</xs:element>
ClientConnectionEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ClientConnectionEndpoint" type="InputEndpointType"/>
ClusterCertificate element
The certificate used to secure the intra cluster communication.
XML source
<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>
ClusterConnectionEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ClusterConnectionEndpoint" type="InternalEndpointType"/>
ClusterManagerReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ClusterManagerReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
ClusterManifest element
Describes an Azure Service Fabric Cluster.
| Attribute |
Value |
| type |
ClusterManifestType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
ClusterManifest |
XML source
<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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="CodePackage" type="CodePackageType" maxOccurs="unbounded"/>
Commands element
Pass a comma delimited list of commands to the container.
XML source
<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.
| Attribute |
Value |
| type |
ConfigOverrideType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ConfigOverrides element, DigestedConfigPackage element |
| name |
ConfigOverride |
| 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="ConfigOverride" type="ConfigOverrideType" minOccurs="0" maxOccurs="unbounded"/>
ConfigOverrides 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.
| 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>
Content element details
ConfigOverride
| Attribute |
Value |
| name |
ConfigOverride |
| type |
ConfigOverrideType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ConfigPackage" type="ConfigPackageDescriptionType" minOccurs="0" maxOccurs="unbounded"/>
ConfigPackage element (type ConfigPackageType)
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ConfigPackage" type="ConfigPackageType" minOccurs="0" maxOccurs="unbounded"/>
ConfigPackagePolicies element
Config Packages to be mounted inside the container.
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 2 attribute(s) |
| defined |
locally in ExeHostEntryPointType complexType |
| name |
ConsoleRedirection |
| minOccurs |
0 |
XML source
<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.
| Attribute |
Value |
| type |
xs:string |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in DebugParametersType complexType |
| name |
ContainerEntryPoint |
| 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="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>
ContainerEnvironmentBlock element
EnvironmentBlock for containers.
| Attribute |
Value |
| type |
xs:string |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in DebugParametersType complexType |
| name |
ContainerEnvironmentBlock |
| 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="ContainerEnvironmentBlock" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>EnvironmentBlock for containers.</xs:documentation>
</xs:annotation>
</xs:element>
ContainerHost element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ContainerHost" type="ContainerHostEntryPointType"/>
ContainerHostPolicies element
Specifies policies for activating container hosts.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ContainerHostPolicies" type="ContainerHostPoliciesType" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies policies for activating container hosts.</xs:documentation>
</xs:annotation>
</xs:element>
ContainerLabel element
Labels for containers in form key=value.
| Attribute |
Value |
| type |
xs:string |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in DebugParametersType complexType |
| name |
ContainerLabel |
| 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="ContainerLabel" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Labels for containers in form key=value.</xs:documentation>
</xs:annotation>
</xs:element>
ContainerMountedVolume element
Volumes to be mounted inside container.
| Attribute |
Value |
| type |
xs:string |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in DebugParametersType complexType |
| name |
ContainerMountedVolume |
| 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="ContainerMountedVolume" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Volumes to be mounted inside container.</xs:documentation>
</xs:annotation>
</xs:element>
ContainerNetworkPolicy element
Describes container network policies for the service package.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ContainerNetworkPolicy" type="ContainerNetworkPolicyType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Describes container network policies for the service package.</xs:documentation>
</xs:annotation>
</xs:element>
CrashDumpSource element
Specifies crash dump collection. Crash dumps are collected for executables that host the code packages of all services belonging to the application.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
2 element(s), 1 attribute(s) |
| defined |
locally in DiagnosticsType complexType |
| name |
CrashDumpSource |
| minOccurs |
0 |
XML source
<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.
| Attribute |
Value |
| name |
Destinations |
| minOccurs |
0 |
None
| Attribute |
Value |
| ref |
Parameters |
| minOccurs |
0 |
| maxOccurs |
1 |
CurrentInstallation element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="CurrentInstallation" type="WindowsFabricDeploymentInformation" minOccurs="0"/>
DataPackage element
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DataPackage" type="DataPackageType" minOccurs="0" maxOccurs="unbounded"/>
DebugParameters element
Specifies information on debugger to attach when activating codepackage.
| Attribute |
Value |
| type |
DebugParametersType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in DigestedCodePackage element, DigestedConfigPackage element, DigestedDataPackage element |
| name |
DebugParameters |
| minOccurs |
0 |
| maxOccurs |
1 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DebugParameters" type="DebugParametersType" minOccurs="0" maxOccurs="1"/>
DefaultReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DefaultReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
DefaultRunAsPolicy element
Specify a default user account for all service code packages that don't have a specific RunAsPolicy defined in the ServiceManifestImport section.
XML source
<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.
XML source
<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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DefaultServices" type="DefaultServicesType" minOccurs="0">
</xs:element>
Description element
Text describing this application.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Description" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Text describing this application.</xs:documentation>
</xs:annotation>
</xs:element>
Destinations element (defined in CrashDumpSource)
Destinations to which the crash dumps need to be transferred.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
3 element(s), 0 attribute(s) |
| defined |
locally in CrashDumpSource element |
| name |
Destinations |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" 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>
Content element details
LocalStore
| Attribute |
Value |
| name |
LocalStore |
| type |
LocalStoreType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
FileStore
| Attribute |
Value |
| name |
FileStore |
| type |
FileStoreType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
AzureBlob
| Attribute |
Value |
| name |
AzureBlob |
| type |
AzureBlobType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
Destinations element (defined in ETWSource)
Destinations to which the crash dumps need to be transferred.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
3 element(s), 0 attribute(s) |
| defined |
locally in ETWSource element |
| name |
Destinations |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" 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>
Content element details
LocalStore
| Attribute |
Value |
| name |
LocalStore |
| type |
LocalStoreETWType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
FileStore
| Attribute |
Value |
| name |
FileStore |
| type |
FileStoreETWType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
AzureBlob
| Attribute |
Value |
| name |
AzureBlob |
| type |
AzureBlobETWType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
Destinations element (defined in FolderSource)
Destinations to which the folder contents need to be transferred.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
3 element(s), 0 attribute(s) |
| defined |
locally in FolderSource element |
| name |
Destinations |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" 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>
Content element details
LocalStore
| Attribute |
Value |
| name |
LocalStore |
| type |
LocalStoreType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
FileStore
| Attribute |
Value |
| name |
FileStore |
| type |
FileStoreType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
AzureBlob
| Attribute |
Value |
| name |
AzureBlob |
| type |
AzureBlobType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
Diagnostics element (type DiagnosticsType)
Describes the diagnostic settings for applications.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Diagnostics" type="DiagnosticsType" minOccurs="0"/>
Diagnostics element (type ServiceDiagnosticsType)
Describes the diagnostic settings for the components of this service manifest.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Diagnostics" type="ServiceDiagnosticsType" minOccurs="0"/>
DigestedCertificates element (defined in ApplicationPackageType)
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DigestedCertificates">
<xs:complexType>
<xs:sequence maxOccurs="unbounded">
<xs:element name="SecretsCertificate" type="FabricCertificateType" minOccurs="0"/>
<xs:element name="EndpointCertificate" type="EndpointCertificateType" minOccurs="0"/>
</xs:sequence>
<xs:attributeGroup ref="VersionedItemAttrGroup"/>
</xs:complexType>
</xs:element>
Content element details
SecretsCertificate
EndpointCertificate
DigestedCertificates element (defined in DigestedResources)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in DigestedResources element |
| name |
DigestedCertificates |
| minOccurs |
0 |
| maxOccurs |
1 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DigestedCertificates" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="EndpointCertificate" type="EndpointCertificateType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
EndpointCertificate
DigestedCodePackage element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
6 element(s), 2 attribute(s) |
| defined |
locally in ServicePackageType complexType |
| name |
DigestedCodePackage |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DigestedCodePackage" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="CodePackage" type="CodePackageType"/>
<xs:element name="RunAsPolicy" type="RunAsPolicyType" minOccurs="0" maxOccurs="2"/>
<xs:element name="DebugParameters" type="DebugParametersType" minOccurs="0" maxOccurs="1"/>
<xs:element name="ContainerHostPolicies" type="ContainerHostPoliciesType" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies policies for activating container hosts.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ResourceGovernancePolicy" type="ResourceGovernancePolicyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies resource limits for codepackage.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ConfigPackagePolicies" type="ConfigPackagePoliciesType" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies config policies for mounts.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attributeGroup ref="VersionedItemAttrGroup"/>
<xs:attribute name="ContentChecksum" type="xs:string"/>
<xs:attribute name="IsShared" type="xs:boolean"/>
</xs:complexType>
</xs:element>
Attribute details
ContentChecksum
| Attribute |
Value |
| name |
ContentChecksum |
| type |
xs:string |
IsShared
| Attribute |
Value |
| name |
IsShared |
| type |
xs:boolean |
Content element details
CodePackage
RunAsPolicy
| Attribute |
Value |
| name |
RunAsPolicy |
| type |
RunAsPolicyType |
| minOccurs |
0 |
| maxOccurs |
2 |
DebugParameters
ContainerHostPolicies
Specifies policies for activating container hosts.
ResourceGovernancePolicy
Specifies resource limits for codepackage.
ConfigPackagePolicies
Specifies config policies for mounts.
DigestedConfigPackage element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
3 element(s), 2 attribute(s) |
| defined |
locally in ServicePackageType complexType |
| name |
DigestedConfigPackage |
| 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="DigestedConfigPackage" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="ConfigPackage" type="ConfigPackageType"/>
<xs:element name="ConfigOverride" type="ConfigOverrideType" minOccurs="0"/>
<xs:element name="DebugParameters" type="DebugParametersType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attributeGroup ref="VersionedItemAttrGroup"/>
<xs:attribute name="ContentChecksum" type="xs:string"/>
<xs:attribute name="IsShared" type="xs:boolean"/>
</xs:complexType>
</xs:element>
Attribute details
ContentChecksum
| Attribute |
Value |
| name |
ContentChecksum |
| type |
xs:string |
IsShared
| Attribute |
Value |
| name |
IsShared |
| type |
xs:boolean |
Content element details
ConfigPackage
ConfigOverride
DebugParameters
DigestedDataPackage element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
2 element(s), 2 attribute(s) |
| defined |
locally in ServicePackageType complexType |
| name |
DigestedDataPackage |
| 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="DigestedDataPackage" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="DataPackage" type="DataPackageType"/>
<xs:element name="DebugParameters" type="DebugParametersType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
<xs:attributeGroup ref="VersionedItemAttrGroup"/>
<xs:attribute name="ContentChecksum" type="xs:string"/>
<xs:attribute name="IsShared" type="xs:boolean"/>
</xs:complexType>
</xs:element>
Attribute details
ContentChecksum
| Attribute |
Value |
| name |
ContentChecksum |
| type |
xs:string |
IsShared
| Attribute |
Value |
| name |
IsShared |
| type |
xs:boolean |
Content element details
DataPackage
DebugParameters
DigestedEndpoint element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
4 element(s), 0 attribute(s) |
| defined |
locally in DigestedEndpoints element |
| name |
DigestedEndpoint |
| 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="DigestedEndpoint" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="Endpoint" type="EndpointType"/>
<xs:element name="SecurityAccessPolicy" type="SecurityAccessPolicyType" minOccurs="0"/>
<xs:element name="EndpointBindingPolicy" type="EndpointBindingPolicyType" minOccurs="0"/>
<xs:element name="ResourceGovernancePolicy" type="ResourceGovernancePolicyType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Endpoint
SecurityAccessPolicy
EndpointBindingPolicy
ResourceGovernancePolicy
DigestedEndpoints element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in DigestedResources element |
| name |
DigestedEndpoints |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DigestedEndpoints" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="DigestedEndpoint" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="Endpoint" type="EndpointType"/>
<xs:element name="SecurityAccessPolicy" type="SecurityAccessPolicyType" minOccurs="0"/>
<xs:element name="EndpointBindingPolicy" type="EndpointBindingPolicyType" minOccurs="0"/>
<xs:element name="ResourceGovernancePolicy" type="ResourceGovernancePolicyType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
DigestedEndpoint
| Attribute |
Value |
| name |
DigestedEndpoint |
| minOccurs |
0 |
| maxOccurs |
unbounded |
DigestedEnvironment element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DigestedEnvironment" type="EnvironmentType"/>
DigestedResources element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
2 element(s), 0 attribute(s) |
| defined |
locally in ServicePackageType complexType |
| name |
DigestedResources |
| minOccurs |
1 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DigestedResources" minOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="DigestedEndpoints" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="DigestedEndpoint" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="Endpoint" type="EndpointType"/>
<xs:element name="SecurityAccessPolicy" type="SecurityAccessPolicyType" minOccurs="0"/>
<xs:element name="EndpointBindingPolicy" type="EndpointBindingPolicyType" minOccurs="0"/>
<xs:element name="ResourceGovernancePolicy" type="ResourceGovernancePolicyType" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="DigestedCertificates" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="EndpointCertificate" type="EndpointCertificateType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attributeGroup ref="VersionedItemAttrGroup"/>
</xs:complexType>
</xs:element>
Content element details
DigestedEndpoints
| Attribute |
Value |
| name |
DigestedEndpoints |
| minOccurs |
0 |
DigestedCertificates
| Attribute |
Value |
| name |
DigestedCertificates |
| minOccurs |
0 |
| maxOccurs |
1 |
DigestedServiceTypes element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServicePackageType complexType |
| name |
DigestedServiceTypes |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DigestedServiceTypes">
<xs:complexType>
<xs:sequence>
<xs:element name="ServiceTypes" type="ServiceTypesType"/>
</xs:sequence>
<xs:attributeGroup ref="VersionedItemAttrGroup"/>
</xs:complexType>
</xs:element>
Content element details
ServiceTypes
DllHost element
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DllHost" type="DllHostEntryPointType"/>
DomainGroup element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 1 attribute(s) |
| defined |
locally in Membership element |
| name |
DomainGroup |
| 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="DomainGroup" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
Name
| Attribute |
Value |
| name |
Name |
| type |
xs:string |
| use |
required |
DomainUser element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 1 attribute(s) |
| defined |
locally in Membership element |
| name |
DomainUser |
| 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="DomainUser" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
Name
| Attribute |
Value |
| name |
Name |
| type |
xs:string |
| use |
required |
DriverOption element
Driver options to be passed to driver.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="DriverOption" type="DriverOptionType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Driver options to be passed to driver.</xs:documentation>
</xs:annotation>
</xs:element>
ETW element
Describes the ETW settings for the components of this service manifest.
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
2 element(s), 1 attribute(s) |
| defined |
locally in DiagnosticsType complexType |
| name |
ETWSource |
| minOccurs |
0 |
XML source
<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.
| Attribute |
Value |
| type |
EndpointOverrideType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Endpoints element |
| name |
Endpoint |
| maxOccurs |
unbounded |
XML source
<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.
| Attribute |
Value |
| type |
EndpointType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Endpoints element, DigestedEndpoint element |
| name |
Endpoint |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Endpoint" type="EndpointType" maxOccurs="unbounded"/>
EndpointBinding element
Specifies an endpoint that should be exposed on the container network.
XML source
<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.
XML source
<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.
| Attribute |
Value |
| type |
EndpointCertificateType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Certificates element, DigestedCertificates element, DigestedCertificates element |
| name |
EndpointCertificate |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EndpointCertificate" type="EndpointCertificateType" minOccurs="0"/>
Endpoints element (type FabricEndpointsType)
Describe the endpoints associated with this node type
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Endpoints" type="FabricEndpointsType" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the endpoints associated with this node type</xs:documentation>
</xs:annotation>
</xs:element>
Endpoints element (defined in ResourceOverridesType)
The service endpoint(s) to override.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Endpoints" minOccurs="0">
<xs:annotation>
<xs:documentation>The service endpoint(s) to override.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element 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>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Endpoint
The endpoint, declared in the service manifest, to override.
Endpoints element (defined in ResourcesType)
Defines endpoints for the service.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ResourcesType complexType |
| name |
Endpoints |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Endpoints" minOccurs="0">
<xs:annotation>
<xs:documentation>Defines endpoints for the service.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Endpoint" type="EndpointType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Endpoint
| Attribute |
Value |
| name |
Endpoint |
| type |
EndpointType |
| maxOccurs |
unbounded |
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EntryPoint" type="EntryPointDescriptionType" minOccurs="1"/>
EntryPoint element (type xs:string)
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EntryPoint" type="xs:string" minOccurs="0" maxOccurs="1"/>
EnvironmentOverrides element
| Attribute |
Value |
| type |
EnvironmentOverridesType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ServiceManifestImport element |
| name |
EnvironmentOverrides |
| 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="EnvironmentOverrides" type="EnvironmentOverridesType" minOccurs="0" maxOccurs="unbounded"/>
EnvironmentVariable element (type EnvironmentVariableOverrideType)
Environment variable.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EnvironmentVariable" type="EnvironmentVariableOverrideType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Environment variable.</xs:documentation>
</xs:annotation>
</xs:element>
EnvironmentVariable element (type EnvironmentVariableType)
Environment variable.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EnvironmentVariable" type="EnvironmentVariableType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Environment variable.</xs:documentation>
</xs:annotation>
</xs:element>
EnvironmentVariables element
Pass environment variables to your container or exe.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EnvironmentVariables" type="EnvironmentVariablesType" minOccurs="0" maxOccurs="1"/>
EphemeralEndpoints element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 2 attribute(s) |
| defined |
locally in FabricEndpointsType complexType |
| name |
EphemeralEndpoints |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EphemeralEndpoints" minOccurs="0">
<xs:complexType>
<xs:attribute name="StartPort" type="xs:int" use="required"/>
<xs:attribute name="EndPort" type="xs:int" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
StartPort
| Attribute |
Value |
| name |
StartPort |
| type |
xs:int |
| use |
required |
EndPort
| Attribute |
Value |
| name |
EndPort |
| type |
xs:int |
| use |
required |
EventStoreServiceReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EventStoreServiceReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
EvictionPolicy element
Eviction Policy extension for the Service Type.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 2 attribute(s) |
| defined |
globally |
| name |
EvictionPolicy |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="EvictionPolicy">
<xs:annotation>
<xs:documentation>Eviction Policy extension for the Service Type.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Properties" type="ServiceTypeExtensionPolicyPropertiesType" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="Name" type="xs:string" use="required"/>
<xs:attribute name="Provider" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
Name
| Attribute |
Value |
| name |
Name |
| type |
xs:string |
| use |
required |
Provider
| Attribute |
Value |
| name |
Provider |
| type |
xs:string |
| use |
required |
Content element details
Properties
ExeHost element (type ExeHostEntryPointType)
| Attribute |
Value |
| type |
ExeHostEntryPointType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in SetupEntryPoint element |
| name |
ExeHost |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ExeHost" type="ExeHostEntryPointType"/>
ExeHost element (defined in EntryPointDescriptionType)
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ExeHost">
<xs:complexType>
<xs:complexContent>
<xs:extension base="ExeHostEntryPointType">
<xs:sequence>
<xs:element name="RunFrequency" minOccurs="0">
<xs:complexType>
<xs:attribute name="IntervalInSeconds" use="required">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="2147483647"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
Extension element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 2 attribute(s) |
| defined |
locally in ExtensionsType complexType |
| name |
Extension |
| 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="Extension" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:any namespace="##other" processContents="lax"/>
</xs:sequence>
<xs:attribute name="Name" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="GeneratedId" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
Attribute details
Name
| Attribute |
Value |
| name |
Name |
| use |
required |
GeneratedId
| Attribute |
Value |
| name |
GeneratedId |
| type |
xs:string |
| use |
optional |
Extensions element
Describes extensions that can be applied to other elements.
| Attribute |
Value |
| type |
ExtensionsType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
Extensions |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Extensions" type="ExtensionsType"/>
FabricSettings 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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="FabricSettings" type="SettingsOverridesType" minOccurs="0"/>
FailoverManagerReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="FailoverManagerReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
FaultAnalysisServiceReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="FaultAnalysisServiceReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
FileStore element (type FileStoreETWType)
Describes a file store destination for ETW events. Works only in on-premises environment.
| Attribute |
Value |
| type |
FileStoreETWType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Destinations element |
| name |
FileStore |
| 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="FileStore" type="FileStoreETWType" minOccurs="0" maxOccurs="unbounded"/>
FileStore element (type FileStoreType)
Describes a file store destination for diagnostics data. Works only in a standalone cluster environment.
| Attribute |
Value |
| type |
FileStoreType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Destinations element, Destinations element |
| name |
FileStore |
| 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="FileStore" type="FileStoreType" minOccurs="0" maxOccurs="unbounded"/>
FolderSource element
Specifies the collection of the contents of a particular folder on the local node.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
2 element(s), 1 attribute(s) |
| defined |
locally in DiagnosticsType complexType |
| name |
FolderSource |
| 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="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.
| Attribute |
Value |
| name |
Destinations |
| minOccurs |
0 |
None
| Attribute |
Value |
| ref |
Parameters |
| minOccurs |
0 |
| maxOccurs |
1 |
FromSource element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="FromSource" type="xs:string" minOccurs="0" maxOccurs="1"/>
GatewayResourceManagerReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="GatewayResourceManagerReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
Group element (defined in Groups)
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.
XML source
<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.
XML source
<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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="HealthPolicy" type="ApplicationHealthPolicyType" minOccurs="0"/>
HttpApplicationGatewayEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="HttpApplicationGatewayEndpoint" type="InputEndpointType" minOccurs="0"/>
HttpGatewayEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="HttpGatewayEndpoint" type="InputEndpointType" minOccurs="0"/>
Image element
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.
XML source
<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>
ImageName element
The repo and image on https://hub.docker.com or Azure Container Registry.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ImageName" type="xs:string">
<xs:annotation>
<xs:documentation>The repo and image on https://hub.docker.com or Azure Container Registry.</xs:documentation>
</xs:annotation>
</xs:element>
ImageOverrides element
Image names corresponding to OS build number to be launched.
XML source
<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>
ImageStoreServiceReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ImageStoreServiceReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
Infrastructure element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Infrastructure">
<xs:complexType>
<xs:choice>
<xs:element name="WindowsServer">
<xs:complexType>
<xs:complexContent>
<xs:extension base="WindowsInfrastructureType">
<xs:attribute name="IsScaleMin" type="xs:boolean" default="false"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="Linux">
<xs:complexType>
<xs:complexContent>
<xs:extension base="LinuxInfrastructureType">
<xs:attribute name="IsScaleMin" type="xs:boolean" default="false"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="WindowsAzure">
<xs:complexType>
<xs:sequence>
<xs:element name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="AzureRoleType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="WindowsAzureStaticTopology">
<xs:complexType>
<xs:complexContent>
<xs:extension base="WindowsInfrastructureType"/>
</xs:complexContent>
</xs:complexType>
</xs:element>
<xs:element name="Blackbird">
<xs:complexType>
<xs:sequence>
<xs:element name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="BlackbirdRoleType" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="PaaS">
<xs:complexType>
<xs:all>
<xs:element name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="PaaSRoleType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Votes">
<xs:complexType>
<xs:sequence>
<xs:element name="Vote" type="PaaSVoteType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
Content element details
WindowsServer
| Attribute |
Value |
| name |
WindowsServer |
Linux
| Attribute |
Value |
| name |
Linux |
WindowsAzure
| Attribute |
Value |
| name |
WindowsAzure |
WindowsAzureStaticTopology
| Attribute |
Value |
| name |
WindowsAzureStaticTopology |
Blackbird
| Attribute |
Value |
| name |
Blackbird |
PaaS
| Attribute |
Value |
| name |
PaaS |
Describes the infrastructure on which fabric needs to run.
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 3 attribute(s) |
| defined |
locally in ScalingPolicyMechanismGroup group |
| name |
InstanceCountScalingMechanism |
| minOccurs |
0 |
| maxOccurs |
1 |
XML source
<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
| Attribute |
Value |
| type |
FabricKtlLoggerSettingsType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in NodeType element |
| name |
KtlLoggerSettings |
| minOccurs |
0 |
XML source
<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>
Label element
Specifies the labels for the container.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Label" type="ContainerLabelType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Specifies the labels for the container.</xs:documentation>
</xs:annotation>
</xs:element>
LeaseDriverEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LeaseDriverEndpoint" type="InternalEndpointType"/>
Linux element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Infrastructure element |
| name |
Linux |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Linux">
<xs:complexType>
<xs:complexContent>
<xs:extension base="LinuxInfrastructureType">
<xs:attribute name="IsScaleMin" type="xs:boolean" default="false"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
LoadMetric 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.
| Attribute |
Value |
| type |
LoadMetricType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in LoadMetrics element, LoadMetrics element, LoadMetrics element, LoadMetrics element, LoadMetrics element |
| name |
LoadMetric |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LoadMetric" type="LoadMetricType" maxOccurs="unbounded"/>
LoadMetrics element (defined in ServiceGroupMemberType)
Load metrics reported by this service.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LoadMetrics" minOccurs="0">
<xs:annotation>
<xs:documentation>Load metrics reported by this service.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LoadMetric" type="LoadMetricType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
LoadMetric
| Attribute |
Value |
| name |
LoadMetric |
| type |
LoadMetricType |
| maxOccurs |
unbounded |
LoadMetrics element (defined in ServiceGroupTypeMember)
Load metrics reported by this service, used for resource balancing services.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceGroupTypeMember element |
| name |
LoadMetrics |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" 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>
Content element details
LoadMetric
| Attribute |
Value |
| name |
LoadMetric |
| type |
LoadMetricType |
| maxOccurs |
unbounded |
LoadMetrics element (defined in ServiceGroupTypeType)
Load metrics reported by this service.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceGroupTypeType complexType |
| name |
LoadMetrics |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LoadMetrics" minOccurs="0">
<xs:annotation>
<xs:documentation>Load metrics reported by this service.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LoadMetric" type="LoadMetricType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
LoadMetric
| Attribute |
Value |
| name |
LoadMetric |
| type |
LoadMetricType |
| maxOccurs |
unbounded |
LoadMetrics element (defined in ServiceTypeType)
Load metrics reported by this service.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceTypeType complexType |
| name |
LoadMetrics |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LoadMetrics" minOccurs="0">
<xs:annotation>
<xs:documentation>Load metrics reported by this service.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LoadMetric" type="LoadMetricType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
LoadMetric
| Attribute |
Value |
| name |
LoadMetric |
| type |
LoadMetricType |
| maxOccurs |
unbounded |
LoadMetrics element (defined in ServiceType)
Load metrics reported by this service, used for resource balancing services.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceType complexType |
| name |
LoadMetrics |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" 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>
Content element details
LoadMetric
| Attribute |
Value |
| name |
LoadMetric |
| type |
LoadMetricType |
| maxOccurs |
unbounded |
LocalStore element (type LocalStoreETWType)
Describes a store destination within the node for ETW events.
| Attribute |
Value |
| type |
LocalStoreETWType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Destinations element |
| name |
LocalStore |
| 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="LocalStore" type="LocalStoreETWType" minOccurs="0" maxOccurs="unbounded"/>
LocalStore element (type LocalStoreType)
Describes a store destination within the node for diagnostic data.
| Attribute |
Value |
| type |
LocalStoreType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Destinations element, Destinations element |
| name |
LocalStore |
| 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="LocalStore" type="LocalStoreType" minOccurs="0" maxOccurs="unbounded"/>
LogCollectionPolicies element
Specifies whether log collection is enabled. Works only in an Azure cluster environment
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LogCollectionPolicies" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies whether log collection is enabled. Works only in an Azure cluster environment</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence maxOccurs="unbounded">
<xs:element name="LogCollectionPolicy">
<xs:complexType>
<xs:attribute name="Path" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
LogCollectionPolicy
| Attribute |
Value |
| name |
LogCollectionPolicy |
LogCollectionPolicy element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 1 attribute(s) |
| defined |
locally in LogCollectionPolicies element |
| name |
LogCollectionPolicy |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LogCollectionPolicy">
<xs:complexType>
<xs:attribute name="Path" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
Attribute details
Path
| Attribute |
Value |
| name |
Path |
| type |
xs:string |
| use |
optional |
LogConfig element
Specifies the logging driver for a container.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LogConfig" type="ContainerLoggingDriverType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Specifies the logging driver for a container.</xs:documentation>
</xs:annotation>
</xs:element>
LogicalDirectories element
Describe the LogicalDirectories settings associated with this node type
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in NodeType element |
| name |
LogicalDirectories |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LogicalDirectories" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the LogicalDirectories settings associated with this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LogicalDirectory" type="LogicalDirectoryType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
LogicalDirectory
LogicalDirectory element
Describes a LogicalDirectoryType.
| Attribute |
Value |
| type |
LogicalDirectoryType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in LogicalDirectories element |
| name |
LogicalDirectory |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="LogicalDirectory" type="LogicalDirectoryType" maxOccurs="unbounded"/>
ManagedAssembly element
Unsupported, do not use. The name of managed assembly (for example, Queue.dll), to host.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ManagedAssembly" type="ManagedAssemblyType"/>
ManifestDataPackage element
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.
| Attribute |
Value |
| type |
DataPackageType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ManifestDataPackages element |
| name |
ManifestDataPackage |
| 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="ManifestDataPackage" type="DataPackageType" minOccurs="0" maxOccurs="unbounded"/>
ManifestDataPackages element
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>
Content element details
ManifestDataPackage
| Attribute |
Value |
| name |
ManifestDataPackage |
| type |
DataPackageType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
Member element
| Attribute |
Value |
| type |
ServiceGroupMemberType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Members element, Members element |
| name |
Member |
| minOccurs |
1 |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Member" type="ServiceGroupMemberType" minOccurs="1" maxOccurs="unbounded"/>
MemberOf 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)
Member services of this service group
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Members" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Member services of this service group</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Member" type="ServiceGroupMemberType" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Member
Members element (defined in StatelessServiceGroupType)
Member services of this service group
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Members" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Member services of this service group</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Member" type="ServiceGroupMemberType" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Member
Membership element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
3 element(s), 0 attribute(s) |
| defined |
locally in Group element |
| name |
Membership |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" 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>
Content element details
DomainGroup
| Attribute |
Value |
| name |
DomainGroup |
| minOccurs |
0 |
| maxOccurs |
unbounded |
SystemGroup
| Attribute |
Value |
| name |
SystemGroup |
| minOccurs |
0 |
| maxOccurs |
unbounded |
DomainUser
| Attribute |
Value |
| name |
DomainUser |
| minOccurs |
0 |
| maxOccurs |
unbounded |
NTLMAuthenticationPolicy element (defined in Group)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 1 attribute(s) |
| defined |
locally in Group element |
| name |
NTLMAuthenticationPolicy |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NTLMAuthenticationPolicy" minOccurs="0">
<xs:complexType>
<xs:attribute name="IsEnabled" type="xs:boolean" use="optional" default="true"/>
</xs:complexType>
</xs:element>
Attribute details
IsEnabled
| Attribute |
Value |
| name |
IsEnabled |
| type |
xs:boolean |
| use |
optional |
| default |
true |
NTLMAuthenticationPolicy element (defined in User)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 6 attribute(s) |
| defined |
locally in User element |
| name |
NTLMAuthenticationPolicy |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" 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>
Attribute details
IsEnabled
| Attribute |
Value |
| name |
IsEnabled |
| type |
xs:boolean |
| use |
optional |
| default |
true |
PasswordSecret
| Attribute |
Value |
| name |
PasswordSecret |
| type |
xs:string |
| use |
required |
PasswordSecretEncrypted
| Attribute |
Value |
| name |
PasswordSecretEncrypted |
| type |
xs:boolean |
| use |
optional |
| default |
false |
X509StoreLocation
| Attribute |
Value |
| name |
X509StoreLocation |
| use |
optional |
| default |
LocalMachine |
X509StoreName
| Attribute |
Value |
| name |
X509StoreName |
| default |
My |
X509Thumbprint
| Attribute |
Value |
| name |
X509Thumbprint |
| type |
xs:string |
NamedPartition element
Describes a named partitioning scheme based on names for each partition.
XML source
<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>
Content element details
Partition
Describes a partition by name.
| Attribute |
Value |
| name |
Partition |
NamingReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NamingReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
NetworkConfig element
Specifies the network configuration for a container.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NetworkConfig" type="ContainerNetworkConfigType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Specifies the network configuration for a container.</xs:documentation>
</xs:annotation>
</xs:element>
NetworkPolicies element
Specifies network policies including container network policies.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NetworkPolicies" type="NetworkPoliciesType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Specifies network policies including container network policies.</xs:documentation>
</xs:annotation>
</xs:element>
Node element (type FabricNodeType)
Describes an Azure Service Fabric Node.
| Attribute |
Value |
| type |
FabricNodeType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in NodeList element, NodeList element |
| name |
Node |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Node" type="FabricNodeType" maxOccurs="unbounded"/>
Node element (type InfrastructureNodeType)
Describes an Infrastructure information needed.
| Attribute |
Value |
| type |
InfrastructureNodeType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in NodeList element |
| name |
Node |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Node" type="InfrastructureNodeType" maxOccurs="unbounded"/>
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NodeList">
<xs:complexType>
<xs:sequence>
<xs:element name="Node" type="InfrastructureNodeType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Node
NodeList element (defined in LinuxInfrastructureType)
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NodeList">
<xs:complexType>
<xs:sequence>
<xs:element name="Node" type="FabricNodeType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Node
NodeList element (defined in WindowsInfrastructureType)
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NodeList">
<xs:complexType>
<xs:sequence>
<xs:element name="Node" type="FabricNodeType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Node
NodeType element
Describe a node type.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
7 element(s), 1 attribute(s) |
| defined |
locally in NodeTypes element |
| name |
NodeType |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NodeType" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Describe a node type.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="Endpoints" type="FabricEndpointsType" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the endpoints associated with this node type</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element 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>
<xs:element name="LogicalDirectories" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the LogicalDirectories settings associated with this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LogicalDirectory" type="LogicalDirectoryType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Certificates" type="CertificatesType" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the certificates associated with this node type</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element 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 name="Capacities" minOccurs="0">
<xs:annotation>
<xs:documentation>The capacities of various metrics for this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Capacity" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="SfssRgPolicies" minOccurs="0">
<xs:annotation>
<xs:documentation>The SF system services resource governance policy for this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="SfssRgPolicy" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the NodeType</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
Name
Name of the NodeType
| Attribute |
Value |
| name |
Name |
| type |
xs:string |
| use |
required |
Content element details
Endpoints
Describe the endpoints associated with this node type
KtlLoggerSettings
Describe the KtlLogger information associated with this node type
LogicalDirectories
Describe the LogicalDirectories settings associated with this node type
| Attribute |
Value |
| name |
LogicalDirectories |
| minOccurs |
0 |
Certificates
Describe the certificates associated with this node type
PlacementProperties
Describe the properties for this NodeType that will be used as placement constraints
| Attribute |
Value |
| name |
PlacementProperties |
| minOccurs |
0 |
Capacities
The capacities of various metrics for this node type
| Attribute |
Value |
| name |
Capacities |
| minOccurs |
0 |
SfssRgPolicies
The SF system services resource governance policy for this node type
| Attribute |
Value |
| name |
SfssRgPolicies |
| minOccurs |
0 |
NodeTypes element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ClusterManifestType complexType |
| name |
NodeTypes |
| minOccurs |
1 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="NodeTypes" minOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="NodeType" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Describe a node type.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="Endpoints" type="FabricEndpointsType" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the endpoints associated with this node type</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element 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>
<xs:element name="LogicalDirectories" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the LogicalDirectories settings associated with this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="LogicalDirectory" type="LogicalDirectoryType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Certificates" type="CertificatesType" minOccurs="0">
<xs:annotation>
<xs:documentation>Describe the certificates associated with this node type</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element 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 name="Capacities" minOccurs="0">
<xs:annotation>
<xs:documentation>The capacities of various metrics for this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Capacity" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="SfssRgPolicies" minOccurs="0">
<xs:annotation>
<xs:documentation>The SF system services resource governance policy for this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="SfssRgPolicy" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="Name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the NodeType</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
NodeType
Describe a node type.
| Attribute |
Value |
| name |
NodeType |
| maxOccurs |
unbounded |
PaaS element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
2 element(s), 0 attribute(s) |
| defined |
locally in Infrastructure element |
| name |
PaaS |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="PaaS">
<xs:complexType>
<xs:all>
<xs:element name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="PaaSRoleType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Votes">
<xs:complexType>
<xs:sequence>
<xs:element name="Vote" type="PaaSVoteType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
Content element details
Roles
| Attribute |
Value |
| name |
Roles |
Votes
| Attribute |
Value |
| name |
Votes |
PackageSharingPolicy element
Indicates if a code, config or data package should be shared across service instances of the same service type.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="PackageSharingPolicy" type="PackageSharingPolicyType" minOccurs="0"/>
Parameter element (type ParameterType)
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Parameter" type="ParameterType" minOccurs="1" maxOccurs="unbounded"/>
Parameter element defined in Parameters
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.
| Attribute |
Value |
| name |
DefaultValue |
| type |
xs:string |
| use |
required |
Parameter element (defined in Parameters)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Parameters 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:attributeGroup ref="NameValuePair"/>
</xs:complexType>
</xs:element>
Parameter element defined in Section
The setting to override.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 2 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: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.
| Attribute |
Value |
| name |
IsEncrypted |
| type |
xs:boolean |
| default |
false |
Type
| Attribute |
Value |
| name |
Type |
| type |
xs:string |
| use |
optional |
Parameters element (type ParametersType)
Additional settings specified as name-value pairs
| Attribute |
Value |
| type |
ParametersType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
Parameters |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Parameters" type="ParametersType">
<xs:annotation>
<xs:documentation>Additional settings specified as name-value pairs</xs:documentation>
</xs:annotation>
</xs:element>
Parameters element (defined in AppInstanceDefinitionType)
List of parameters for the application as defined in application manifest and their respective values.
XML source
<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.
XML source
<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>
Attribute details
Name
The name of the partition
| Attribute |
Value |
| name |
Name |
| use |
required |
PersistencePolicy element
Persistence Policy extension for the Service Type
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 4 attribute(s) |
| defined |
globally |
| name |
PersistencePolicy |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="PersistencePolicy">
<xs:annotation>
<xs:documentation>Persistence Policy extension for the Service Type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Properties" type="ServiceTypeExtensionPolicyPropertiesType" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="Name" type="xs:string" use="required"/>
<xs:attribute name="Mode" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Synchronous"/>
<xs:enumeration value="Asynchronous"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="WriteBehind" type="xs:string" use="required"/>
<xs:attribute name="Provider" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
Name
| Attribute |
Value |
| name |
Name |
| type |
xs:string |
| use |
required |
Mode
| Attribute |
Value |
| name |
Mode |
| use |
required |
WriteBehind
| Attribute |
Value |
| name |
WriteBehind |
| type |
xs:string |
| use |
required |
Provider
| Attribute |
Value |
| name |
Provider |
| type |
xs:string |
| use |
required |
Content element details
Properties
PlacementConstraints 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)".
XML source
<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>
Content element details
Property
| Attribute |
Value |
| name |
Property |
| type |
KeyValuePairType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
Policies element (type ApplicationPoliciesType)
Describes the policies (log collection, default run-as, health, and security access) to be applied at the application level.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Policies" type="ApplicationPoliciesType" minOccurs="0"/>
Policies element (type ServiceManifestImportPoliciesType)
Describes policies (end-point binding, package sharing, run-as, and security access) to be applied on the imported service manifest.
| Attribute |
Value |
| type |
ServiceManifestImportPoliciesType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ServiceManifestImport element |
| name |
Policies |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Policies" type="ServiceManifestImportPoliciesType" minOccurs="0"/>
PortBinding element
Specifies which endpoint resource to bind container exposed port.
XML source
<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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Principals" type="SecurityPrincipalsType" minOccurs="0"/>
Program element
The executable name. For example, "MySetup.bat" or "MyServiceHost.exe".
XML source
<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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Properties" type="ServiceTypeExtensionPolicyPropertiesType" minOccurs="0"/>
Property element (type KeyValuePairType)
| Attribute |
Value |
| type |
KeyValuePairType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in PlacementProperties element |
| name |
Property |
| 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="Property" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
Property element (defined in ServiceTypeExtensionPolicyPropertiesType)
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Property" 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: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 |
ProviderGuid element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 1 attribute(s) |
| defined |
locally in ProviderGuids element |
| name |
ProviderGuid |
| 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="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>
Attribute details
Value
| Attribute |
Value |
| name |
Value |
| use |
required |
ProviderGuids element
Lists the ETW provider GUIDs for the components of this service manifest.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ETW element |
| name |
ProviderGuids |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" 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>
Content element details
ProviderGuid
| Attribute |
Value |
| name |
ProviderGuid |
| minOccurs |
0 |
| maxOccurs |
unbounded |
RepairManagerReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="RepairManagerReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
RepositoryCredentials element
Credentials for container image repository to pull images from.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="RepositoryCredentials" type="RepositoryCredentialsType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Credentials for container image repository to pull images from.</xs:documentation>
</xs:annotation>
</xs:element>
ResourceGovernancePolicy element
Specifies resource limits for a codepackage.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ResourceGovernancePolicy" type="ResourceGovernancePolicyType" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies resource limits for a codepackage.</xs:documentation>
</xs:annotation>
</xs:element>
ResourceOverrides element
Specifies resource overrides for endpoints declared in service manifest resources.
| Attribute |
Value |
| type |
ResourceOverridesType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ServiceManifestImport element |
| name |
ResourceOverrides |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ResourceOverrides" type="ResourceOverridesType" minOccurs="0"/>
Resources element
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Resources" type="ResourcesType" minOccurs="0"/>
Role element (type AzureRoleType)
| Attribute |
Value |
| type |
AzureRoleType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Roles element |
| name |
Role |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Role" type="AzureRoleType" maxOccurs="unbounded"/>
Role element (type BlackbirdRoleType)
| Attribute |
Value |
| type |
BlackbirdRoleType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Roles element |
| name |
Role |
| minOccurs |
1 |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Role" type="BlackbirdRoleType" minOccurs="1" maxOccurs="unbounded"/>
Role element (type PaaSRoleType)
| Attribute |
Value |
| type |
PaaSRoleType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Roles element |
| name |
Role |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Role" type="PaaSRoleType" maxOccurs="unbounded"/>
Roles element (defined in Blackbird)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in Blackbird element |
| name |
Roles |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="BlackbirdRoleType" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Role
Roles element (defined in PaaS)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in PaaS element |
| name |
Roles |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="PaaSRoleType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Role
| Attribute |
Value |
| name |
Role |
| type |
PaaSRoleType |
| maxOccurs |
unbounded |
Roles element (defined in WindowsAzure)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in WindowsAzure element |
| name |
Roles |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="AzureRoleType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Role
RunAsPolicy element
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="RunAsPolicy" type="RunAsPolicyType" minOccurs="0"/>
RunFrequency element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 1 attribute(s) |
| defined |
locally in ExeHost element |
| name |
RunFrequency |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="RunFrequency" minOccurs="0">
<xs:complexType>
<xs:attribute name="IntervalInSeconds" use="required">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="2147483647"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
IntervalInSeconds
| Attribute |
Value |
| name |
IntervalInSeconds |
| use |
required |
ScalingPolicy element
A scaling policy description consisting of a trigger and a mechanism for scaling.
| Attribute |
Value |
| type |
ScalingPolicyType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ServiceScalingPolicies element |
| name |
ScalingPolicy |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ScalingPolicy" type="ScalingPolicyType" maxOccurs="unbounded"/>
SecretsCertificate element
This specifies the certificate information.
| Attribute |
Value |
| type |
FabricCertificateType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Certificates element, Certificates element, DigestedCertificates element |
| name |
SecretsCertificate |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SecretsCertificate" type="FabricCertificateType" minOccurs="0"/>
Section element (defined in SettingsOverridesType)
A section in the Settings.xml file to override.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 1 attribute(s) |
| defined |
locally in SettingsOverridesType complexType |
| name |
Section |
| maxOccurs |
unbounded |
XML source
<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.
| Attribute |
Value |
| name |
Name |
| use |
required |
Content element details
Parameter
The setting to override.
| Attribute |
Value |
| name |
Parameter |
| minOccurs |
0 |
| maxOccurs |
unbounded |
Section element (defined in SettingsType)
A user-defined named section.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 1 attribute(s) |
| defined |
locally in SettingsType complexType |
| name |
Section |
| 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="Section" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A user-defined named section.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element 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>
</xs:sequence>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
Name
| Attribute |
Value |
| name |
Name |
| type |
xs:string |
| use |
required |
Content element details
Parameter
| Attribute |
Value |
| name |
Parameter |
| minOccurs |
0 |
| maxOccurs |
unbounded |
SecurityAccessPolicies element
List of security policies applied to resources at the application level.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SecurityAccessPolicies" minOccurs="0">
<xs:annotation>
<xs:documentation>List of security policies applied to resources at the application level.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence maxOccurs="unbounded">
<xs:element name="SecurityAccessPolicy" type="SecurityAccessPolicyType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
SecurityAccessPolicy
SecurityAccessPolicy element
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SecurityAccessPolicy" type="SecurityAccessPolicyType" minOccurs="0"/>
SecurityOption element
Specifies securityoptions for the container.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SecurityOption" type="SecurityOptionsType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Specifies securityoptions for the container.</xs:documentation>
</xs:annotation>
</xs:element>
ServerCertificate element
The certificate used to secure the intra cluster communication.
XML source
<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.
XML source
<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.
| Attribute |
Value |
| name |
ServicePackageActivationMode |
| type |
xs:string |
| use |
optional |
| default |
SharedProcess |
Content element details
StatelessService
StatefulService
ServiceConnectionEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceConnectionEndpoint" type="InternalEndpointType" minOccurs="0"/>
ServiceCorrelation element
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.
| Attribute |
Value |
| name |
Scheme |
| use |
required |
ServiceCorrelations element
Defines affinity relationships between services.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceType complexType |
| name |
ServiceCorrelations |
| minOccurs |
0 |
XML source
<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.
XML source
<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.
XML source
<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.
| Attribute |
Value |
| name |
ServicePackageActivationMode |
| type |
xs:string |
| use |
optional |
| default |
SharedProcess |
Content element details
StatelessServiceGroup
StatefulServiceGroup
ServiceGroupMembers element
Member types of this service group type.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceGroupTypeType complexType |
| name |
ServiceGroupMembers |
| minOccurs |
0 |
| maxOccurs |
1 |
XML source
<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.
| Attribute |
Value |
| type |
ServiceManifestType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
ServiceManifest |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceManifest" type="ServiceManifestType"/>
ServiceManifestImport element
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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
5 element(s), 0 attribute(s) |
| defined |
locally in ApplicationManifestType complexType |
| name |
ServiceManifestImport |
| maxOccurs |
unbounded |
XML source
<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>
Content element details
ServiceManifestRef
ConfigOverrides
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 |
| name |
ConfigOverrides |
| minOccurs |
0 |
ResourceOverrides
EnvironmentOverrides
Policies
ServiceManifestRef element
Imports the service manifest by reference. Currently the service manifest file (ServiceManifest.xml) must be present in the build package.
| Attribute |
Value |
| type |
ServiceManifestRefType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ServiceManifestImport element |
| name |
ServiceManifestRef |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceManifestRef" type="ServiceManifestRefType"/>
ServicePackage element
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.
| Attribute |
Value |
| type |
ServicePackageType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
ServicePackage |
XML source
<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>
ServicePackageContainerPolicy element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServicePackageContainerPolicy" type="ServicePackageContainerPolicyType" minOccurs="0" maxOccurs="1"/>
ServicePackageRef element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 1 attribute(s) |
| defined |
locally in ApplicationInstanceType complexType |
| name |
ServicePackageRef |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServicePackageRef" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="Name" use="required"/>
<xs:attributeGroup ref="VersionedItemAttrGroup"/>
</xs:complexType>
</xs:element>
Attribute details
Name
| Attribute |
Value |
| name |
Name |
| use |
required |
ServicePackageResourceGovernancePolicy element
Defines the resource governance policy that is applied at the level of the entire service package.
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceTypeType complexType |
| name |
ServicePlacementPolicies |
| minOccurs |
0 |
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceType complexType |
| name |
ServicePlacementPolicies |
| minOccurs |
0 |
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in ServiceType complexType |
| name |
ServiceScalingPolicies |
| minOccurs |
0 |
XML source
<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>
Content element details
ScalingPolicy
ServiceTemplates 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.
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ApplicationHealthPolicyType complexType |
| name |
ServiceTypeHealthPolicy |
| 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="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.
XML source
<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>
ServiceTypes element (type ServiceTypesType)
| Attribute |
Value |
| type |
ServiceTypesType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in DigestedServiceTypes element |
| name |
ServiceTypes |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="ServiceTypes" type="ServiceTypesType"/>
Settings element (type SettingsOverridesType)
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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Settings" type="SettingsOverridesType" minOccurs="0"/>
Settings element (type SettingsType)
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.
| Attribute |
Value |
| type |
SettingsType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
Settings |
XML source
<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.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in CodePackageType complexType |
| name |
SetupEntryPoint |
| minOccurs |
0 |
XML source
<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>
Content element details
ExeHost
SfssRgPolicies element
The SF system services resource governance policy for this node type
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in NodeType element |
| name |
SfssRgPolicies |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SfssRgPolicies" minOccurs="0">
<xs:annotation>
<xs:documentation>The SF system services resource governance policy for this node type</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="SfssRgPolicy" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
SfssRgPolicy
| Attribute |
Value |
| name |
SfssRgPolicy |
| type |
KeyValuePairType |
| minOccurs |
0 |
| maxOccurs |
unbounded |
SfssRgPolicy element
| Attribute |
Value |
| type |
KeyValuePairType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in SfssRgPolicies element |
| name |
SfssRgPolicy |
| 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="SfssRgPolicy" type="KeyValuePairType" minOccurs="0" maxOccurs="unbounded"/>
SharedLogFileId element
Specific GUID to use as the shared log ID.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SharedLogFileId" minOccurs="0">
<xs:annotation>
<xs:documentation>Specific GUID to use as the shared log ID.</xs:documentation>
</xs:annotation>
<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>
Attribute details
Value
| Attribute |
Value |
| name |
Value |
| use |
required |
SharedLogFilePath element
Defines path to shared log.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SharedLogFilePath" minOccurs="0">
<xs:annotation>
<xs:documentation>Defines path to shared log.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Value" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
Value
| Attribute |
Value |
| name |
Value |
| type |
xs:string |
| use |
required |
SharedLogFileSizeInMB element
Defines how large is the shared log.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="SharedLogFileSizeInMB" minOccurs="0">
<xs:annotation>
<xs:documentation>Defines how large is the shared log.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Value" use="required">
<xs:simpleType>
<xs:restriction base="xs:int">
<xs:minInclusive value="512"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
Attribute details
Value
| Attribute |
Value |
| name |
Value |
| use |
required |
SingletonPartition element
Declares that this service has only one partition.
XML source
<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>
StatefulService element
Defines a stateful service.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="StatefulService" type="StatefulServiceType"/>
StatefulServiceGroup element
Defines a stateful service group.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="StatefulServiceGroup" type="StatefulServiceGroupType"/>
StatefulServiceGroupType element
Describes a stateful service group type.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="StatefulServiceGroupType" type="StatefulServiceGroupTypeType"/>
StatefulServiceType element
Describes a stateful service type.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="StatefulServiceType" type="StatefulServiceTypeType"/>
StatelessService element
Defines a stateless service.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="StatelessService" type="StatelessServiceType"/>
StatelessServiceGroup element
Defines a stateless service group.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="StatelessServiceGroup" type="StatelessServiceGroupType"/>
StatelessServiceGroupType element
Describes a stateless service group type.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="StatelessServiceGroupType" type="StatelessServiceGroupTypeType"/>
StatelessServiceType element
Describes a stateless service type.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="StatelessServiceType" type="StatelessServiceTypeType"/>
SystemGroup element (defined in MemberOf)
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>
Attribute details
Name
The name of the system group.
| Attribute |
Value |
| name |
Name |
| type |
xs:string |
| use |
required |
SystemGroup element (defined in Membership)
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 1 attribute(s) |
| defined |
locally in Membership 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:complexType>
<xs:attribute name="Name" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
Attribute details
Name
| Attribute |
Value |
| name |
Name |
| type |
xs:string |
| use |
required |
Describes the target the FabricDeployer needs to deploy.
| Attribute |
Value |
| type |
TargetInformationType |
| content |
0 element(s), 0 attribute(s) |
| defined |
globally |
| name |
TargetInformation |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="TargetInformation" type="TargetInformationType">
<xs:annotation>
<xs:documentation>Describes the target the FabricDeployer needs to deploy.</xs:documentation>
</xs:annotation>
</xs:element>
TargetInstallation element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="TargetInstallation" type="WindowsFabricDeploymentInformation" minOccurs="1"/>
Describes a uniform partitioning scheme based on Int64 keys.
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 3 attribute(s) |
| defined |
locally in PartitionDescriptionGroup group |
| name |
UniformInt64Partition |
XML source
<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.
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="UnmanagedDll" type="UnmanagedDllType"/>
UpgradeOrchestrationServiceReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="UpgradeOrchestrationServiceReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
UpgradeServiceReplicatorEndpoint element
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="UpgradeServiceReplicatorEndpoint" type="InternalEndpointType" minOccurs="0"/>
User element
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 |
| 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.
XML source
<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.
XML source
<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.
| Attribute |
Value |
| name |
User |
| maxOccurs |
unbounded |
Volume element
Specifies the volume to be bound to container.
XML source
<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>
Vote element
| Attribute |
Value |
| type |
PaaSVoteType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Votes element |
| name |
Vote |
| maxOccurs |
unbounded |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Vote" type="PaaSVoteType" maxOccurs="unbounded"/>
Votes element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in PaaS element |
| name |
Votes |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="Votes">
<xs:complexType>
<xs:sequence>
<xs:element name="Vote" type="PaaSVoteType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Vote
| Attribute |
Value |
| name |
Vote |
| type |
PaaSVoteType |
| maxOccurs |
unbounded |
WindowsAzure element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
1 element(s), 0 attribute(s) |
| defined |
locally in Infrastructure element |
| name |
WindowsAzure |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="WindowsAzure">
<xs:complexType>
<xs:sequence>
<xs:element name="Roles">
<xs:complexType>
<xs:sequence>
<xs:element name="Role" type="AzureRoleType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
Content element details
Roles
| Attribute |
Value |
| name |
Roles |
WindowsAzureStaticTopology element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Infrastructure element |
| name |
WindowsAzureStaticTopology |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="WindowsAzureStaticTopology">
<xs:complexType>
<xs:complexContent>
<xs:extension base="WindowsInfrastructureType"/>
</xs:complexContent>
</xs:complexType>
</xs:element>
WindowsServer element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in Infrastructure element |
| name |
WindowsServer |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="WindowsServer">
<xs:complexType>
<xs:complexContent>
<xs:extension base="WindowsInfrastructureType">
<xs:attribute name="IsScaleMin" type="xs:boolean" default="false"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
WorkingFolder element
| Attribute |
Value |
| type |
anonymous complexType |
| content |
0 element(s), 0 attribute(s) |
| defined |
locally in ExeHostEntryPointType complexType |
| name |
WorkingFolder |
| default |
Work |
| minOccurs |
0 |
XML source
<xs:element xmlns:xs="https://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/2011/01/fabric" name="WorkingFolder" default="Work" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Work"/>
<xs:enumeration value="CodePackage"/>
<xs:enumeration value="CodeBase"/>
</xs:restriction>
</xs:simpleType>
</xs:element>