netstandard/Microsoft.ServiceFabric.Powershell.Http.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.ServiceFabric.Powershell.Http</name> </assembly> <members> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ArgumentVerifier"> <summary> A utility class to perform argument validations. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ArgumentVerifier.ThrowIfNull(System.Object,System.String)"> <summary> Throws ArgumentNullException if argument is null. </summary> <param name="value">Argument value to check.</param> <param name="name">Name of Argument.</param> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase"> <summary> Base class for Service Fabric Powershell Commandlets. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase.ServiceFabricClient"> <summary> Gets the service fabric client object </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase.CancellationToken"> <summary> Gets the cancellation Token object </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase.StopProcessing"> <inheritdoc /> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase.EndProcessing"> <inheritdoc /> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase.FormatOutput(System.Object)"> <summary> Format the output of cmdlet by adding specific property or including tables for better interpretation </summary> <param name="output"> Result returned by the PS cmdlet </param> <returns> Returns the formatted output </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase.ProcessRecordInternal"> <summary> Function that defines the behavior of PS cmdlet. Contains the core logic of the PS cmdlet. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase.ProcessRecord"> <summary> Wrapper function around the ProcessRecordInternal() of PS cmdlet. Used to handle errors in a standard way. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CommonCmdletBase.ThrowTerminatingError(System.Exception,System.String,System.Object)"> <summary> Throws Terminating Error. </summary> <param name="exception">Exception which is caught by ProcessRecord..</param> <param name="errorId">Error Id.</param> <param name="target">Target.</param> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet"> <summary> Cmdlet to connect to Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.ConnectionEndpoint"> <summary> Gets or sets Service Faric cluster http gateway endpoint address. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.WindowsCredential"> <summary> Gets or sets switch parameter for selecting Windows credentials when connecting to Service Fabric cluster secured with Windows credentials. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.X509Credential"> <summary> Gets or sets switch parameter for slecting X509 Credentials when connecting to Service Fabric Cluster secured with X509 certificate. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.AzureActiveDirectory"> <summary> Gets or sets switch parameter for slecting Azure Active Directory credentials when connecting to Service Fabric Cluster secured with Azure Active Directory.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.DSTS"> <summary> Gets or sets switch parameter for slecting DSTS credentials. This parameter is for internal use only. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.ServerCommonName"> <summary> Gets or sets Subject common names or DNS names of X509 certificate of the server. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.IssuerCertThumbprints"> <summary> Gets or sets Issuer Cert thumbprints for X509 certificate of the server. When provided alongwith ServerCommonName, its used to validate server cert's issuer thumbprint. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.ServerCertThumbprint"> <summary> Gets or sets thumbprint of X509 certificate of the server. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.ClientTimeout"> <summary> Gets or sets client timeout in seconds used by underlying http client to wait before the request times out. The default value for this parameter is 90 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.GetMetadata"> <summary> Gets or sets the switch to get Azure Active Directory metadata. When this switch is specified, Connect commandlet displays the Azure aCtive Directory metadata without validating the connection with AAD credentials. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.ClientCertificate"> <summary> Gets or sets the client certificate. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.FindType"> <summary> Gets or sets the <see cref="T:System.Security.Cryptography.X509Certificates.X509FindType"/> to find the client certificate. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.FindValue"> <summary> Gets or sets the FindValue to find the client certificate. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.StoreLocation"> <summary> Gets or sets the <see cref="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.StoreLocation"/> to find the client certificate. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.StoreName"> <summary> Gets or sets the StoreName to find the client certificate. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.SecurityToken"> <summary> Gets or sets the Azure Active Directory Security Token. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.BeginProcessing"> <inheritdoc /> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ConnectClusterCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ConnectionParameters"> <summary> Represents Connection Parameters for connecting to Local Cluster. </summary> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.CopyApplicationPackageCmdlet"> <summary> Uploads application package to image store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyApplicationPackageCmdlet.ApplicationPackagePath"> <summary> Gets or sets the application package path. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyApplicationPackageCmdlet.ApplicationPackagePathInImageStore"> <summary> Gets or sets the application package path in image store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyApplicationPackageCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CopyApplicationPackageCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.CredentialsUtil"> <summary> Contains methods for getting credentials from AAD and loading X509 certificates. </summary> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.DeployMeshResourcesCmdlet"> <summary> Deploys mesh resources in a Service Fabric Mesh cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DeployMeshResourcesCmdlet.ResourceDescriptionList"> <summary> Gets or sets Resource Description Files, which is a list of yaml definitions for the resources </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DeployMeshResourcesCmdlet.ParameterFileName"> <summary> Gets or sets the path to parameter file containing parameter values to be replaced in the yamls. Values to be parameterised are specified in yaml files as "[parameters('ParamName')]". </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DeployMeshResourcesCmdlet.SecretsParameterFileName"> <summary> Gets or sets the path to secrets parameter file containing parameter values to be replaced in the yamls. Values to be parameterised are specified in yaml files as "[parameters('ParamName')]". </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DeployMeshResourcesCmdlet.OutputDirectory"> <summary> Gets or sets the output directory for the generated resource descriptions. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.DeployMeshResourcesCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.HelperExtensions"> <summary> Class containing helper extension methods. </summary> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.AddConfigurationParameterOverridesCmdlet"> <summary> Adds the list of configuration overrides on the specified node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.AddConfigurationParameterOverridesCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.AddConfigurationParameterOverridesCmdlet.ConfigParameterOverrideList"> <summary> Gets or sets ConfigParameterOverrideList. Description for adding list of configuration overrides. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.AddConfigurationParameterOverridesCmdlet.Force"> <summary> Gets or sets Force. Force adding configuration overrides on specified nodes. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.AddConfigurationParameterOverridesCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.AddConfigurationParameterOverridesCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.AddNodeTagsCmdlet"> <summary> Adds the list of tags on the specified node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.AddNodeTagsCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.AddNodeTagsCmdlet.NodeTags"> <summary> Gets or sets NodeTags. Description for adding list of node tags. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.AddNodeTagsCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet"> <summary> Triggers backup of the partition's state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.AzureBlobStore"> <summary> Gets or sets AzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.FileShare"> <summary> Gets or sets FileShare flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.DsmsAzureBlobStore"> <summary> Gets or sets DsmsAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.ManagedIdentityAzureBlobStore"> <summary> Gets or sets ManagedIdentityAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.ConnectionString"> <summary> Gets or sets ConnectionString. The connection string to connect to the Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.ContainerName"> <summary> Gets or sets ContainerName. The name of the container in the blob store to store and enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.Path"> <summary> Gets or sets Path. UNC path of the file share where to store or enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.StorageCredentialsSourceLocation"> <summary> Gets or sets StorageCredentialsSourceLocation. The source location of the storage credentials to connect to the Dsms Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.ManagedIdentityType"> <summary> Gets or sets ManagedIdentityType. The type of managed identity to be used to connect to Azure Blob Store via Managed Identity. . Possible values include: 'Invalid', 'VMSS', 'Cluster' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.BlobServiceUri"> <summary> Gets or sets BlobServiceUri. The Blob Service Uri to connect to the Azure blob store.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.FriendlyName"> <summary> Gets or sets FriendlyName. Friendly name for this backup storage. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.PrimaryUserName"> <summary> Gets or sets PrimaryUserName. Primary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.PrimaryPassword"> <summary> Gets or sets PrimaryPassword. Primary password to access the share location. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.SecondaryUserName"> <summary> Gets or sets SecondaryUserName. Secondary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.SecondaryPassword"> <summary> Gets or sets SecondaryPassword. Secondary password to access the share location </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.ManagedIdentityClientId"> <summary> Gets or sets ManagedIdentityClientId. The ClientId of User-Assigned Managed Identity </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.BackupTimeout"> <summary> Gets or sets BackupTimeout. Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.BackupPartitionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.CopyImageStoreContentCmdlet"> <summary> Copies image store content internally </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyImageStoreContentCmdlet.RemoteSource"> <summary> Gets or sets RemoteSource. The relative path of source image store content to be copied from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyImageStoreContentCmdlet.RemoteDestination"> <summary> Gets or sets RemoteDestination. The relative path of destination image store content to be copied to. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyImageStoreContentCmdlet.SkipFiles"> <summary> Gets or sets SkipFiles. The list of the file names to be skipped for copying. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyImageStoreContentCmdlet.CheckMarkFile"> <summary> Gets or sets CheckMarkFile. Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyImageStoreContentCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CopyImageStoreContentCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.CopyServicePackageToNodeCmdlet"> <summary> Downloads all of the code packages associated with specified service manifest on the specified node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyServicePackageToNodeCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyServicePackageToNodeCmdlet.ServiceManifestName"> <summary> Gets or sets ServiceManifestName. The name of service manifest whose packages need to be downloaded. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyServicePackageToNodeCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The application type name as defined in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyServicePackageToNodeCmdlet.ApplicationTypeVersion"> <summary> Gets or sets ApplicationTypeVersion. The version of the application type as defined in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyServicePackageToNodeCmdlet.PackageSharingPolicy"> <summary> Gets or sets PackageSharingPolicy. List of package sharing policy information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.CopyServicePackageToNodeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.CopyServicePackageToNodeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.DisableApplicationBackupCmdlet"> <summary> Disables periodic backup of Service Fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableApplicationBackupCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableApplicationBackupCmdlet.CleanBackup"> <summary> Gets or sets CleanBackup. Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableApplicationBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableApplicationBackupCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.DisableApplicationBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.DisableNodeCmdlet"> <summary> Deactivate a Service Fabric cluster node with the specified deactivation intent. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableNodeCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableNodeCmdlet.DeactivationIntent"> <summary> Gets or sets DeactivationIntent. Describes the intent or reason for deactivating the node. The possible values are following. . Possible values include: 'Pause', 'Restart', 'RemoveData', 'RemoveNode' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableNodeCmdlet.DeactivationDescription"> <summary> Gets or sets DeactivationDescription. Describes the reason or more information about node deactivation. Maximum number of characters allowed is 200. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableNodeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableNodeCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.DisableNodeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.DisablePartitionBackupCmdlet"> <summary> Disables periodic backup of Service Fabric partition which was previously enabled. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisablePartitionBackupCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisablePartitionBackupCmdlet.CleanBackup"> <summary> Gets or sets CleanBackup. Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisablePartitionBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisablePartitionBackupCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.DisablePartitionBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.DisableServiceBackupCmdlet"> <summary> Disables periodic backup of Service Fabric service which was previously enabled. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableServiceBackupCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableServiceBackupCmdlet.CleanBackup"> <summary> Gets or sets CleanBackup. Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableServiceBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.DisableServiceBackupCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.DisableServiceBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.EnableApplicationBackupCmdlet"> <summary> Enables periodic backup of stateful partitions under this Service Fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnableApplicationBackupCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnableApplicationBackupCmdlet.BackupPolicyName"> <summary> Gets or sets BackupPolicyName. Name of the backup policy to be used for enabling periodic backups. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnableApplicationBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.EnableApplicationBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.EnableNodeCmdlet"> <summary> Activate a Service Fabric cluster node that is currently deactivated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnableNodeCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnableNodeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.EnableNodeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.EnablePartitionBackupCmdlet"> <summary> Enables periodic backup of the stateful persisted partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnablePartitionBackupCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnablePartitionBackupCmdlet.BackupPolicyName"> <summary> Gets or sets BackupPolicyName. Name of the backup policy to be used for enabling periodic backups. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnablePartitionBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.EnablePartitionBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.EnableServiceBackupCmdlet"> <summary> Enables periodic backup of stateful partitions under this Service Fabric service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnableServiceBackupCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnableServiceBackupCmdlet.BackupPolicyName"> <summary> Gets or sets BackupPolicyName. Name of the backup policy to be used for enabling periodic backups. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.EnableServiceBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.EnableServiceBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetAadMetadataCmdlet"> <summary> Gets the Azure Active Directory metadata used for secured connection to cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetAadMetadataCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetAadMetadataCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetAadMetadataCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetAllEntitiesBackedUpByPolicyCmdlet"> <summary> Gets the list of backup entities that are associated with this policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetAllEntitiesBackedUpByPolicyCmdlet.BackupPolicyName"> <summary> Gets or sets BackupPolicyName. The name of the backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetAllEntitiesBackedUpByPolicyCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetAllEntitiesBackedUpByPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetAllEntitiesBackedUpByPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetAllEntitiesBackedUpByPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupConfigurationInfoCmdlet"> <summary> Gets the Service Fabric application backup configuration information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupConfigurationInfoCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupConfigurationInfoCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupConfigurationInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupConfigurationInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupConfigurationInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet"> <summary> Gets the list of backups available for every partition in this application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet.Latest"> <summary> Gets or sets Latest. Specifies whether to get only the most recent backup available for a partition for the specified time range. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet.StartDateTimeFilter"> <summary> Gets or sets StartDateTimeFilter. Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet.EndDateTimeFilter"> <summary> Gets or sets EndDateTimeFilter. Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationBackupListCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet"> <summary> Gets the list of applications created in the Service Fabric cluster that match the specified filters. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet.ApplicationDefinitionKindFilter"> <summary> Gets or sets ApplicationDefinitionKindFilter. Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application. - Default - Default value, which performs the same function as selecting "All". The value is 0. - All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535. - ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1. - Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The application type name used to filter the applications to query for. This value should not contain the application type version. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet.ExcludeApplicationParameters"> <summary> Gets or sets ExcludeApplicationParameters. The flag that specifies whether application parameters will be excluded from the result. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet"> <summary> Gets the health of the service fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet.DeployedApplicationsHealthStateFilter"> <summary> Gets or sets DeployedApplicationsHealthStateFilter. Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned. All deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet.ServicesHealthStateFilter"> <summary> Gets or sets ServicesHealthStateFilter. Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet"> <summary> Gets the health of a Service Fabric application using the specified policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.DeployedApplicationsHealthStateFilter"> <summary> Gets or sets DeployedApplicationsHealthStateFilter. Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned. All deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.ServicesHealthStateFilter"> <summary> Gets or sets ServicesHealthStateFilter. Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationHealthUsingPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationLoadInfoCmdlet"> <summary> Gets load information about a Service Fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationLoadInfoCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationLoadInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationLoadInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationLoadInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationManifestCmdlet"> <summary> Gets the manifest describing an application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationManifestCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The name of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationManifestCmdlet.ApplicationTypeVersion"> <summary> Gets or sets ApplicationTypeVersion. The version of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationManifestCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationManifestCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationManifestCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationNameInfoCmdlet"> <summary> Gets the name of the Service Fabric application for a service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationNameInfoCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationNameInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationNameInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationNameInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet"> <summary> Gets all Applications-related events. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet.StartTimeUtc"> <summary> Gets or sets StartTimeUtc. The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet.EndTimeUtc"> <summary> Gets or sets EndTimeUtc. The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet.EventsTypesFilter"> <summary> Gets or sets EventsTypesFilter. This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet.ExcludeAnalysisEvents"> <summary> Gets or sets ExcludeAnalysisEvents. This param disables the retrieval of AnalysisEvents if true is passed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet.SkipCorrelationLookup"> <summary> Gets or sets SkipCorrelationLookup. This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationsEventCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet"> <summary> Gets the list of application types in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The name of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet.ApplicationTypeDefinitionKindFilter"> <summary> Gets or sets ApplicationTypeDefinitionKindFilter. Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type. - Default - Default value, which performs the same function as selecting "All". The value is 0. - All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535. - ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1. - Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet.ExcludeApplicationParameters"> <summary> Gets or sets ExcludeApplicationParameters. The flag that specifies whether application parameters will be excluded from the result. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet.ApplicationTypeVersion"> <summary> Gets or sets ApplicationTypeVersion. The version of the application type. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationTypeCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetApplicationUpgradeCmdlet"> <summary> Gets details for the latest upgrade performed on this application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationUpgradeCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetApplicationUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetApplicationUpgradeCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetBackupPolicyCmdlet"> <summary> Gets all the backup policies configured. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupPolicyCmdlet.BackupPolicyName"> <summary> Gets or sets BackupPolicyName. The name of the backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupPolicyCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetBackupPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetBackupPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet"> <summary> Gets the list of backups available for the specified backed up entity at the specified backup location. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.AzureBlobStore"> <summary> Gets or sets AzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.FileShare"> <summary> Gets or sets FileShare flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.DsmsAzureBlobStore"> <summary> Gets or sets DsmsAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ManagedIdentityAzureBlobStore"> <summary> Gets or sets ManagedIdentityAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.Application"> <summary> Gets or sets Application flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.Service"> <summary> Gets or sets Service flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.Partition"> <summary> Gets or sets Partition flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ConnectionString"> <summary> Gets or sets ConnectionString. The connection string to connect to the Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ContainerName"> <summary> Gets or sets ContainerName. The name of the container in the blob store to store and enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.Path"> <summary> Gets or sets Path. UNC path of the file share where to store or enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.StorageCredentialsSourceLocation"> <summary> Gets or sets StorageCredentialsSourceLocation. The source location of the storage credentials to connect to the Dsms Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ManagedIdentityType"> <summary> Gets or sets ManagedIdentityType. The type of managed identity to be used to connect to Azure Blob Store via Managed Identity. . Possible values include: 'Invalid', 'VMSS', 'Cluster' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.BlobServiceUri"> <summary> Gets or sets BlobServiceUri. The Blob Service Uri to connect to the Azure blob store.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.StartDateTimeFilter"> <summary> Gets or sets StartDateTimeFilter. Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.EndDateTimeFilter"> <summary> Gets or sets EndDateTimeFilter. Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.Latest"> <summary> Gets or sets Latest. If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.FriendlyName"> <summary> Gets or sets FriendlyName. Friendly name for this backup storage. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.PrimaryUserName"> <summary> Gets or sets PrimaryUserName. Primary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.PrimaryPassword"> <summary> Gets or sets PrimaryPassword. Primary password to access the share location. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.SecondaryUserName"> <summary> Gets or sets SecondaryUserName. Secondary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.SecondaryPassword"> <summary> Gets or sets SecondaryPassword. Secondary password to access the share location </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ManagedIdentityClientId"> <summary> Gets or sets ManagedIdentityClientId. The ClientId of User-Assigned Managed Identity </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ApplicationName"> <summary> Gets or sets ApplicationName. The name of the application, including the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ServiceName"> <summary> Gets or sets ServiceName. The full name of the service with 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The partition ID identifying the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetBackupsFromBackupLocationCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetChaosCmdlet"> <summary> Get the status of Chaos. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetChaosCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetChaosCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetChaosCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetChaosEventsCmdlet"> <summary> Gets the next segment of the Chaos events based on the continuation token or the time range. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetChaosEventsCmdlet.StartTimeUtc"> <summary> Gets or sets StartTimeUtc. The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetChaosEventsCmdlet.EndTimeUtc"> <summary> Gets or sets EndTimeUtc. The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetChaosEventsCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetChaosEventsCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetChaosEventsCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetChaosEventsCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetChaosScheduleCmdlet"> <summary> Get the Chaos Schedule defining when and how to run Chaos. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetChaosScheduleCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetChaosScheduleCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetChaosScheduleCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationCmdlet"> <summary> Get the Service Fabric standalone cluster configuration. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationCmdlet.ConfigurationApiVersion"> <summary> Gets or sets ConfigurationApiVersion. The API version of the Standalone cluster json configuration. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationUpgradeStatusCmdlet"> <summary> Get the cluster configuration upgrade status of a Service Fabric standalone cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationUpgradeStatusCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationUpgradeStatusCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterConfigurationUpgradeStatusCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterEventListCmdlet"> <summary> Gets all Cluster-related events. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterEventListCmdlet.StartTimeUtc"> <summary> Gets or sets StartTimeUtc. The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterEventListCmdlet.EndTimeUtc"> <summary> Gets or sets EndTimeUtc. The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterEventListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterEventListCmdlet.EventsTypesFilter"> <summary> Gets or sets EventsTypesFilter. This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterEventListCmdlet.ExcludeAnalysisEvents"> <summary> Gets or sets ExcludeAnalysisEvents. This param disables the retrieval of AnalysisEvents if true is passed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterEventListCmdlet.SkipCorrelationLookup"> <summary> Gets or sets SkipCorrelationLookup. This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterEventListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkCmdlet"> <summary> Gets the health of a Service Fabric cluster using health chunks. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet"> <summary> Gets the health of a Service Fabric cluster using health chunks. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.NodeFilters"> <summary> Gets or sets NodeFilters. Defines a list of filters that specify which nodes to be included in the returned cluster health chunk. If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple node filters. For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.ApplicationFilters"> <summary> Gets or sets ApplicationFilters. Defines a list of filters that specify which applications to be included in the returned cluster health chunk. If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple application filters. For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.MaxPercentUnhealthyNodes"> <summary> Gets or sets MaxPercentUnhealthyNodes. The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.MaxPercentUnhealthyApplications"> <summary> Gets or sets MaxPercentUnhealthyApplications. The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.ApplicationTypeHealthPolicyMap"> <summary> Gets or sets ApplicationTypeHealthPolicyMap. Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.NodeTypeHealthPolicyMap"> <summary> Gets or sets NodeTypeHealthPolicyMap. Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type. The node type health policy map can be used during cluster health evaluation to describe special node types. They are evaluated against the percentages associated with their node type name in the map. Setting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. The node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation. For example, given a cluster with many nodes of different types, with important work hosted on node type "SpecialNodeType" that should not tolerate any nodes down. You can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type "SpecialNodeType", set the MaxPercentUnhealthyNodes to 0 by setting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. This way, as long as no nodes of type "SpecialNodeType" are in Error state, even if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. A Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. But even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. Conversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, with one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.ApplicationHealthPolicyMap"> <summary> Gets or sets ApplicationHealthPolicyMap. The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet"> <summary> Gets the health of a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet.NodesHealthStateFilter"> <summary> Gets or sets NodesHealthStateFilter. Allows filtering of the node health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet.ApplicationsHealthStateFilter"> <summary> Gets or sets ApplicationsHealthStateFilter. Allows filtering of the application health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value obtained from members or bitwise operations on members of HealthStateFilter enumeration. Only applications that match the filter are returned. All applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet.IncludeSystemApplicationHealthStatistics"> <summary> Gets or sets IncludeSystemApplicationHealthStatistics. Indicates whether the health statistics should include the fabric:/System application health statistics. False by default. If IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application. Otherwise, the query result includes health statistics only for user applications. The health statistics must be included in the query result for this parameter to be applied. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet"> <summary> Gets the health of a Service Fabric cluster using the specified policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.NodesHealthStateFilter"> <summary> Gets or sets NodesHealthStateFilter. Allows filtering of the node health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.ApplicationsHealthStateFilter"> <summary> Gets or sets ApplicationsHealthStateFilter. Allows filtering of the application health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value obtained from members or bitwise operations on members of HealthStateFilter enumeration. Only applications that match the filter are returned. All applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.IncludeSystemApplicationHealthStatistics"> <summary> Gets or sets IncludeSystemApplicationHealthStatistics. Indicates whether the health statistics should include the fabric:/System application health statistics. False by default. If IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application. Otherwise, the query result includes health statistics only for user applications. The health statistics must be included in the query result for this parameter to be applied. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.ApplicationHealthPolicyMap"> <summary> Gets or sets ApplicationHealthPolicyMap. Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.MaxPercentUnhealthyNodes"> <summary> Gets or sets MaxPercentUnhealthyNodes. The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.MaxPercentUnhealthyApplications"> <summary> Gets or sets MaxPercentUnhealthyApplications. The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.ApplicationTypeHealthPolicyMap"> <summary> Gets or sets ApplicationTypeHealthPolicyMap. Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.NodeTypeHealthPolicyMap"> <summary> Gets or sets NodeTypeHealthPolicyMap. Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type. The node type health policy map can be used during cluster health evaluation to describe special node types. They are evaluated against the percentages associated with their node type name in the map. Setting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. The node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation. For example, given a cluster with many nodes of different types, with important work hosted on node type "SpecialNodeType" that should not tolerate any nodes down. You can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type "SpecialNodeType", set the MaxPercentUnhealthyNodes to 0 by setting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. This way, as long as no nodes of type "SpecialNodeType" are in Error state, even if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. A Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. But even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. Conversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, with one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterHealthUsingPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterLoadCmdlet"> <summary> Gets the load of a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterLoadCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterLoadCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterLoadCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterManifestCmdlet"> <summary> Get the Service Fabric cluster manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterManifestCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterManifestCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterManifestCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterUpgradeProgressCmdlet"> <summary> Gets the progress of the current cluster upgrade. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterUpgradeProgressCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterUpgradeProgressCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterUpgradeProgressCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetClusterVersionCmdlet"> <summary> Get the current Service Fabric cluster version. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetClusterVersionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterVersionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetClusterVersionCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusCmdlet"> <summary> Gets information about a Service Fabric compose deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusCmdlet.DeploymentName"> <summary> Gets or sets DeploymentName. The identity of the deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusListCmdlet"> <summary> Gets the list of compose deployments created in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusListCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentStatusListCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentUpgradeProgressCmdlet"> <summary> Gets details for the latest upgrade performed on this Service Fabric compose deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentUpgradeProgressCmdlet.DeploymentName"> <summary> Gets or sets DeploymentName. The identity of the deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentUpgradeProgressCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentUpgradeProgressCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetComposeDeploymentUpgradeProgressCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetConfigurationOverridesCmdlet"> <summary> Gets the list of configuration overrides on the specified node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetConfigurationOverridesCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetConfigurationOverridesCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetConfigurationOverridesCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet"> <summary> Gets the container logs for container deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.ServiceManifestName"> <summary> Gets or sets ServiceManifestName. The name of a service manifest registered as part of an application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.CodePackageName"> <summary> Gets or sets CodePackageName. The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.Tail"> <summary> Gets or sets Tail. Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.Previous"> <summary> Gets or sets Previous. Specifies whether to get container logs from exited/dead containers of the code package instance. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsDeployedOnNodeCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsMeshCodePackageCmdlet"> <summary> Gets the logs from the container. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsMeshCodePackageCmdlet.ApplicationResourceName"> <summary> Gets or sets ApplicationResourceName. The identity of the application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsMeshCodePackageCmdlet.ServiceResourceName"> <summary> Gets or sets ServiceResourceName. The identity of the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsMeshCodePackageCmdlet.ReplicaName"> <summary> Gets or sets ReplicaName. Service Fabric replica name. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsMeshCodePackageCmdlet.CodePackageName"> <summary> Gets or sets CodePackageName. The name of code package of the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsMeshCodePackageCmdlet.Tail"> <summary> Gets or sets Tail. Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsMeshCodePackageCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetContainerLogsMeshCodePackageCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetContainersEventListCmdlet"> <summary> Gets all Containers-related events. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainersEventListCmdlet.StartTimeUtc"> <summary> Gets or sets StartTimeUtc. The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainersEventListCmdlet.EndTimeUtc"> <summary> Gets or sets EndTimeUtc. The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainersEventListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainersEventListCmdlet.EventsTypesFilter"> <summary> Gets or sets EventsTypesFilter. This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainersEventListCmdlet.ExcludeAnalysisEvents"> <summary> Gets or sets ExcludeAnalysisEvents. This param disables the retrieval of AnalysisEvents if true is passed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetContainersEventListCmdlet.SkipCorrelationLookup"> <summary> Gets or sets SkipCorrelationLookup. This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetContainersEventListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetCorrelatedEventListCmdlet"> <summary> Gets all correlated events for a given event. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetCorrelatedEventListCmdlet.EventInstanceId"> <summary> Gets or sets EventInstanceId. The EventInstanceId. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetCorrelatedEventListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetCorrelatedEventListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDataLossProgressCmdlet"> <summary> Gets the progress of a partition data loss operation started using the StartDataLoss API. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDataLossProgressCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDataLossProgressCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDataLossProgressCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDataLossProgressCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDataLossProgressCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDataLossProgressCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationCmdlet"> <summary> Gets the list of applications deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationCmdlet.IncludeHealthState"> <summary> Gets or sets IncludeHealthState. Include the health state of an entity. If this parameter is false or not specified, then the health state returned is "Unknown". When set to true, the query goes in parallel to the node and the health system service before the results are merged. As a result, the query is more expensive and may take a longer time. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet"> <summary> Gets the information about health of an application deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet.DeployedServicePackagesHealthStateFilter"> <summary> Gets or sets DeployedServicePackagesHealthStateFilter. Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator. For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet"> <summary> Gets the information about health of an application deployed on a Service Fabric node. using the specified policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.DeployedServicePackagesHealthStateFilter"> <summary> Gets or sets DeployedServicePackagesHealthStateFilter. Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator. For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedApplicationHealthUsingPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedCodePackageInfoListCmdlet"> <summary> Gets the list of code packages deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedCodePackageInfoListCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedCodePackageInfoListCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedCodePackageInfoListCmdlet.ServiceManifestName"> <summary> Gets or sets ServiceManifestName. The name of a service manifest registered as part of an application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedCodePackageInfoListCmdlet.CodePackageName"> <summary> Gets or sets CodePackageName. The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedCodePackageInfoListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedCodePackageInfoListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageCmdlet"> <summary> Gets the list of service packages deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageCmdlet.ServicePackageName"> <summary> Gets or sets ServicePackageName. The name of the service package. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthCmdlet"> <summary> Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthCmdlet.ServicePackageName"> <summary> Gets or sets ServicePackageName. The name of the service package. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet"> <summary> Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.ServicePackageName"> <summary> Gets or sets ServicePackageName. The name of the service package. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServicePackageHealthUsingPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaDetailCmdlet"> <summary> Gets the details of replica deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaDetailCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaDetailCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaDetailCmdlet.ReplicaId"> <summary> Gets or sets ReplicaId. The identifier of the replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaDetailCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaDetailCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaDetailCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaInfoListCmdlet"> <summary> Gets the list of replicas deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaInfoListCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaInfoListCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaInfoListCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaInfoListCmdlet.ServiceManifestName"> <summary> Gets or sets ServiceManifestName. The name of a service manifest registered as part of an application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaInfoListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceReplicaInfoListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceTypeCmdlet"> <summary> Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceTypeCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceTypeCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceTypeCmdlet.ServiceTypeName"> <summary> Gets or sets ServiceTypeName. Specifies the name of a Service Fabric service type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceTypeCmdlet.ServiceManifestName"> <summary> Gets or sets ServiceManifestName. The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceTypeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetDeployedServiceTypeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetFaultOperationListCmdlet"> <summary> Gets a list of user-induced fault operations filtered by provided input. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetFaultOperationListCmdlet.TypeFilter"> <summary> Gets or sets TypeFilter. Used to filter on OperationType for user-induced operations. - 65535 - select all - 1 - select PartitionDataLoss. - 2 - select PartitionQuorumLoss. - 4 - select PartitionRestart. - 8 - select NodeTransition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetFaultOperationListCmdlet.StateFilter"> <summary> Gets or sets StateFilter. Used to filter on OperationState's for user-induced operations. - 65535 - select All - 1 - select Running - 2 - select RollingBack - 8 - select Completed - 16 - select Faulted - 32 - select Cancelled - 64 - select ForceCancelled </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetFaultOperationListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetFaultOperationListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreContentCmdlet"> <summary> Gets the image store content information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreContentCmdlet.ContentPath"> <summary> Gets or sets ContentPath. Relative path to file or folder in the image store from its root. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreContentCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreContentCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreContentCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreFolderSizeCmdlet"> <summary> Get the size of a folder in image store </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreFolderSizeCmdlet.ContentPath"> <summary> Gets or sets ContentPath. Relative path to file or folder in the image store from its root. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreFolderSizeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreFolderSizeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreFolderSizeCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreInfoCmdlet"> <summary> Gets the overall ImageStore information </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreRootContentCmdlet"> <summary> Gets the content information at the root of the image store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreRootContentCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreRootContentCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreRootContentCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreRootFolderSizeCmdlet"> <summary> Get the folder size at the root of the image store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreRootFolderSizeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreRootFolderSizeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreRootFolderSizeCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByIdCmdlet"> <summary> Get the image store upload session by ID. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByIdCmdlet.SessionId"> <summary> Gets or sets SessionId. A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByIdCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByIdCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByIdCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByPathCmdlet"> <summary> Get the image store upload session by relative path. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByPathCmdlet.ContentPath"> <summary> Gets or sets ContentPath. Relative path to file or folder in the image store from its root. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByPathCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByPathCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetImageStoreUploadSessionByPathCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetLoadedPartitionInfoListCmdlet"> <summary> Gets ordered list of partitions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetLoadedPartitionInfoListCmdlet.MetricName"> <summary> Gets or sets MetricName. Name of the metric based on which to get ordered list of partitions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetLoadedPartitionInfoListCmdlet.ServiceName"> <summary> Gets or sets ServiceName. The name of a service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetLoadedPartitionInfoListCmdlet.Ordering"> <summary> Gets or sets Ordering. Ordering of partitions' load. Possible values include: 'Desc', 'Asc' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetLoadedPartitionInfoListCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetLoadedPartitionInfoListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetLoadedPartitionInfoListCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetMeshApplicationCmdlet"> <summary> Lists all the application resources. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshApplicationCmdlet.ApplicationResourceName"> <summary> Gets or sets ApplicationResourceName. The identity of the application. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshApplicationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshApplicationCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetMeshGatewayCmdlet"> <summary> Lists all the gateway resources. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshGatewayCmdlet.GatewayResourceName"> <summary> Gets or sets GatewayResourceName. The identity of the gateway. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshGatewayCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshGatewayCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetMeshNetworkCmdlet"> <summary> Lists all the network resources. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshNetworkCmdlet.NetworkResourceName"> <summary> Gets or sets NetworkResourceName. The identity of the network. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshNetworkCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshNetworkCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetMeshSecretCmdlet"> <summary> Lists all the secret resources. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshSecretCmdlet.SecretResourceName"> <summary> Gets or sets SecretResourceName. The name of the secret resource. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshSecretCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshSecretCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetMeshSecretValueCmdlet"> <summary> List names of all values of the specified secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshSecretValueCmdlet.SecretResourceName"> <summary> Gets or sets SecretResourceName. The name of the secret resource. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshSecretValueCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshSecretValueCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceCmdlet"> <summary> Lists all the service resources. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceCmdlet.ApplicationResourceName"> <summary> Gets or sets ApplicationResourceName. The identity of the application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceCmdlet.ServiceResourceName"> <summary> Gets or sets ServiceResourceName. The identity of the service. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceReplicaCmdlet"> <summary> Lists all the replicas of a service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceReplicaCmdlet.ApplicationResourceName"> <summary> Gets or sets ApplicationResourceName. The identity of the application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceReplicaCmdlet.ServiceResourceName"> <summary> Gets or sets ServiceResourceName. The identity of the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceReplicaCmdlet.ReplicaName"> <summary> Gets or sets ReplicaName. Service Fabric replica name. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceReplicaCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshServiceReplicaCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetMeshVolumeCmdlet"> <summary> Lists all the volume resources. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetMeshVolumeCmdlet.VolumeResourceName"> <summary> Gets or sets VolumeResourceName. The identity of the volume. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshVolumeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetMeshVolumeCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetNameExistsInfoCmdlet"> <summary> Returns whether the Service Fabric name exists. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNameExistsInfoCmdlet.NameId"> <summary> Gets or sets NameId. The Service Fabric name, without the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNameExistsInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNameExistsInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetNodeCmdlet"> <summary> Gets the list of nodes in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeCmdlet.NodeStatusFilter"> <summary> Gets or sets NodeStatusFilter. Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following. Possible values include: 'default', 'all', 'up', 'down', 'enabling', 'disabling', 'disabled', 'unknown', 'removed' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthCmdlet"> <summary> Gets the health of a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet"> <summary> Gets the health of a Service Fabric node, by using the specified health policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.MaxPercentUnhealthyNodes"> <summary> Gets or sets MaxPercentUnhealthyNodes. The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.MaxPercentUnhealthyApplications"> <summary> Gets or sets MaxPercentUnhealthyApplications. The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.ApplicationTypeHealthPolicyMap"> <summary> Gets or sets ApplicationTypeHealthPolicyMap. Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.NodeTypeHealthPolicyMap"> <summary> Gets or sets NodeTypeHealthPolicyMap. Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type. The node type health policy map can be used during cluster health evaluation to describe special node types. They are evaluated against the percentages associated with their node type name in the map. Setting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. The node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation. For example, given a cluster with many nodes of different types, with important work hosted on node type "SpecialNodeType" that should not tolerate any nodes down. You can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type "SpecialNodeType", set the MaxPercentUnhealthyNodes to 0 by setting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. This way, as long as no nodes of type "SpecialNodeType" are in Error state, even if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. A Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. But even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. Conversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, with one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeHealthUsingPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetNodeLoadInfoCmdlet"> <summary> Gets the load information of a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeLoadInfoCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeLoadInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeLoadInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeLoadInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet"> <summary> Gets all Nodes-related Events. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet.StartTimeUtc"> <summary> Gets or sets StartTimeUtc. The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet.EndTimeUtc"> <summary> Gets or sets EndTimeUtc. The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet.EventsTypesFilter"> <summary> Gets or sets EventsTypesFilter. This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet.ExcludeAnalysisEvents"> <summary> Gets or sets ExcludeAnalysisEvents. This param disables the retrieval of AnalysisEvents if true is passed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet.SkipCorrelationLookup"> <summary> Gets or sets SkipCorrelationLookup. This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodesEventCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetNodeTransitionProgressCmdlet"> <summary> Gets the progress of an operation started using StartNodeTransition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeTransitionProgressCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeTransitionProgressCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetNodeTransitionProgressCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeTransitionProgressCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetNodeTransitionProgressCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupConfigurationInfoCmdlet"> <summary> Gets the partition backup configuration information </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupConfigurationInfoCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupConfigurationInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupConfigurationInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupConfigurationInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupListCmdlet"> <summary> Gets the list of backups available for the specified partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupListCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupListCmdlet.Latest"> <summary> Gets or sets Latest. Specifies whether to get only the most recent backup available for a partition for the specified time range. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupListCmdlet.StartDateTimeFilter"> <summary> Gets or sets StartDateTimeFilter. Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupListCmdlet.EndDateTimeFilter"> <summary> Gets or sets EndDateTimeFilter. Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupListCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupProgressCmdlet"> <summary> Gets details for the latest backup triggered for this partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupProgressCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupProgressCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupProgressCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionBackupProgressCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionCmdlet"> <summary> Gets the list of partitions of a Service Fabric service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthCmdlet"> <summary> Gets the health of the specified Service Fabric partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthCmdlet.ReplicasHealthStateFilter"> <summary> Gets or sets ReplicasHealthStateFilter. Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet"> <summary> Gets the health of the specified Service Fabric partition, by using the specified health policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.ReplicasHealthStateFilter"> <summary> Gets or sets ReplicasHealthStateFilter. Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionHealthUsingPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionLoadInformationCmdlet"> <summary> Gets the load information of the specified Service Fabric partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionLoadInformationCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionLoadInformationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionLoadInformationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionLoadInformationCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet"> <summary> Gets all Replicas-related events for a Partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.StartTimeUtc"> <summary> Gets or sets StartTimeUtc. The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.EndTimeUtc"> <summary> Gets or sets EndTimeUtc. The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.ReplicaId"> <summary> Gets or sets ReplicaId. The identifier of the replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.EventsTypesFilter"> <summary> Gets or sets EventsTypesFilter. This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.ExcludeAnalysisEvents"> <summary> Gets or sets ExcludeAnalysisEvents. This param disables the retrieval of AnalysisEvents if true is passed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.SkipCorrelationLookup"> <summary> Gets or sets SkipCorrelationLookup. This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionReplicasEventCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestartProgressCmdlet"> <summary> Gets the progress of a PartitionRestart operation started using StartPartitionRestart. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestartProgressCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestartProgressCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestartProgressCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestartProgressCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestartProgressCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestartProgressCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestoreProgressCmdlet"> <summary> Gets details for the latest restore operation triggered for this partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestoreProgressCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestoreProgressCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestoreProgressCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionRestoreProgressCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet"> <summary> Gets all Partitions-related events. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet.StartTimeUtc"> <summary> Gets or sets StartTimeUtc. The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet.EndTimeUtc"> <summary> Gets or sets EndTimeUtc. The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet.EventsTypesFilter"> <summary> Gets or sets EventsTypesFilter. This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet.ExcludeAnalysisEvents"> <summary> Gets or sets ExcludeAnalysisEvents. This param disables the retrieval of AnalysisEvents if true is passed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet.SkipCorrelationLookup"> <summary> Gets or sets SkipCorrelationLookup. This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPartitionsEventCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoCmdlet"> <summary> Gets the specified Service Fabric property. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoCmdlet.NameId"> <summary> Gets or sets NameId. The Service Fabric name, without the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoCmdlet.PropertyName"> <summary> Gets or sets PropertyName. Specifies the name of the property to get. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoListCmdlet"> <summary> Gets information on all Service Fabric properties under a given name. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoListCmdlet.NameId"> <summary> Gets or sets NameId. The Service Fabric name, without the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoListCmdlet.IncludeValues"> <summary> Gets or sets IncludeValues. Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetPropertyInfoListCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetProvisionedFabricCodeVersionInfoListCmdlet"> <summary> Gets a list of fabric code versions that are provisioned in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetProvisionedFabricCodeVersionInfoListCmdlet.CodeVersion"> <summary> Gets or sets CodeVersion. The product version of Service Fabric. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetProvisionedFabricCodeVersionInfoListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetProvisionedFabricCodeVersionInfoListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetProvisionedFabricConfigVersionInfoListCmdlet"> <summary> Gets a list of fabric config versions that are provisioned in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetProvisionedFabricConfigVersionInfoListCmdlet.ConfigVersion"> <summary> Gets or sets ConfigVersion. The config version of Service Fabric. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetProvisionedFabricConfigVersionInfoListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetProvisionedFabricConfigVersionInfoListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetQuorumLossProgressCmdlet"> <summary> Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetQuorumLossProgressCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetQuorumLossProgressCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetQuorumLossProgressCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetQuorumLossProgressCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetQuorumLossProgressCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetQuorumLossProgressCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetRepairTaskListCmdlet"> <summary> Gets a list of repair tasks matching the given filters. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetRepairTaskListCmdlet.TaskIdFilter"> <summary> Gets or sets TaskIdFilter. The repair task ID prefix to be matched. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetRepairTaskListCmdlet.StateFilter"> <summary> Gets or sets StateFilter. A bitwise-OR of the following values, specifying which task states should be included in the result list. - 1 - Created - 2 - Claimed - 4 - Preparing - 8 - Approved - 16 - Executing - 32 - Restoring - 64 - Completed </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetRepairTaskListCmdlet.ExecutorFilter"> <summary> Gets or sets ExecutorFilter. The name of the repair executor whose claimed tasks should be included in the list. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetRepairTaskListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetReplicaCmdlet"> <summary> Gets the information about replicas of a Service Fabric service partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaCmdlet.ReplicaId"> <summary> Gets or sets ReplicaId. The identifier of the replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetReplicaCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetReplicaCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthCmdlet"> <summary> Gets the health of a Service Fabric stateful service replica or stateless service instance. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthCmdlet.ReplicaId"> <summary> Gets or sets ReplicaId. The identifier of the replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet"> <summary> Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.ReplicaId"> <summary> Gets or sets ReplicaId. The identifier of the replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetReplicaHealthUsingPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupConfigurationInfoCmdlet"> <summary> Gets the Service Fabric service backup configuration information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupConfigurationInfoCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupConfigurationInfoCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupConfigurationInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupConfigurationInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupConfigurationInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet"> <summary> Gets the list of backups available for every partition in this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet.Latest"> <summary> Gets or sets Latest. Specifies whether to get only the most recent backup available for a partition for the specified time range. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet.StartDateTimeFilter"> <summary> Gets or sets StartDateTimeFilter. Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet.EndDateTimeFilter"> <summary> Gets or sets EndDateTimeFilter. Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceBackupListCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceCmdlet"> <summary> Gets the information about all services belonging to the application specified by the application ID. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceCmdlet.ServiceTypeName"> <summary> Gets or sets ServiceTypeName. The service type name used to filter the services to query for. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceDescriptionCmdlet"> <summary> Gets the description of an existing Service Fabric service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceDescriptionCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceDescriptionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceDescriptionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceDescriptionCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthCmdlet"> <summary> Gets the health of the specified Service Fabric service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthCmdlet.PartitionsHealthStateFilter"> <summary> Gets or sets PartitionsHealthStateFilter. Allows filtering of the partitions health state objects returned in the result of service health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet"> <summary> Gets the health of the specified Service Fabric service, by using the specified health policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.EventsHealthStateFilter"> <summary> Gets or sets EventsHealthStateFilter. Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.PartitionsHealthStateFilter"> <summary> Gets or sets PartitionsHealthStateFilter. Allows filtering of the partitions health state objects returned in the result of service health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.ExcludeHealthStatistics"> <summary> Gets or sets ExcludeHealthStatistics. Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceHealthUsingPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceManifestCmdlet"> <summary> Gets the manifest describing a service type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceManifestCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The name of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceManifestCmdlet.ApplicationTypeVersion"> <summary> Gets or sets ApplicationTypeVersion. The version of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceManifestCmdlet.ServiceManifestName"> <summary> Gets or sets ServiceManifestName. The name of a service manifest registered as part of an application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceManifestCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceManifestCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceManifestCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceNameInfoCmdlet"> <summary> Gets the name of the Service Fabric service for a partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceNameInfoCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceNameInfoCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceNameInfoCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceNameInfoCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet"> <summary> Gets all Services-related events. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet.StartTimeUtc"> <summary> Gets or sets StartTimeUtc. The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet.EndTimeUtc"> <summary> Gets or sets EndTimeUtc. The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet.EventsTypesFilter"> <summary> Gets or sets EventsTypesFilter. This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet.ExcludeAnalysisEvents"> <summary> Gets or sets ExcludeAnalysisEvents. This param disables the retrieval of AnalysisEvents if true is passed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet.SkipCorrelationLookup"> <summary> Gets or sets SkipCorrelationLookup. This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServicesEventCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetServiceTypeCmdlet"> <summary> Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceTypeCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The name of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceTypeCmdlet.ApplicationTypeVersion"> <summary> Gets or sets ApplicationTypeVersion. The version of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceTypeCmdlet.ServiceTypeName"> <summary> Gets or sets ServiceTypeName. Specifies the name of a Service Fabric service type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetServiceTypeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetServiceTypeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetSubNameInfoListCmdlet"> <summary> Enumerates all the Service Fabric names under a given name. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetSubNameInfoListCmdlet.NameId"> <summary> Gets or sets NameId. The Service Fabric name, without the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetSubNameInfoListCmdlet.Recursive"> <summary> Gets or sets Recursive. Allows specifying that the search performed should be recursive. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetSubNameInfoListCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetSubNameInfoListCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetUnplacedReplicaInformationCmdlet"> <summary> Gets the information about unplaced replica of the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetUnplacedReplicaInformationCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetUnplacedReplicaInformationCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetUnplacedReplicaInformationCmdlet.OnlyQueryPrimaries"> <summary> Gets or sets OnlyQueryPrimaries. Indicates that unplaced replica information will be queries only for primary replicas. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetUnplacedReplicaInformationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetUnplacedReplicaInformationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetUnplacedReplicaInformationCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetUpgradeOrchestrationServiceStateCmdlet"> <summary> Get the service state of Service Fabric Upgrade Orchestration Service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetUpgradeOrchestrationServiceStateCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetUpgradeOrchestrationServiceStateCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetUpgradeOrchestrationServiceStateCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.GetUpgradeProgressMeshApplicationCmdlet"> <summary> Gets the progress of the latest upgrade performed on this application resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.GetUpgradeProgressMeshApplicationCmdlet.ApplicationResourceName"> <summary> Gets or sets ApplicationResourceName. The identity of the application. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetUpgradeProgressMeshApplicationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.GetUpgradeProgressMeshApplicationCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.MoveAuxiliaryReplicaCmdlet"> <summary> Moves the auxiliary replica of a partition of a stateful service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveAuxiliaryReplicaCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveAuxiliaryReplicaCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveAuxiliaryReplicaCmdlet.CurrentNodeName"> <summary> Gets or sets CurrentNodeName. The name of the source node for instance move. If not specified, instance is moved from a random node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveAuxiliaryReplicaCmdlet.NewNodeName"> <summary> Gets or sets NewNodeName. The name of the target node for secondary replica or instance move. If not specified, replica or instance is moved to a random node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveAuxiliaryReplicaCmdlet.IgnoreConstraints"> <summary> Gets or sets IgnoreConstraints. Ignore constraints when moving a replica or instance. If this parameter is not specified, all constraints are honored. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveAuxiliaryReplicaCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.MoveAuxiliaryReplicaCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.MoveInstanceCmdlet"> <summary> Moves the instance of a partition of a stateless service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveInstanceCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveInstanceCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveInstanceCmdlet.CurrentNodeName"> <summary> Gets or sets CurrentNodeName. The name of the source node for instance move. If not specified, instance is moved from a random node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveInstanceCmdlet.NewNodeName"> <summary> Gets or sets NewNodeName. The name of the target node for secondary replica or instance move. If not specified, replica or instance is moved to a random node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveInstanceCmdlet.IgnoreConstraints"> <summary> Gets or sets IgnoreConstraints. Ignore constraints when moving a replica or instance. If this parameter is not specified, all constraints are honored. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveInstanceCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.MoveInstanceCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.MovePrimaryReplicaCmdlet"> <summary> Moves the primary replica of a partition of a stateful service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MovePrimaryReplicaCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MovePrimaryReplicaCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MovePrimaryReplicaCmdlet.IgnoreConstraints"> <summary> Gets or sets IgnoreConstraints. Ignore constraints when moving a replica or instance. If this parameter is not specified, all constraints are honored. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MovePrimaryReplicaCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.MovePrimaryReplicaCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.MoveSecondaryReplicaCmdlet"> <summary> Moves the secondary replica of a partition of a stateful service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveSecondaryReplicaCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveSecondaryReplicaCmdlet.CurrentNodeName"> <summary> Gets or sets CurrentNodeName. The name of the source node for secondary replica move. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveSecondaryReplicaCmdlet.NewNodeName"> <summary> Gets or sets NewNodeName. The name of the target node for secondary replica or instance move. If not specified, replica or instance is moved to a random node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveSecondaryReplicaCmdlet.IgnoreConstraints"> <summary> Gets or sets IgnoreConstraints. Ignore constraints when moving a replica or instance. If this parameter is not specified, all constraints are honored. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.MoveSecondaryReplicaCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.MoveSecondaryReplicaCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet"> <summary> Creates a Service Fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.Name"> <summary> Gets or sets Name. The name of the application, including the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.TypeName"> <summary> Gets or sets TypeName. The application type name as defined in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.TypeVersion"> <summary> Gets or sets TypeVersion. The version of the application type as defined in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.Parameters"> <summary> Gets or sets Parameters. List of application parameters with overridden values from their default values specified in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.MinimumNodes"> <summary> Gets or sets MinimumNodes. The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.MaximumNodes"> <summary> Gets or sets MaximumNodes. The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.ApplicationMetrics"> <summary> Gets or sets ApplicationMetrics. List of application capacity metric description. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.TokenServiceEndpoint"> <summary> Gets or sets TokenServiceEndpoint. Token service endpoint. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.ManagedIdentities"> <summary> Gets or sets ManagedIdentities. A list of managed application identity objects. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewApplicationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet"> <summary> Sends a health report on the Service Fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.SourceId"> <summary> Gets or sets SourceId. The source name that identifies the client/watchdog/system component that generated the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.Property"> <summary> Gets or sets Property. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.HealthState"> <summary> Gets or sets HealthState. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.TimeToLiveInMilliSeconds"> <summary> Gets or sets TimeToLiveInMilliSeconds. The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.Description"> <summary> Gets or sets Description. The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.SequenceNumber"> <summary> Gets or sets SequenceNumber. The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.RemoveWhenExpired"> <summary> Gets or sets RemoveWhenExpired. Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.HealthReportId"> <summary> Gets or sets HealthReportId. A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.Immediate"> <summary> Gets or sets Immediate. A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewApplicationHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewApplicationUpgradeCmdlet"> <summary> Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationUpgradeCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApplicationUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewApplicationUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewApproveRepairTaskCmdlet"> <summary> Forces the approval of the given repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApproveRepairTaskCmdlet.TaskId"> <summary> Gets or sets TaskId. The ID of the repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewApproveRepairTaskCmdlet.Version"> <summary> Gets or sets Version. The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewApproveRepairTaskCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewApproveRepairTaskCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet"> <summary> Creates a backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.FrequencyBased"> <summary> Gets or sets FrequencyBased flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.TimeBased"> <summary> Gets or sets TimeBased flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.AzureBlobStore"> <summary> Gets or sets AzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.FileShare"> <summary> Gets or sets FileShare flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.DsmsAzureBlobStore"> <summary> Gets or sets DsmsAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ManagedIdentityAzureBlobStore"> <summary> Gets or sets ManagedIdentityAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.Basic"> <summary> Gets or sets Basic flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.Name"> <summary> Gets or sets Name. The unique name identifying this backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.AutoRestoreOnDataLoss"> <summary> Gets or sets AutoRestoreOnDataLoss. Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.MaxIncrementalBackups"> <summary> Gets or sets MaxIncrementalBackups. Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions - The replica has never taken a full backup since it has become primary, - Some of the log records since the last backup has been truncated, or - Replica passed the MaxAccumulatedBackupLogSizeInMB limit. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.Interval"> <summary> Gets or sets Interval. Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ScheduleFrequencyType"> <summary> Gets or sets ScheduleFrequencyType. Describes the frequency with which to run the time based backup schedule. . Possible values include: 'Invalid', 'Daily', 'Weekly' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.RunTimes"> <summary> Gets or sets RunTimes. Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ConnectionString"> <summary> Gets or sets ConnectionString. The connection string to connect to the Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ContainerName"> <summary> Gets or sets ContainerName. The name of the container in the blob store to store and enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.Path"> <summary> Gets or sets Path. UNC path of the file share where to store or enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.StorageCredentialsSourceLocation"> <summary> Gets or sets StorageCredentialsSourceLocation. The source location of the storage credentials to connect to the Dsms Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ManagedIdentityType"> <summary> Gets or sets ManagedIdentityType. The type of managed identity to be used to connect to Azure Blob Store via Managed Identity. . Possible values include: 'Invalid', 'VMSS', 'Cluster' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.BlobServiceUri"> <summary> Gets or sets BlobServiceUri. The Blob Service Uri to connect to the Azure blob store.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.RetentionDuration"> <summary> Gets or sets RetentionDuration. It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.RunDays"> <summary> Gets or sets RunDays. List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.FriendlyName"> <summary> Gets or sets FriendlyName. Friendly name for this backup storage. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.PrimaryUserName"> <summary> Gets or sets PrimaryUserName. Primary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.PrimaryPassword"> <summary> Gets or sets PrimaryPassword. Primary password to access the share location. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.SecondaryUserName"> <summary> Gets or sets SecondaryUserName. Secondary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.SecondaryPassword"> <summary> Gets or sets SecondaryPassword. Secondary password to access the share location </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ManagedIdentityClientId"> <summary> Gets or sets ManagedIdentityClientId. The ClientId of User-Assigned Managed Identity </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.MinimumNumberOfBackups"> <summary> Gets or sets MinimumNumberOfBackups. It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ValidateConnection"> <summary> Gets or sets ValidateConnection. Specifies whether to validate the storage connection and credentials before creating or updating the backup policies. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewBackupPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewChaosScheduleCmdlet"> <summary> Set the schedule used by Chaos. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewChaosScheduleCmdlet.Version"> <summary> Gets or sets Version. The version number of the Schedule. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewChaosScheduleCmdlet.StartDate"> <summary> Gets or sets StartDate. The date and time Chaos will start using this schedule. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewChaosScheduleCmdlet.ExpiryDate"> <summary> Gets or sets ExpiryDate. The date and time Chaos will continue to use this schedule until. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewChaosScheduleCmdlet.ChaosParametersDictionary"> <summary> Gets or sets ChaosParametersDictionary. A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewChaosScheduleCmdlet.Jobs"> <summary> Gets or sets Jobs. A list of all Chaos Schedule Jobs that will be automated by the schedule. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewChaosScheduleCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewChaosScheduleCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet"> <summary> Sends a health report on the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.SourceId"> <summary> Gets or sets SourceId. The source name that identifies the client/watchdog/system component that generated the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.Property"> <summary> Gets or sets Property. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.HealthState"> <summary> Gets or sets HealthState. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.TimeToLiveInMilliSeconds"> <summary> Gets or sets TimeToLiveInMilliSeconds. The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.Description"> <summary> Gets or sets Description. The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.SequenceNumber"> <summary> Gets or sets SequenceNumber. The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.RemoveWhenExpired"> <summary> Gets or sets RemoveWhenExpired. Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.HealthReportId"> <summary> Gets or sets HealthReportId. A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.Immediate"> <summary> Gets or sets Immediate. A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewClusterHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewClusterUpgradeCmdlet"> <summary> Roll back the upgrade of a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewClusterUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewClusterUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewComposeDeploymentCmdlet"> <summary> Creates a Service Fabric compose deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewComposeDeploymentCmdlet.DeploymentName"> <summary> Gets or sets DeploymentName. The name of the deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewComposeDeploymentCmdlet.ComposeFileContent"> <summary> Gets or sets ComposeFileContent. The content of the compose file that describes the deployment to create. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewComposeDeploymentCmdlet.RegistryUserName"> <summary> Gets or sets RegistryUserName. The user name to connect to container registry. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewComposeDeploymentCmdlet.RegistryPassword"> <summary> Gets or sets RegistryPassword. The password for supplied username to connect to container registry. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewComposeDeploymentCmdlet.PasswordEncrypted"> <summary> Gets or sets PasswordEncrypted. Indicates that supplied container registry password is encrypted. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewComposeDeploymentCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewComposeDeploymentCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet"> <summary> Invoke container API on a container deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.ServiceManifestName"> <summary> Gets or sets ServiceManifestName. The name of a service manifest registered as part of an application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.CodePackageName"> <summary> Gets or sets CodePackageName. The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.CodePackageInstanceId"> <summary> Gets or sets CodePackageInstanceId. ID that uniquely identifies a code package instance deployed on a service fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.UriPath"> <summary> Gets or sets UriPath. URI path of container REST API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.HttpVerb"> <summary> Gets or sets HttpVerb. HTTP verb of container REST API, defaults to "GET" </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.ContentType"> <summary> Gets or sets ContentType. Content type of container REST API request, defaults to "application/json" </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.Body"> <summary> Gets or sets Body. HTTP request body of container REST API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewContainerApiCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet"> <summary> Sends a health report on the Service Fabric application deployed on a Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.SourceId"> <summary> Gets or sets SourceId. The source name that identifies the client/watchdog/system component that generated the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.Property"> <summary> Gets or sets Property. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.HealthState"> <summary> Gets or sets HealthState. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.TimeToLiveInMilliSeconds"> <summary> Gets or sets TimeToLiveInMilliSeconds. The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.Description"> <summary> Gets or sets Description. The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.SequenceNumber"> <summary> Gets or sets SequenceNumber. The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.RemoveWhenExpired"> <summary> Gets or sets RemoveWhenExpired. Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.HealthReportId"> <summary> Gets or sets HealthReportId. A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.Immediate"> <summary> Gets or sets Immediate. A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewDeployedApplicationHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet"> <summary> Sends a health report on the Service Fabric deployed service package. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.ServicePackageName"> <summary> Gets or sets ServicePackageName. The name of the service package. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.SourceId"> <summary> Gets or sets SourceId. The source name that identifies the client/watchdog/system component that generated the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.Property"> <summary> Gets or sets Property. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.HealthState"> <summary> Gets or sets HealthState. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.TimeToLiveInMilliSeconds"> <summary> Gets or sets TimeToLiveInMilliSeconds. The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.Description"> <summary> Gets or sets Description. The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.SequenceNumber"> <summary> Gets or sets SequenceNumber. The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.RemoveWhenExpired"> <summary> Gets or sets RemoveWhenExpired. Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.HealthReportId"> <summary> Gets or sets HealthReportId. A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.Immediate"> <summary> Gets or sets Immediate. A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewDeployedServicePackageHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewImageStoreUploadSessionCmdlet"> <summary> Commit an image store upload session. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewImageStoreUploadSessionCmdlet.SessionId"> <summary> Gets or sets SessionId. A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewImageStoreUploadSessionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewImageStoreUploadSessionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureCommandCmdlet"> <summary> Invokes an administrative command on the given Infrastructure Service instance. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureCommandCmdlet.Command"> <summary> Gets or sets Command. The text of the command to be invoked. The content of the command is infrastructure-specific. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureCommandCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureCommandCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureCommandCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureQueryCmdlet"> <summary> Invokes a read-only query on the given infrastructure service instance. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureQueryCmdlet.Command"> <summary> Gets or sets Command. The text of the command to be invoked. The content of the command is infrastructure-specific. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureQueryCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureQueryCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewInfrastructureQueryCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewNameCmdlet"> <summary> Creates a Service Fabric name. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNameCmdlet.Name"> <summary> Gets or sets Name. The Service Fabric name, including the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNameCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewNameCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet"> <summary> Sends a health report on the Service Fabric node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.SourceId"> <summary> Gets or sets SourceId. The source name that identifies the client/watchdog/system component that generated the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.Property"> <summary> Gets or sets Property. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.HealthState"> <summary> Gets or sets HealthState. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.TimeToLiveInMilliSeconds"> <summary> Gets or sets TimeToLiveInMilliSeconds. The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.Description"> <summary> Gets or sets Description. The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.SequenceNumber"> <summary> Gets or sets SequenceNumber. The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.RemoveWhenExpired"> <summary> Gets or sets RemoveWhenExpired. Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.HealthReportId"> <summary> Gets or sets HealthReportId. A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.Immediate"> <summary> Gets or sets Immediate. A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewNodeHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet"> <summary> Sends a health report on the Service Fabric partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.SourceId"> <summary> Gets or sets SourceId. The source name that identifies the client/watchdog/system component that generated the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.Property"> <summary> Gets or sets Property. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.HealthState"> <summary> Gets or sets HealthState. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.TimeToLiveInMilliSeconds"> <summary> Gets or sets TimeToLiveInMilliSeconds. The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.Description"> <summary> Gets or sets Description. The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.SequenceNumber"> <summary> Gets or sets SequenceNumber. The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.RemoveWhenExpired"> <summary> Gets or sets RemoveWhenExpired. Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.HealthReportId"> <summary> Gets or sets HealthReportId. A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.Immediate"> <summary> Gets or sets Immediate. A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewPartitionHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet"> <summary> Creates a new repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.Node"> <summary> Gets or sets Node flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.TaskId"> <summary> Gets or sets TaskId. The ID of the repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.State"> <summary> Gets or sets State. The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.Action"> <summary> Gets or sets Action. The requested repair action. Must be specified when the repair task is created, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.Version"> <summary> Gets or sets Version. The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.Description"> <summary> Gets or sets Description. A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.Flags"> <summary> Gets or sets Flags. A bitwise-OR of the following values, which gives additional details about the status of the repair task. - 1 - Cancellation of the repair has been requested - 2 - Abort of the repair has been requested - 4 - Approval of the repair was forced via client request </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.NodeNames"> <summary> Gets or sets NodeNames. The list of nodes targeted by a repair action. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.Executor"> <summary> Gets or sets Executor. The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.ExecutorData"> <summary> Gets or sets ExecutorData. A data string that the repair executor can use to store its internal state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.NodeImpactList"> <summary> Gets or sets NodeImpactList. The list of nodes impacted by a repair action and their respective expected impact. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.ResultStatus"> <summary> Gets or sets ResultStatus. A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set. Possible values include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.ResultCode"> <summary> Gets or sets ResultCode. A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.ResultDetails"> <summary> Gets or sets ResultDetails. A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.CreatedUtcTimestamp"> <summary> Gets or sets CreatedUtcTimestamp. The time when the repair task entered the Created state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.ClaimedUtcTimestamp"> <summary> Gets or sets ClaimedUtcTimestamp. The time when the repair task entered the Claimed state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.PreparingUtcTimestamp"> <summary> Gets or sets PreparingUtcTimestamp. The time when the repair task entered the Preparing state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.ApprovedUtcTimestamp"> <summary> Gets or sets ApprovedUtcTimestamp. The time when the repair task entered the Approved state </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.ExecutingUtcTimestamp"> <summary> Gets or sets ExecutingUtcTimestamp. The time when the repair task entered the Executing state </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.RestoringUtcTimestamp"> <summary> Gets or sets RestoringUtcTimestamp. The time when the repair task entered the Restoring state </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.CompletedUtcTimestamp"> <summary> Gets or sets CompletedUtcTimestamp. The time when the repair task entered the Completed state </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.PreparingHealthCheckStartUtcTimestamp"> <summary> Gets or sets PreparingHealthCheckStartUtcTimestamp. The time when the repair task started the health check in the Preparing state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.PreparingHealthCheckEndUtcTimestamp"> <summary> Gets or sets PreparingHealthCheckEndUtcTimestamp. The time when the repair task completed the health check in the Preparing state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.RestoringHealthCheckStartUtcTimestamp"> <summary> Gets or sets RestoringHealthCheckStartUtcTimestamp. The time when the repair task started the health check in the Restoring state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.RestoringHealthCheckEndUtcTimestamp"> <summary> Gets or sets RestoringHealthCheckEndUtcTimestamp. The time when the repair task completed the health check in the Restoring state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.PreparingHealthCheckState"> <summary> Gets or sets PreparingHealthCheckState. The workflow state of the health check when the repair task is in the Preparing state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut' Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.RestoringHealthCheckState"> <summary> Gets or sets RestoringHealthCheckState. The workflow state of the health check when the repair task is in the Restoring state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut' Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.PerformPreparingHealthCheck"> <summary> Gets or sets PerformPreparingHealthCheck. A value to determine if health checks will be performed when the repair task enters the Preparing state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.PerformRestoringHealthCheck"> <summary> Gets or sets PerformRestoringHealthCheck. A value to determine if health checks will be performed when the repair task enters the Restoring state. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewRepairTaskCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet"> <summary> Sends a health report on the Service Fabric replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.ReplicaId"> <summary> Gets or sets ReplicaId. The identifier of the replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.ServiceKind"> <summary> Gets or sets ServiceKind. The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values. Possible values include: 'Stateless', 'Stateful' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.SourceId"> <summary> Gets or sets SourceId. The source name that identifies the client/watchdog/system component that generated the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.Property"> <summary> Gets or sets Property. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.HealthState"> <summary> Gets or sets HealthState. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.TimeToLiveInMilliSeconds"> <summary> Gets or sets TimeToLiveInMilliSeconds. The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.Description"> <summary> Gets or sets Description. The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.SequenceNumber"> <summary> Gets or sets SequenceNumber. The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.RemoveWhenExpired"> <summary> Gets or sets RemoveWhenExpired. Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.HealthReportId"> <summary> Gets or sets HealthReportId. A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.Immediate"> <summary> Gets or sets Immediate. A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewReplicaHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet"> <summary> Creates the specified Service Fabric service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.Named"> <summary> Gets or sets Named flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.Singleton"> <summary> Gets or sets Singleton flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.UniformInt64Range"> <summary> Gets or sets UniformInt64Range flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.Stateful"> <summary> Gets or sets Stateful flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.Stateless"> <summary> Gets or sets Stateless flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServiceName"> <summary> Gets or sets ServiceName. The full name of the service with 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServiceTypeName"> <summary> Gets or sets ServiceTypeName. Name of the service type as specified in the service manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.Count"> <summary> Gets or sets Count. The number of partitions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.Names"> <summary> Gets or sets Names. Array of size specified by the ‘Count’ parameter, for the names of the partitions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.LowKey"> <summary> Gets or sets LowKey. String indicating the lower bound of the partition key range that should be split between the partitions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.HighKey"> <summary> Gets or sets HighKey. String indicating the upper bound of the partition key range that should be split between the partitions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.TargetReplicaSetSize"> <summary> Gets or sets TargetReplicaSetSize. The target replica set size as a number. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.MinReplicaSetSize"> <summary> Gets or sets MinReplicaSetSize. The minimum replica set size as a number. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.HasPersistedState"> <summary> Gets or sets HasPersistedState. A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.InstanceCount"> <summary> Gets or sets InstanceCount. The instance count. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ApplicationName"> <summary> Gets or sets ApplicationName. The name of the application, including the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.InitializationData"> <summary> Gets or sets InitializationData. The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.PlacementConstraints"> <summary> Gets or sets PlacementConstraints. The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)". </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.CorrelationScheme"> <summary> Gets or sets CorrelationScheme. The correlation scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServiceLoadMetrics"> <summary> Gets or sets ServiceLoadMetrics. The service load metrics. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServicePlacementPolicies"> <summary> Gets or sets ServicePlacementPolicies. The service placement policies. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.DefaultMoveCost"> <summary> Gets or sets DefaultMoveCost. The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High', 'VeryHigh' Specifies the move cost for the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.IsDefaultMoveCostSpecified"> <summary> Gets or sets IsDefaultMoveCostSpecified. Indicates if the DefaultMoveCost property is specified. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServicePackageActivationMode"> <summary> Gets or sets ServicePackageActivationMode. The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess' The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServiceDnsName"> <summary> Gets or sets ServiceDnsName. The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ScalingPolicies"> <summary> Gets or sets ScalingPolicies. Scaling policies for this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.TagsRequiredToPlace"> <summary> Gets or sets TagsRequiredToPlace. Tags for placement of this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.TagsRequiredToRun"> <summary> Gets or sets TagsRequiredToRun. Tags for running of this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.Flags"> <summary> Gets or sets Flags. Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set. - None - Does not indicate any other properties are set. The value is zero. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4. - ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 8. - DropSourceReplicaOnMove - Indicates the DropSourceReplicaOnMove property is set. The value is 16. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ReplicaRestartWaitDurationSeconds"> <summary> Gets or sets ReplicaRestartWaitDurationSeconds. The duration, in seconds, between when a replica goes down and when a new replica is created. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.QuorumLossWaitDurationSeconds"> <summary> Gets or sets QuorumLossWaitDurationSeconds. The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.StandByReplicaKeepDurationSeconds"> <summary> Gets or sets StandByReplicaKeepDurationSeconds. Defines how long StandBy replicas should be maintained before being removed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServicePlacementTimeLimitSeconds"> <summary> Gets or sets ServicePlacementTimeLimitSeconds. The duration for which replicas can stay InBuild before reporting that build is stuck. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.DropSourceReplicaOnMove"> <summary> Gets or sets DropSourceReplicaOnMove. Indicates whether to drop source Secondary replica even if the target replica has not finished build. If desired behavior is to drop it as soon as possible the value of this property is true, if not it is false. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ReplicaLifecycleDescription"> <summary> Gets or sets ReplicaLifecycleDescription. Defines how replicas of this service will behave during ther lifecycle. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.AuxiliaryReplicaCount"> <summary> Gets or sets AuxiliaryReplicaCount. The auxiliary replica count as a number. To use Auxiliary replicas, the following must be true: AuxiliaryReplicaCount < (TargetReplicaSetSize+1)/2 and TargetReplicaSetSize >=3. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServiceSensitivityDescription"> <summary> Gets or sets ServiceSensitivityDescription. Defines default levels of replica sensitivity of this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.MinInstanceCount"> <summary> Gets or sets MinInstanceCount. MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.MinInstancePercentage"> <summary> Gets or sets MinInstancePercentage. MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.InstanceCloseDelayDurationSeconds"> <summary> Gets or sets InstanceCloseDelayDurationSeconds. Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade and disabling node. The endpoint exposed on this instance is removed prior to starting the delay, which prevents new connections to this instance. In addition, clients that have subscribed to service endpoint change events(https://docs.microsoft.com/dotnet/api/system.fabric.fabricclient.servicemanagementclient.registerservicenotificationfilterasync), can do the following upon receiving the endpoint removal notification: - Stop sending new requests to this instance. - Close existing connections after in-flight requests have completed. - Connect to a different instance of the service partition for future requests. Note, the default value of InstanceCloseDelayDuration is 0, which indicates that there won't be any delay or removal of the endpoint prior to closing the instance. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.InstanceLifecycleDescription"> <summary> Gets or sets InstanceLifecycleDescription. Defines how instances of this service will behave during their lifecycle. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.InstanceRestartWaitDurationSeconds"> <summary> Gets or sets InstanceRestartWaitDurationSeconds. When a stateless instance goes down, this timer starts. When it expires Service Fabric will create a new instance on any node in the cluster. This configuration is to reduce unnecessary creation of a new instance in situations where the instance going down is likely to recover in a short time. For example, during an upgrade. The default value is 0, which indicates that when stateless instance goes down, Service Fabric will immediately start building its replacement. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewServiceCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet"> <summary> Creates a Service Fabric service from the service template. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.ApplicationName"> <summary> Gets or sets ApplicationName. The name of the application, including the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.ServiceName"> <summary> Gets or sets ServiceName. The full name of the service with 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.ServiceTypeName"> <summary> Gets or sets ServiceTypeName. Name of the service type as specified in the service manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.InitializationData"> <summary> Gets or sets InitializationData. The initialization data for the newly created service instance. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.ServicePackageActivationMode"> <summary> Gets or sets ServicePackageActivationMode. The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess' The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.ServiceDnsName"> <summary> Gets or sets ServiceDnsName. The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewServiceFromTemplateCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet"> <summary> Sends a health report on the Service Fabric service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.SourceId"> <summary> Gets or sets SourceId. The source name that identifies the client/watchdog/system component that generated the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.Property"> <summary> Gets or sets Property. The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.HealthState"> <summary> Gets or sets HealthState. The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.TimeToLiveInMilliSeconds"> <summary> Gets or sets TimeToLiveInMilliSeconds. The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.Description"> <summary> Gets or sets Description. The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.SequenceNumber"> <summary> Gets or sets SequenceNumber. The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.RemoveWhenExpired"> <summary> Gets or sets RemoveWhenExpired. Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.HealthReportId"> <summary> Gets or sets HealthReportId. A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at aka.ms/sfhealthid </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.Immediate"> <summary> Gets or sets Immediate. A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewServiceHealthCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter"> <summary> Defines custom formatters for various types of objects on the console. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.FormatObject(System.Management.Automation.PSObject)"> <summary> Invokes the format object function of the object passed, for better interpretation </summary> <param name="psObject"> Result returned by the PS cmdlet </param> <returns> Returns the formatted output </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(System.Collections.Generic.IList{Microsoft.ServiceFabric.Common.ServiceHealthState})"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="serviceHealthState"> List of ServiceHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ServiceHealthState)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="serviceHealthState"> Object of type ServiceHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(System.Collections.Generic.IList{Microsoft.ServiceFabric.Common.DeployedApplicationHealthState})"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="deployedApplicationHealthState"> List of DeployedApplicationHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.DeployedApplicationHealthState)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="deployedApplicationHealthState"> Object of type DeployedApplicationHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ApplicationHealth)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="applicationHealth"> Object of type ApplicationHealth </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(System.Collections.Generic.IList{Microsoft.ServiceFabric.Common.ApplicationHealthState})"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="applicationHealthState"> List of ApplicationHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ApplicationHealthState)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="applicationHealthState"> Object of type ApplicationHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ApplicationInfo)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="applicationInfo"> Object of type Common.ApplicationInfo </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(System.Collections.Generic.IList{Microsoft.ServiceFabric.Common.ManagedKeyVaultReferenceParameter})"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="managedKeyVaultReferenceParameter"> List of ManagedKeyVaultReferenceParameter </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ManagedKeyVaultReferenceParameter)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="managedKeyVaultReferenceParameter"> Object of type ManagedKeyVaultReferenceParameter </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ApplicationTypeInfo)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="applicationTypeInfo"> Object of type ApplicationTypeInfo </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(System.Collections.Generic.IList{Microsoft.ServiceFabric.Common.NodeHealthState})"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="nodeHealthState"> List of NodeHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.NodeHealthState)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="nodeHealthState"> Object of type NodeHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ClusterHealth)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="clusterHealth"> Object of type ClusterHealth </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(System.Collections.Generic.IList{Microsoft.ServiceFabric.Common.HealthEvent})"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="healthEvent"> List of HealthEvent </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.HealthEvent)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="healthEvent"> Object of type HealthEvent </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.HealthStateCount)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="healthStateCount"> Object of type HealthStateCount </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(System.Collections.Generic.IList{Microsoft.ServiceFabric.Common.EntityKindHealthStateCount})"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="entityKindHealthStateCount"> List of EntityKindHealthStateCount </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.EntityKindHealthStateCount)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="entityKindHealthStateCount"> Object of type EntityKindHealthStateCount </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.HealthStatistics)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="healthStatistics"> Object of type HealthStatistics </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.PartitionInformation)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="partitionInformation"> Object of type PartitionInformation </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ServicePartitionInfo)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="servicePartitionInfo"> Object of type ServicePartitionInfo </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ServiceInfo)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="serviceInfo"> Object of type ServiceInfo </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.PartitionHealth)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="partitionHealth"> Object of type PartitionHealth </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(System.Collections.Generic.IList{Microsoft.ServiceFabric.Common.PartitionHealthState})"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="partitionHealthState"> List of PartitionHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.PartitionHealthState)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="partitionHealthState"> Object of type PartitionHealthState </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ServiceHealth)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="serviceHealth"> Object of type ServiceHealth </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ServiceNameInfo)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="serviceNameInfo"> Object of type ServiceNameInfo </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.SecretResourceDescription)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="secretResourceDescription"> Object of type SecretResourceDescription </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.VolumeResourceDescription)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="volumeResourceDescription"> Object of type VolumeResourceDescription </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.NetworkResourceDescription)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="networkResourceDescription"> Object of type NetworkResourceDescription </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.GatewayResourceDescription)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="gatewayResourceDescription"> Object of type GatewayResourceDescription </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ServiceResourceDescription)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="serviceResourceDescription"> Object of type ServiceResourceDescription </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ServiceReplicaDescription)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="serviceReplicaDescription"> Object of type ServiceReplicaDescription </param> <returns> Returns formatted string. </returns> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.OutputFormatter.ToString(Microsoft.ServiceFabric.Common.ApplicationResourceDescription)"> <summary> Overloaded ToString function for formatting the output on the console. </summary> <param name="applicationResourceDescription"> Object of type ApplicationResourceDescription </param> <returns> Returns formatted string. </returns> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet"> <summary> Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ImageStorePath"> <summary> Gets or sets ImageStorePath flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ExternalStore"> <summary> Gets or sets ExternalStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ApplicationTypeBuildPath"> <summary> Gets or sets ApplicationTypeBuildPath. The relative path for the application package in the image store specified during the prior upload operation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ApplicationPackageDownloadUri"> <summary> Gets or sets ApplicationPackageDownloadUri. The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The application type name represents the name of the application type found in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ApplicationTypeVersion"> <summary> Gets or sets ApplicationTypeVersion. The application type version represents the version of the application type found in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.Async"> <summary> Gets or sets Async. Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ApplicationPackageCleanupPolicy"> <summary> Gets or sets ApplicationPackageCleanupPolicy. The kind of action that needs to be taken for cleaning up the application package after successful provision. Possible values include: 'Invalid', 'Default', 'Automatic', 'Manual' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RegisterApplicationTypeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RegisterClusterCmdlet"> <summary> Provision the code or configuration packages of a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterClusterCmdlet.CodeFilePath"> <summary> Gets or sets CodeFilePath. The cluster code package file path. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterClusterCmdlet.ClusterManifestFilePath"> <summary> Gets or sets ClusterManifestFilePath. The cluster manifest file path. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RegisterClusterCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RegisterClusterCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveApplicationCmdlet"> <summary> Deletes an existing Service Fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveApplicationCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveApplicationCmdlet.ForceRemove"> <summary> Gets or sets ForceRemove. Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveApplicationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveApplicationCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveApplicationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveBackupPolicyCmdlet"> <summary> Deletes the backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveBackupPolicyCmdlet.BackupPolicyName"> <summary> Gets or sets BackupPolicyName. The name of the backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveBackupPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveBackupPolicyCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveBackupPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveComposeDeploymentCmdlet"> <summary> Deletes an existing Service Fabric compose deployment from cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveComposeDeploymentCmdlet.DeploymentName"> <summary> Gets or sets DeploymentName. The identity of the deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveComposeDeploymentCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveComposeDeploymentCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveComposeDeploymentCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveConfigurationOverridesCmdlet"> <summary> Removes configuration overrides on the specified node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveConfigurationOverridesCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveConfigurationOverridesCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveConfigurationOverridesCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveConfigurationOverridesCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreContentCmdlet"> <summary> Deletes existing image store content. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreContentCmdlet.ContentPath"> <summary> Gets or sets ContentPath. Relative path to file or folder in the image store from its root. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreContentCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreContentCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreContentCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreUploadSessionCmdlet"> <summary> Cancels an image store upload session. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreUploadSessionCmdlet.SessionId"> <summary> Gets or sets SessionId. A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreUploadSessionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreUploadSessionCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveImageStoreUploadSessionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshApplicationCmdlet"> <summary> Deletes the Application resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshApplicationCmdlet.ApplicationResourceName"> <summary> Gets or sets ApplicationResourceName. The identity of the application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshApplicationCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshApplicationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshGatewayCmdlet"> <summary> Deletes the Gateway resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshGatewayCmdlet.GatewayResourceName"> <summary> Gets or sets GatewayResourceName. The identity of the gateway. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshGatewayCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshGatewayCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshNetworkCmdlet"> <summary> Deletes the Network resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshNetworkCmdlet.NetworkResourceName"> <summary> Gets or sets NetworkResourceName. The identity of the network. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshNetworkCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshNetworkCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretCmdlet"> <summary> Deletes the Secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretCmdlet.SecretResourceName"> <summary> Gets or sets SecretResourceName. The name of the secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretValueCmdlet"> <summary> Deletes the specified value of the named secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretValueCmdlet.SecretResourceName"> <summary> Gets or sets SecretResourceName. The name of the secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretValueCmdlet.SecretValueResourceName"> <summary> Gets or sets SecretValueResourceName. The name of the secret resource value which is typically the version identifier for the value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretValueCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshSecretValueCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshVolumeCmdlet"> <summary> Deletes the Volume resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshVolumeCmdlet.VolumeResourceName"> <summary> Gets or sets VolumeResourceName. The identity of the volume. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshVolumeCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveMeshVolumeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveNameCmdlet"> <summary> Deletes a Service Fabric name. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNameCmdlet.NameId"> <summary> Gets or sets NameId. The Service Fabric name, without the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNameCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNameCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveNameCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeStateCmdlet"> <summary> Notifies Service Fabric that the persisted state on a node has been permanently removed or lost. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeStateCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeStateCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeStateCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeStateCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeTagsCmdlet"> <summary> Removes the list of tags from the specified node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeTagsCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeTagsCmdlet.NodeTags"> <summary> Gets or sets NodeTags. Description for adding list of node tags. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeTagsCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveNodeTagsCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemovePropertyCmdlet"> <summary> Deletes the specified Service Fabric property. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemovePropertyCmdlet.NameId"> <summary> Gets or sets NameId. The Service Fabric name, without the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemovePropertyCmdlet.PropertyName"> <summary> Gets or sets PropertyName. Specifies the name of the property to get. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemovePropertyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemovePropertyCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemovePropertyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveRepairTaskCmdlet"> <summary> Deletes a completed repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveRepairTaskCmdlet.TaskId"> <summary> Gets or sets TaskId. The ID of the completed repair task to be deleted. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveRepairTaskCmdlet.Version"> <summary> Gets or sets Version. The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveRepairTaskCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveRepairTaskCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveReplicaCmdlet"> <summary> Removes a service replica running on a node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveReplicaCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveReplicaCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveReplicaCmdlet.ReplicaId"> <summary> Gets or sets ReplicaId. The identifier of the replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveReplicaCmdlet.ForceRemove"> <summary> Gets or sets ForceRemove. Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveReplicaCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveReplicaCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveReplicaCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RemoveServiceCmdlet"> <summary> Deletes an existing Service Fabric service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveServiceCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveServiceCmdlet.ForceRemove"> <summary> Gets or sets ForceRemove. Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveServiceCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RemoveServiceCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RemoveServiceCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RepairAllPartitionsCmdlet"> <summary> Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RepairAllPartitionsCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RepairAllPartitionsCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RepairPartitionCmdlet"> <summary> Indicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RepairPartitionCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RepairPartitionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RepairPartitionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RepairServicePartitionsCmdlet"> <summary> Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RepairServicePartitionsCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RepairServicePartitionsCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RepairServicePartitionsCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RepairSystemPartitionsCmdlet"> <summary> Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RepairSystemPartitionsCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RepairSystemPartitionsCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ResetPartitionLoadCmdlet"> <summary> Resets the current load of a Service Fabric partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResetPartitionLoadCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResetPartitionLoadCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ResetPartitionLoadCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ResolveServiceCmdlet"> <summary> Resolve a Service Fabric partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResolveServiceCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResolveServiceCmdlet.PartitionKeyType"> <summary> Gets or sets PartitionKeyType. Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following. - None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1. - Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2. - Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResolveServiceCmdlet.PartitionKeyValue"> <summary> Gets or sets PartitionKeyValue. Partition key. This is required if the partition scheme for the service is Int64Range or Named. This is not the partition ID, but rather, either the integer key value, or the name of the partition ID. For example, if your service is using ranged partitions from 0 to 10, then they PartitionKeyValue would be an integer in that range. Query service description to see the range or name. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResolveServiceCmdlet.PreviousRspVersion"> <summary> Gets or sets PreviousRspVersion. The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResolveServiceCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ResolveServiceCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ResolveServiceCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet"> <summary> Restarts a code package deployed on a Service Fabric node in a cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet.ServiceManifestName"> <summary> Gets or sets ServiceManifestName. The name of service manifest that specified this code package. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet.CodePackageName"> <summary> Gets or sets CodePackageName. The name of the code package defined in the service manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet.CodePackageInstanceId"> <summary> Gets or sets CodePackageInstanceId. The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running. If an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID. Note, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet.ServicePackageActivationId"> <summary> Gets or sets ServicePackageActivationId. The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RestartDeployedCodePackageCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RestartNodeCmdlet"> <summary> Restarts a Service Fabric cluster node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartNodeCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartNodeCmdlet.NodeInstanceId"> <summary> Gets or sets NodeInstanceId. The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of "0" would match any instance ID. The instance ID can be obtained using get node query. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartNodeCmdlet.CreateFabricDump"> <summary> Gets or sets CreateFabricDump. Specify True to create a dump of the fabric node process. This is case-sensitive. Possible values include: 'False', 'True' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartNodeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RestartNodeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RestartReplicaCmdlet"> <summary> Restarts a service replica of a persisted service running on a node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartReplicaCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartReplicaCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartReplicaCmdlet.ReplicaId"> <summary> Gets or sets ReplicaId. The identifier of the replica. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestartReplicaCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RestartReplicaCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet"> <summary> Triggers restore of the state of the partition using the specified restore partition description. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.AzureBlobStore"> <summary> Gets or sets AzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.FileShare"> <summary> Gets or sets FileShare flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.DsmsAzureBlobStore"> <summary> Gets or sets DsmsAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.ManagedIdentityAzureBlobStore"> <summary> Gets or sets ManagedIdentityAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.BackupId"> <summary> Gets or sets BackupId. Unique backup ID. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.BackupLocation"> <summary> Gets or sets BackupLocation. Location of the backup relative to the backup storage specified/ configured. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.ConnectionString"> <summary> Gets or sets ConnectionString. The connection string to connect to the Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.ContainerName"> <summary> Gets or sets ContainerName. The name of the container in the blob store to store and enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.Path"> <summary> Gets or sets Path. UNC path of the file share where to store or enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.StorageCredentialsSourceLocation"> <summary> Gets or sets StorageCredentialsSourceLocation. The source location of the storage credentials to connect to the Dsms Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.ManagedIdentityType"> <summary> Gets or sets ManagedIdentityType. The type of managed identity to be used to connect to Azure Blob Store via Managed Identity. . Possible values include: 'Invalid', 'VMSS', 'Cluster' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.BlobServiceUri"> <summary> Gets or sets BlobServiceUri. The Blob Service Uri to connect to the Azure blob store.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.FriendlyName"> <summary> Gets or sets FriendlyName. Friendly name for this backup storage. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.PrimaryUserName"> <summary> Gets or sets PrimaryUserName. Primary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.PrimaryPassword"> <summary> Gets or sets PrimaryPassword. Primary password to access the share location. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.SecondaryUserName"> <summary> Gets or sets SecondaryUserName. Secondary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.SecondaryPassword"> <summary> Gets or sets SecondaryPassword. Secondary password to access the share location </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.ManagedIdentityClientId"> <summary> Gets or sets ManagedIdentityClientId. The ClientId of User-Assigned Managed Identity </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.Latest"> <summary> Gets or sets Latest. Specifies whether BackupRestore Service whould automatically determine the latest backup available and Restore using that. Set to false by default, but user can pass True and BackupRestore service will automatically fetch the latest backup and Restore the partition using that. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.RestoreTimeout"> <summary> Gets or sets RestoreTimeout. Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.RestorePartitionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationBackupCmdlet"> <summary> Resumes periodic backup of a Service Fabric application which was previously suspended. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationBackupCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationUpgradeCmdlet"> <summary> Resumes upgrading an application in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationUpgradeCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationUpgradeCmdlet.UpgradeDomainName"> <summary> Gets or sets UpgradeDomainName. The name of the upgrade domain in which to resume the upgrade. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ResumeApplicationUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ResumeClusterUpgradeCmdlet"> <summary> Make the cluster upgrade move on to the next upgrade domain. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeClusterUpgradeCmdlet.UpgradeDomain"> <summary> Gets or sets UpgradeDomain. The next upgrade domain for this cluster upgrade. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeClusterUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ResumeClusterUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ResumePartitionBackupCmdlet"> <summary> Resumes periodic backup of partition which was previously suspended. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumePartitionBackupCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumePartitionBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ResumePartitionBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ResumeServiceBackupCmdlet"> <summary> Resumes periodic backup of a Service Fabric service which was previously suspended. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeServiceBackupCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ResumeServiceBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ResumeServiceBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.SetUpgradeOrchestrationServiceStateCmdlet"> <summary> Update the service state of Service Fabric Upgrade Orchestration Service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SetUpgradeOrchestrationServiceStateCmdlet.ServiceState"> <summary> Gets or sets ServiceState. The state of Service Fabric Upgrade Orchestration Service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SetUpgradeOrchestrationServiceStateCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SetUpgradeOrchestrationServiceStateCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SetUpgradeOrchestrationServiceStateCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ShowMeshSecretValueCmdlet"> <summary> Lists the specified value of the secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ShowMeshSecretValueCmdlet.SecretResourceName"> <summary> Gets or sets SecretResourceName. The name of the secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ShowMeshSecretValueCmdlet.SecretValueResourceName"> <summary> Gets or sets SecretValueResourceName. The name of the secret resource value which is typically the version identifier for the value. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ShowMeshSecretValueCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ShowMeshSecretValueCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.SkipRestorePartitionCmdlet"> <summary> Triggers Skipping of Restore of partition if partition is stuck on trying to Restore and user wants to get out of OnDataLossAsync and continue with the replica data instead of restoring. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SkipRestorePartitionCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SkipRestorePartitionCmdlet.RestoreTimeout"> <summary> Gets or sets RestoreTimeout. Specifies the maximum amount of time to wait, in minutes, for the Skip restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SkipRestorePartitionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SkipRestorePartitionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet"> <summary> Starts Chaos in the cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.TimeToRunInSeconds"> <summary> Gets or sets TimeToRunInSeconds. Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.MaxClusterStabilizationTimeoutInSeconds"> <summary> Gets or sets MaxClusterStabilizationTimeoutInSeconds. The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities. During validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.MaxConcurrentFaults"> <summary> Gets or sets MaxConcurrentFaults. MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration. Chaos executes in iterations and two consecutive iterations are separated by a validation phase. The higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs. The recommendation is to start with a value of 2 or 3 and to exercise caution while moving up. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.EnableMoveReplicaFaults"> <summary> Gets or sets EnableMoveReplicaFaults. Enables or disables the move primary and move secondary faults. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.WaitTimeBetweenFaultsInSeconds"> <summary> Gets or sets WaitTimeBetweenFaultsInSeconds. Wait time (in seconds) between consecutive faults within a single iteration. The larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through. The recommendation is to start with a value between 1 and 5 and exercise caution while moving up. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.WaitTimeBetweenIterationsInSeconds"> <summary> Gets or sets WaitTimeBetweenIterationsInSeconds. Time-separation (in seconds) between two consecutive iterations of Chaos. The larger the value, the lower the fault injection rate. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.MaxPercentUnhealthyNodes"> <summary> Gets or sets MaxPercentUnhealthyNodes. The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.MaxPercentUnhealthyApplications"> <summary> Gets or sets MaxPercentUnhealthyApplications. The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.ApplicationTypeHealthPolicyMap"> <summary> Gets or sets ApplicationTypeHealthPolicyMap. Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.NodeTypeHealthPolicyMap"> <summary> Gets or sets NodeTypeHealthPolicyMap. Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type. The node type health policy map can be used during cluster health evaluation to describe special node types. They are evaluated against the percentages associated with their node type name in the map. Setting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. The node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation. For example, given a cluster with many nodes of different types, with important work hosted on node type "SpecialNodeType" that should not tolerate any nodes down. You can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type "SpecialNodeType", set the MaxPercentUnhealthyNodes to 0 by setting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. This way, as long as no nodes of type "SpecialNodeType" are in Error state, even if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. A Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. But even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. Conversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, with one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.Map"> <summary> Gets or sets Map. Describes a map that contains a collection of ChaosContextMapItem's. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.NodeTypeInclusionList"> <summary> Gets or sets NodeTypeInclusionList. A list of node types to include in Chaos faults. All types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types. If a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of NodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList. happens to reside on a node of NodeTypeX. At most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.ApplicationInclusionList"> <summary> Gets or sets ApplicationInclusionList. A list of application URIs to include in Chaos faults. All replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos. Chaos may restart a code package only if the code package hosts replicas of these applications only. If an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList. However, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted. At most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartChaosCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet"> <summary> Start upgrading the configuration of a Service Fabric standalone cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.ClusterConfig"> <summary> Gets or sets ClusterConfig. The cluster configuration as a JSON string. For example, [this file](https://github.com/Azure-Samples/service-fabric-dotnet-standalone-cluster-configuration/blob/master/Samples/ClusterConfig.Unsecure.DevCluster.json) contains JSON describing the [nodes and other properties of the cluster](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-manifest). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.HealthCheckRetryTimeout"> <summary> Gets or sets HealthCheckRetryTimeout. The length of time between attempts to perform health checks if the application or cluster is not healthy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.HealthCheckWaitDurationInSeconds"> <summary> Gets or sets HealthCheckWaitDurationInSeconds. The length of time to wait after completing an upgrade domain before starting the health checks process. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.HealthCheckStableDurationInSeconds"> <summary> Gets or sets HealthCheckStableDurationInSeconds. The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.UpgradeDomainTimeoutInSeconds"> <summary> Gets or sets UpgradeDomainTimeoutInSeconds. The timeout for the upgrade domain. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.UpgradeTimeoutInSeconds"> <summary> Gets or sets UpgradeTimeoutInSeconds. The upgrade timeout. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.MaxPercentUnhealthyApplications"> <summary> Gets or sets MaxPercentUnhealthyApplications. The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.MaxPercentUnhealthyNodes"> <summary> Gets or sets MaxPercentUnhealthyNodes. The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.MaxPercentDeltaUnhealthyNodes"> <summary> Gets or sets MaxPercentDeltaUnhealthyNodes. The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.MaxPercentUpgradeDomainDeltaUnhealthyNodes"> <summary> Gets or sets MaxPercentUpgradeDomainDeltaUnhealthyNodes. The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.ApplicationHealthPolicyMap"> <summary> Gets or sets ApplicationHealthPolicyMap. The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartClusterConfigurationUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet"> <summary> Start upgrading the code or configuration version of a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.CodeVersion"> <summary> Gets or sets CodeVersion. The cluster code version. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.ConfigVersion"> <summary> Gets or sets ConfigVersion. The cluster configuration version. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.UpgradeKind"> <summary> Gets or sets UpgradeKind. The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.RollingUpgradeMode"> <summary> Gets or sets RollingUpgradeMode. The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored', 'UnmonitoredDeferred' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.UpgradeReplicaSetCheckTimeoutInSeconds"> <summary> Gets or sets UpgradeReplicaSetCheckTimeoutInSeconds. The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.ForceRestart"> <summary> Gets or sets ForceRestart. If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.SortOrder"> <summary> Gets or sets SortOrder. Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.FailureAction"> <summary> Gets or sets FailureAction. The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.HealthCheckWaitDurationInMilliseconds"> <summary> Gets or sets HealthCheckWaitDurationInMilliseconds. The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.HealthCheckStableDurationInMilliseconds"> <summary> Gets or sets HealthCheckStableDurationInMilliseconds. The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.HealthCheckRetryTimeoutInMilliseconds"> <summary> Gets or sets HealthCheckRetryTimeoutInMilliseconds. The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.UpgradeTimeoutInMilliseconds"> <summary> Gets or sets UpgradeTimeoutInMilliseconds. The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.UpgradeDomainTimeoutInMilliseconds"> <summary> Gets or sets UpgradeDomainTimeoutInMilliseconds. The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.MaxPercentUnhealthyNodes"> <summary> Gets or sets MaxPercentUnhealthyNodes. The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.MaxPercentUnhealthyApplications"> <summary> Gets or sets MaxPercentUnhealthyApplications. The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.ApplicationTypeHealthPolicyMap"> <summary> Gets or sets ApplicationTypeHealthPolicyMap. Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.NodeTypeHealthPolicyMap"> <summary> Gets or sets NodeTypeHealthPolicyMap. Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type. The node type health policy map can be used during cluster health evaluation to describe special node types. They are evaluated against the percentages associated with their node type name in the map. Setting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. The node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation. For example, given a cluster with many nodes of different types, with important work hosted on node type "SpecialNodeType" that should not tolerate any nodes down. You can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type "SpecialNodeType", set the MaxPercentUnhealthyNodes to 0 by setting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. This way, as long as no nodes of type "SpecialNodeType" are in Error state, even if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. A Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. But even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. Conversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, with one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.EnableDeltaHealthEvaluation"> <summary> Gets or sets EnableDeltaHealthEvaluation. When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.MaxPercentDeltaUnhealthyNodes"> <summary> Gets or sets MaxPercentDeltaUnhealthyNodes. The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.MaxPercentUpgradeDomainDeltaUnhealthyNodes"> <summary> Gets or sets MaxPercentUpgradeDomainDeltaUnhealthyNodes. The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.ApplicationHealthPolicyMap"> <summary> Gets or sets ApplicationHealthPolicyMap. The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.InstanceCloseDelayDurationInSeconds"> <summary> Gets or sets InstanceCloseDelayDurationInSeconds. Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartClusterUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet"> <summary> Starts upgrading a compose deployment in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.DeploymentName"> <summary> Gets or sets DeploymentName. The identity of the deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.ComposeFileContent"> <summary> Gets or sets ComposeFileContent. The content of the compose file that describes the deployment to create. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.UpgradeKind"> <summary> Gets or sets UpgradeKind. The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.RegistryUserName"> <summary> Gets or sets RegistryUserName. The user name to connect to container registry. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.RegistryPassword"> <summary> Gets or sets RegistryPassword. The password for supplied username to connect to container registry. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.PasswordEncrypted"> <summary> Gets or sets PasswordEncrypted. Indicates that supplied container registry password is encrypted. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.RollingUpgradeMode"> <summary> Gets or sets RollingUpgradeMode. The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored', 'UnmonitoredDeferred' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.UpgradeReplicaSetCheckTimeoutInSeconds"> <summary> Gets or sets UpgradeReplicaSetCheckTimeoutInSeconds. The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.ForceRestart"> <summary> Gets or sets ForceRestart. If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.FailureAction"> <summary> Gets or sets FailureAction. The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.HealthCheckWaitDurationInMilliseconds"> <summary> Gets or sets HealthCheckWaitDurationInMilliseconds. The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.HealthCheckStableDurationInMilliseconds"> <summary> Gets or sets HealthCheckStableDurationInMilliseconds. The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.HealthCheckRetryTimeoutInMilliseconds"> <summary> Gets or sets HealthCheckRetryTimeoutInMilliseconds. The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.UpgradeTimeoutInMilliseconds"> <summary> Gets or sets UpgradeTimeoutInMilliseconds. The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.UpgradeDomainTimeoutInMilliseconds"> <summary> Gets or sets UpgradeDomainTimeoutInMilliseconds. The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartComposeDeploymentUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartDataLossCmdlet"> <summary> This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartDataLossCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartDataLossCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartDataLossCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartDataLossCmdlet.DataLossMode"> <summary> Gets or sets DataLossMode. This enum is passed to the StartDataLoss API to indicate what type of data loss to induce. Possible values include: 'Invalid', 'PartialDataLoss', 'FullDataLoss' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartDataLossCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartDataLossCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartNodeTransitionCmdlet"> <summary> Starts or stops a cluster node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartNodeTransitionCmdlet.NodeName"> <summary> Gets or sets NodeName. The name of the node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartNodeTransitionCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartNodeTransitionCmdlet.NodeTransitionType"> <summary> Gets or sets NodeTransitionType. Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up. Possible values include: 'Invalid', 'Start', 'Stop' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartNodeTransitionCmdlet.NodeInstanceId"> <summary> Gets or sets NodeInstanceId. The node instance ID of the target node. This can be determined through GetNodeInfo API. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartNodeTransitionCmdlet.StopDurationInSeconds"> <summary> Gets or sets StopDurationInSeconds. The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartNodeTransitionCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartNodeTransitionCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartPartitionRestartCmdlet"> <summary> This API will restart some or all replicas or instances of the specified partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartPartitionRestartCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartPartitionRestartCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartPartitionRestartCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartPartitionRestartCmdlet.RestartPartitionMode"> <summary> Gets or sets RestartPartitionMode. Describe which partitions to restart. Possible values include: 'Invalid', 'AllReplicasOrInstances', 'OnlyActiveSecondaries' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartPartitionRestartCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartPartitionRestartCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartQuorumLossCmdlet"> <summary> Induces quorum loss for a given stateful service partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartQuorumLossCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartQuorumLossCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartQuorumLossCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartQuorumLossCmdlet.QuorumLossMode"> <summary> Gets or sets QuorumLossMode. This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce. Possible values include: 'Invalid', 'QuorumReplicas', 'AllReplicas' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartQuorumLossCmdlet.QuorumLossDuration"> <summary> Gets or sets QuorumLossDuration. The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartQuorumLossCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartQuorumLossCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartRollbackComposeDeploymentUpgradeCmdlet"> <summary> Starts rolling back a compose deployment upgrade in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartRollbackComposeDeploymentUpgradeCmdlet.DeploymentName"> <summary> Gets or sets DeploymentName. The identity of the deployment. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartRollbackComposeDeploymentUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartRollbackComposeDeploymentUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StopChaosCmdlet"> <summary> Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StopChaosCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StopChaosCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StopOperationCmdlet"> <summary> Cancels a user-induced fault operation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StopOperationCmdlet.OperationId"> <summary> Gets or sets OperationId. A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StopOperationCmdlet.Force"> <summary> Gets or sets Force. Indicates whether to gracefully roll back and clean up internal system state modified by executing the user-induced operation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StopOperationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StopOperationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StopRepairTaskCmdlet"> <summary> Requests the cancellation of the given repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StopRepairTaskCmdlet.TaskId"> <summary> Gets or sets TaskId. The ID of the repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StopRepairTaskCmdlet.Version"> <summary> Gets or sets Version. The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StopRepairTaskCmdlet.RequestAbort"> <summary> Gets or sets RequestAbort. _True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StopRepairTaskCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StopRepairTaskCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.SubmitPropertyBatchCmdlet"> <summary> Submits a property batch. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SubmitPropertyBatchCmdlet.NameId"> <summary> Gets or sets NameId. The Service Fabric name, without the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SubmitPropertyBatchCmdlet.Operations"> <summary> Gets or sets Operations. A list of the property batch operations to be executed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SubmitPropertyBatchCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SubmitPropertyBatchCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SubmitPropertyBatchCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.SuspendApplicationBackupCmdlet"> <summary> Suspends periodic backup for the specified Service Fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendApplicationBackupCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendApplicationBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendApplicationBackupCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SuspendApplicationBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.SuspendPartitionBackupCmdlet"> <summary> Suspends periodic backup for the specified partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendPartitionBackupCmdlet.PartitionId"> <summary> Gets or sets PartitionId. The identity of the partition. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendPartitionBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendPartitionBackupCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SuspendPartitionBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.SuspendServiceBackupCmdlet"> <summary> Suspends periodic backup for the specified Service Fabric service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendServiceBackupCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendServiceBackupCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SuspendServiceBackupCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SuspendServiceBackupCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.SwitchVerboseServicePlacementHealthReportingCmdlet"> <summary> Changes the verbosity of service placement health reporting. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SwitchVerboseServicePlacementHealthReportingCmdlet.Enabled"> <summary> Gets or sets Enabled. The verbosity of service placement health reporting. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.SwitchVerboseServicePlacementHealthReportingCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.SwitchVerboseServicePlacementHealthReportingCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UnregisterApplicationTypeCmdlet"> <summary> Removes or unregisters a Service Fabric application type from the cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterApplicationTypeCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The name of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterApplicationTypeCmdlet.ApplicationTypeVersion"> <summary> Gets or sets ApplicationTypeVersion. The version of the application type as defined in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterApplicationTypeCmdlet.Async"> <summary> Gets or sets Async. The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterApplicationTypeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterApplicationTypeCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UnregisterApplicationTypeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UnregisterClusterCmdlet"> <summary> Unprovision the code or configuration packages of a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterClusterCmdlet.CodeVersion"> <summary> Gets or sets CodeVersion. The cluster code package version. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterClusterCmdlet.ConfigVersion"> <summary> Gets or sets ConfigVersion. The cluster manifest version. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterClusterCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UnregisterClusterCmdlet.Force"> <summary> Gets or sets the force flag. If provided, then the destructive action will be performed without asking for confirmation prompt. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UnregisterClusterCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationArmMetadataCmdlet"> <summary> Updates the Arm Metadata for a specific Application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationArmMetadataCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationArmMetadataCmdlet.ArmResourceId"> <summary> Gets or sets ArmResourceId. A string containing the ArmResourceId. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationArmMetadataCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationArmMetadataCmdlet.Force"> <summary> Gets or sets Force. Force parameter used to prevent accidental Arm metadata update. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationArmMetadataCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet"> <summary> Updates a Service Fabric application. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet.Flags"> <summary> Gets or sets Flags. Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. If flags are not specified for a certain property, the property will not be updated even if the new value is provided. This property can be a combination of those flags obtained using bitwise 'OR' operator. Exception is RemoveApplicationCapacity which cannot be specified along with other parameters. For example, if the provided value is 3 then the flags for MinimumNodes (1) and MaximumNodes (2) are set. - None - Does not indicate any other properties are set. The value is 0. - MinimumNodes - Indicates whether the MinimumNodes property is set. The value is 1. - MaximumNodes - Indicates whether the MinimumNodes property is set. The value is 2. - ApplicationMetrics - Indicates whether the ApplicationMetrics property is set. The value is 4. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet.RemoveApplicationCapacity"> <summary> Gets or sets RemoveApplicationCapacity. Used to clear all parameters related to Application Capacity for this application. | It is not possible to specify this parameter together with other Application Capacity parameters. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet.MinimumNodes"> <summary> Gets or sets MinimumNodes. The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet.MaximumNodes"> <summary> Gets or sets MaximumNodes. The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet.ApplicationMetrics"> <summary> Gets or sets ApplicationMetrics. List of application capacity metric description. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationTypeArmMetadataCmdlet"> <summary> Updates the Arm Metadata for a specific Application Type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationTypeArmMetadataCmdlet.ApplicationTypeName"> <summary> Gets or sets ApplicationTypeName. The name of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationTypeArmMetadataCmdlet.ApplicationTypeVersion"> <summary> Gets or sets ApplicationTypeVersion. The version of the application type. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationTypeArmMetadataCmdlet.ArmResourceId"> <summary> Gets or sets ArmResourceId. A string containing the ArmResourceId. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationTypeArmMetadataCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationTypeArmMetadataCmdlet.Force"> <summary> Gets or sets Force. Force parameter used to prevent accidental Arm metadata update. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationTypeArmMetadataCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet"> <summary> Updates an ongoing application upgrade in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.Name"> <summary> Gets or sets Name. The name of the application, including the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.UpgradeKind"> <summary> Gets or sets UpgradeKind. The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.RollingUpgradeMode"> <summary> Gets or sets RollingUpgradeMode. The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored', 'UnmonitoredDeferred' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.ForceRestart"> <summary> Gets or sets ForceRestart. If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.ReplicaSetCheckTimeoutInMilliseconds"> <summary> Gets or sets ReplicaSetCheckTimeoutInMilliseconds. The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.FailureAction"> <summary> Gets or sets FailureAction. The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.HealthCheckWaitDurationInMilliseconds"> <summary> Gets or sets HealthCheckWaitDurationInMilliseconds. The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.HealthCheckStableDurationInMilliseconds"> <summary> Gets or sets HealthCheckStableDurationInMilliseconds. The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.HealthCheckRetryTimeoutInMilliseconds"> <summary> Gets or sets HealthCheckRetryTimeoutInMilliseconds. The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.UpgradeTimeoutInMilliseconds"> <summary> Gets or sets UpgradeTimeoutInMilliseconds. The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.UpgradeDomainTimeoutInMilliseconds"> <summary> Gets or sets UpgradeDomainTimeoutInMilliseconds. The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.InstanceCloseDelayDurationInSeconds"> <summary> Gets or sets InstanceCloseDelayDurationInSeconds. Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateApplicationUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet"> <summary> Updates the backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.FrequencyBased"> <summary> Gets or sets FrequencyBased flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.TimeBased"> <summary> Gets or sets TimeBased flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.AzureBlobStore"> <summary> Gets or sets AzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.FileShare"> <summary> Gets or sets FileShare flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.DsmsAzureBlobStore"> <summary> Gets or sets DsmsAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ManagedIdentityAzureBlobStore"> <summary> Gets or sets ManagedIdentityAzureBlobStore flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.Basic"> <summary> Gets or sets Basic flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.Name"> <summary> Gets or sets Name. The unique name identifying this backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.AutoRestoreOnDataLoss"> <summary> Gets or sets AutoRestoreOnDataLoss. Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.MaxIncrementalBackups"> <summary> Gets or sets MaxIncrementalBackups. Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions - The replica has never taken a full backup since it has become primary, - Some of the log records since the last backup has been truncated, or - Replica passed the MaxAccumulatedBackupLogSizeInMB limit. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.Interval"> <summary> Gets or sets Interval. Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ScheduleFrequencyType"> <summary> Gets or sets ScheduleFrequencyType. Describes the frequency with which to run the time based backup schedule. . Possible values include: 'Invalid', 'Daily', 'Weekly' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.RunTimes"> <summary> Gets or sets RunTimes. Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ConnectionString"> <summary> Gets or sets ConnectionString. The connection string to connect to the Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ContainerName"> <summary> Gets or sets ContainerName. The name of the container in the blob store to store and enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.Path"> <summary> Gets or sets Path. UNC path of the file share where to store or enumerate backups from. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.StorageCredentialsSourceLocation"> <summary> Gets or sets StorageCredentialsSourceLocation. The source location of the storage credentials to connect to the Dsms Azure blob store. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ManagedIdentityType"> <summary> Gets or sets ManagedIdentityType. The type of managed identity to be used to connect to Azure Blob Store via Managed Identity. . Possible values include: 'Invalid', 'VMSS', 'Cluster' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.BlobServiceUri"> <summary> Gets or sets BlobServiceUri. The Blob Service Uri to connect to the Azure blob store.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.RetentionDuration"> <summary> Gets or sets RetentionDuration. It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.BackupPolicyName"> <summary> Gets or sets BackupPolicyName. The name of the backup policy. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.RunDays"> <summary> Gets or sets RunDays. List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.FriendlyName"> <summary> Gets or sets FriendlyName. Friendly name for this backup storage. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.PrimaryUserName"> <summary> Gets or sets PrimaryUserName. Primary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.PrimaryPassword"> <summary> Gets or sets PrimaryPassword. Primary password to access the share location. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.SecondaryUserName"> <summary> Gets or sets SecondaryUserName. Secondary user name to access the file share. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.SecondaryPassword"> <summary> Gets or sets SecondaryPassword. Secondary password to access the share location </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ManagedIdentityClientId"> <summary> Gets or sets ManagedIdentityClientId. The ClientId of User-Assigned Managed Identity </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.MinimumNumberOfBackups"> <summary> Gets or sets MinimumNumberOfBackups. It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ValidateConnection"> <summary> Gets or sets ValidateConnection. Specifies whether to validate the storage connection and credentials before creating or updating the backup policies. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateBackupPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet"> <summary> Update the upgrade parameters of a Service Fabric cluster upgrade. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.RollingUpgradeMode"> <summary> Gets or sets RollingUpgradeMode. The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored', 'UnmonitoredDeferred' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.UpgradeKind"> <summary> Gets or sets UpgradeKind. The type of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling', 'Rolling_ForceRestart' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.ForceRestart"> <summary> Gets or sets ForceRestart. If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.ReplicaSetCheckTimeoutInMilliseconds"> <summary> Gets or sets ReplicaSetCheckTimeoutInMilliseconds. The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.FailureAction"> <summary> Gets or sets FailureAction. The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.HealthCheckWaitDurationInMilliseconds"> <summary> Gets or sets HealthCheckWaitDurationInMilliseconds. The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.HealthCheckStableDurationInMilliseconds"> <summary> Gets or sets HealthCheckStableDurationInMilliseconds. The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.HealthCheckRetryTimeoutInMilliseconds"> <summary> Gets or sets HealthCheckRetryTimeoutInMilliseconds. The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.UpgradeTimeoutInMilliseconds"> <summary> Gets or sets UpgradeTimeoutInMilliseconds. The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.UpgradeDomainTimeoutInMilliseconds"> <summary> Gets or sets UpgradeDomainTimeoutInMilliseconds. The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.InstanceCloseDelayDurationInSeconds"> <summary> Gets or sets InstanceCloseDelayDurationInSeconds. Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.MaxPercentUnhealthyNodes"> <summary> Gets or sets MaxPercentUnhealthyNodes. The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.MaxPercentUnhealthyApplications"> <summary> Gets or sets MaxPercentUnhealthyApplications. The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.ApplicationTypeHealthPolicyMap"> <summary> Gets or sets ApplicationTypeHealthPolicyMap. Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.NodeTypeHealthPolicyMap"> <summary> Gets or sets NodeTypeHealthPolicyMap. Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type. The node type health policy map can be used during cluster health evaluation to describe special node types. They are evaluated against the percentages associated with their node type name in the map. Setting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. The node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation. For example, given a cluster with many nodes of different types, with important work hosted on node type "SpecialNodeType" that should not tolerate any nodes down. You can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type "SpecialNodeType", set the MaxPercentUnhealthyNodes to 0 by setting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. This way, as long as no nodes of type "SpecialNodeType" are in Error state, even if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. A Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. But even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. Conversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, with one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.EnableDeltaHealthEvaluation"> <summary> Gets or sets EnableDeltaHealthEvaluation. When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.MaxPercentDeltaUnhealthyNodes"> <summary> Gets or sets MaxPercentDeltaUnhealthyNodes. The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.MaxPercentUpgradeDomainDeltaUnhealthyNodes"> <summary> Gets or sets MaxPercentUpgradeDomainDeltaUnhealthyNodes. The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.ApplicationHealthPolicyMap"> <summary> Gets or sets ApplicationHealthPolicyMap. The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateClusterUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdatePartitionLoadCmdlet"> <summary> Update the loads of provided partitions for specific metrics. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdatePartitionLoadCmdlet.PartitionMetricLoadDescriptionList"> <summary> Gets or sets PartitionMetricLoadDescriptionList. Description of updating load for list of partitions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdatePartitionLoadCmdlet.MaxResults"> <summary> Gets or sets MaxResults. The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdatePartitionLoadCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdatePartitionLoadCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdatePartitionLoadCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet"> <summary> Updates the execution state of a repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.Node"> <summary> Gets or sets Node flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.TaskId"> <summary> Gets or sets TaskId. The ID of the repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.State"> <summary> Gets or sets State. The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.Action"> <summary> Gets or sets Action. The requested repair action. Must be specified when the repair task is created, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.Version"> <summary> Gets or sets Version. The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.Description"> <summary> Gets or sets Description. A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.Flags"> <summary> Gets or sets Flags. A bitwise-OR of the following values, which gives additional details about the status of the repair task. - 1 - Cancellation of the repair has been requested - 2 - Abort of the repair has been requested - 4 - Approval of the repair was forced via client request </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.NodeNames"> <summary> Gets or sets NodeNames. The list of nodes targeted by a repair action. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.Executor"> <summary> Gets or sets Executor. The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.ExecutorData"> <summary> Gets or sets ExecutorData. A data string that the repair executor can use to store its internal state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.NodeImpactList"> <summary> Gets or sets NodeImpactList. The list of nodes impacted by a repair action and their respective expected impact. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.ResultStatus"> <summary> Gets or sets ResultStatus. A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set. Possible values include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.ResultCode"> <summary> Gets or sets ResultCode. A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.ResultDetails"> <summary> Gets or sets ResultDetails. A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.CreatedUtcTimestamp"> <summary> Gets or sets CreatedUtcTimestamp. The time when the repair task entered the Created state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.ClaimedUtcTimestamp"> <summary> Gets or sets ClaimedUtcTimestamp. The time when the repair task entered the Claimed state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.PreparingUtcTimestamp"> <summary> Gets or sets PreparingUtcTimestamp. The time when the repair task entered the Preparing state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.ApprovedUtcTimestamp"> <summary> Gets or sets ApprovedUtcTimestamp. The time when the repair task entered the Approved state </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.ExecutingUtcTimestamp"> <summary> Gets or sets ExecutingUtcTimestamp. The time when the repair task entered the Executing state </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.RestoringUtcTimestamp"> <summary> Gets or sets RestoringUtcTimestamp. The time when the repair task entered the Restoring state </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.CompletedUtcTimestamp"> <summary> Gets or sets CompletedUtcTimestamp. The time when the repair task entered the Completed state </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.PreparingHealthCheckStartUtcTimestamp"> <summary> Gets or sets PreparingHealthCheckStartUtcTimestamp. The time when the repair task started the health check in the Preparing state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.PreparingHealthCheckEndUtcTimestamp"> <summary> Gets or sets PreparingHealthCheckEndUtcTimestamp. The time when the repair task completed the health check in the Preparing state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.RestoringHealthCheckStartUtcTimestamp"> <summary> Gets or sets RestoringHealthCheckStartUtcTimestamp. The time when the repair task started the health check in the Restoring state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.RestoringHealthCheckEndUtcTimestamp"> <summary> Gets or sets RestoringHealthCheckEndUtcTimestamp. The time when the repair task completed the health check in the Restoring state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.PreparingHealthCheckState"> <summary> Gets or sets PreparingHealthCheckState. The workflow state of the health check when the repair task is in the Preparing state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut' Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.RestoringHealthCheckState"> <summary> Gets or sets RestoringHealthCheckState. The workflow state of the health check when the repair task is in the Restoring state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut' Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.PerformPreparingHealthCheck"> <summary> Gets or sets PerformPreparingHealthCheck. A value to determine if health checks will be performed when the repair task enters the Preparing state. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.PerformRestoringHealthCheck"> <summary> Gets or sets PerformRestoringHealthCheck. A value to determine if health checks will be performed when the repair task enters the Restoring state. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairExecutionStateCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairTaskHealthPolicyCmdlet"> <summary> Updates the health policy of the given repair task. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairTaskHealthPolicyCmdlet.TaskId"> <summary> Gets or sets TaskId. The ID of the repair task to be updated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairTaskHealthPolicyCmdlet.Version"> <summary> Gets or sets Version. The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairTaskHealthPolicyCmdlet.PerformPreparingHealthCheck"> <summary> Gets or sets PerformPreparingHealthCheck. A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairTaskHealthPolicyCmdlet.PerformRestoringHealthCheck"> <summary> Gets or sets PerformRestoringHealthCheck. A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairTaskHealthPolicyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateRepairTaskHealthPolicyCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceArmMetadataCmdlet"> <summary> Updates the Arm Metadata for a specific service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceArmMetadataCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceArmMetadataCmdlet.ArmResourceId"> <summary> Gets or sets ArmResourceId. A string containing the ArmResourceId. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceArmMetadataCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceArmMetadataCmdlet.Force"> <summary> Gets or sets Force. Force parameter used to prevent accidental Arm metadata update. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceArmMetadataCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet"> <summary> Updates a Service Fabric service using the specified update description. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.Stateful"> <summary> Gets or sets Stateful flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.Stateless"> <summary> Gets or sets Stateless flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ServiceId"> <summary> Gets or sets ServiceId. The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.Flags"> <summary> Gets or sets Flags. Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set. - None - Does not indicate any other properties are set. The value is zero. - TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8. - MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16. - PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32. - PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64. - Correlation - Indicates the CorrelationScheme property is set. The value is 128. - Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256. - DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512. - ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024. - ServicePlacementTimeLimit - Indicates the ServicePlacementTimeLimit property is set. The value is 2048. - MinInstanceCount - Indicates the MinInstanceCount property is set. The value is 4096. - MinInstancePercentage - Indicates the MinInstancePercentage property is set. The value is 8192. - InstanceCloseDelayDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 16384. - InstanceRestartWaitDuration - Indicates the InstanceCloseDelayDuration property is set. The value is 32768. - DropSourceReplicaOnMove - Indicates the DropSourceReplicaOnMove property is set. The value is 65536. - ServiceDnsName - Indicates the ServiceDnsName property is set. The value is 131072. - TagsForPlacement - Indicates the TagsForPlacement property is set. The value is 1048576. - TagsForRunning - Indicates the TagsForRunning property is set. The value is 2097152. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.PlacementConstraints"> <summary> Gets or sets PlacementConstraints. The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)". </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.CorrelationScheme"> <summary> Gets or sets CorrelationScheme. The correlation scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.LoadMetrics"> <summary> Gets or sets LoadMetrics. The service load metrics. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ServicePlacementPolicies"> <summary> Gets or sets ServicePlacementPolicies. The service placement policies. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.DefaultMoveCost"> <summary> Gets or sets DefaultMoveCost. The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High', 'VeryHigh' Specifies the move cost for the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ScalingPolicies"> <summary> Gets or sets ScalingPolicies. Scaling policies for this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ServiceDnsName"> <summary> Gets or sets ServiceDnsName. The DNS name of the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.TagsForPlacement"> <summary> Gets or sets TagsForPlacement. Tags for placement of this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.TagsForRunning"> <summary> Gets or sets TagsForRunning. Tags for running of this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.TargetReplicaSetSize"> <summary> Gets or sets TargetReplicaSetSize. The target replica set size as a number. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.MinReplicaSetSize"> <summary> Gets or sets MinReplicaSetSize. The minimum replica set size as a number. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ReplicaRestartWaitDurationSeconds"> <summary> Gets or sets ReplicaRestartWaitDurationSeconds. The duration, in seconds, between when a replica goes down and when a new replica is created. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.QuorumLossWaitDurationSeconds"> <summary> Gets or sets QuorumLossWaitDurationSeconds. The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.StandByReplicaKeepDurationSeconds"> <summary> Gets or sets StandByReplicaKeepDurationSeconds. The definition on how long StandBy replicas should be maintained before being removed. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ServicePlacementTimeLimitSeconds"> <summary> Gets or sets ServicePlacementTimeLimitSeconds. The duration for which replicas can stay InBuild before reporting that build is stuck. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.DropSourceReplicaOnMove"> <summary> Gets or sets DropSourceReplicaOnMove. Indicates whether to drop source Secondary replica even if the target replica has not finished build. If desired behavior is to drop it as soon as possible the value of this property is true, if not it is false. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ReplicaLifecycleDescription"> <summary> Gets or sets ReplicaLifecycleDescription. Defines how replicas of this service will behave during ther lifecycle. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.AuxiliaryReplicaCount"> <summary> Gets or sets AuxiliaryReplicaCount. The auxiliary replica count as a number. To use Auxiliary replicas, the following must be true: AuxiliaryReplicaCount < (TargetReplicaSetSize+1)/2 and TargetReplicaSetSize >=3. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ServiceSensitivityDescription"> <summary> Gets or sets ServiceSensitivityDescription. Defines default levels of replica sensitivity of this service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.InstanceCount"> <summary> Gets or sets InstanceCount. The instance count. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.MinInstanceCount"> <summary> Gets or sets MinInstanceCount. MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.MinInstancePercentage"> <summary> Gets or sets MinInstancePercentage. MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.InstanceCloseDelayDurationSeconds"> <summary> Gets or sets InstanceCloseDelayDurationSeconds. Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade and disabling node. The endpoint exposed on this instance is removed prior to starting the delay, which prevents new connections to this instance. In addition, clients that have subscribed to service endpoint change events(https://docs.microsoft.com/dotnet/api/system.fabric.fabricclient.servicemanagementclient.registerservicenotificationfilterasync), can do the following upon receiving the endpoint removal notification: - Stop sending new requests to this instance. - Close existing connections after in-flight requests have completed. - Connect to a different instance of the service partition for future requests. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.InstanceLifecycleDescription"> <summary> Gets or sets InstanceLifecycleDescription. Defines how instances of this service will behave during their lifecycle. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.InstanceRestartWaitDurationSeconds"> <summary> Gets or sets InstanceRestartWaitDurationSeconds. When a stateless instance goes down, this timer starts. When it expires Service Fabric will create a new instance on any node in the cluster. This configuration is to reduce unnecessary creation of a new instance in situations where the instance going down is likely to recover in a short time. For example, during an upgrade. The default value is 0, which indicates that when stateless instance goes down, Service Fabric will immediately start building its replacement. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateServiceCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet"> <summary> Validate and assess the impact of a code or configuration version update of a Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.CodeVersion"> <summary> Gets or sets CodeVersion. The cluster code version. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.ConfigVersion"> <summary> Gets or sets ConfigVersion. The cluster configuration version. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.UpgradeKind"> <summary> Gets or sets UpgradeKind. The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.RollingUpgradeMode"> <summary> Gets or sets RollingUpgradeMode. The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored', 'UnmonitoredDeferred' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.UpgradeReplicaSetCheckTimeoutInSeconds"> <summary> Gets or sets UpgradeReplicaSetCheckTimeoutInSeconds. The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.ForceRestart"> <summary> Gets or sets ForceRestart. If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.SortOrder"> <summary> Gets or sets SortOrder. Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.FailureAction"> <summary> Gets or sets FailureAction. The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.HealthCheckWaitDurationInMilliseconds"> <summary> Gets or sets HealthCheckWaitDurationInMilliseconds. The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.HealthCheckStableDurationInMilliseconds"> <summary> Gets or sets HealthCheckStableDurationInMilliseconds. The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.HealthCheckRetryTimeoutInMilliseconds"> <summary> Gets or sets HealthCheckRetryTimeoutInMilliseconds. The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.UpgradeTimeoutInMilliseconds"> <summary> Gets or sets UpgradeTimeoutInMilliseconds. The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.UpgradeDomainTimeoutInMilliseconds"> <summary> Gets or sets UpgradeDomainTimeoutInMilliseconds. The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.MaxPercentUnhealthyNodes"> <summary> Gets or sets MaxPercentUnhealthyNodes. The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.MaxPercentUnhealthyApplications"> <summary> Gets or sets MaxPercentUnhealthyApplications. The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.ApplicationTypeHealthPolicyMap"> <summary> Gets or sets ApplicationTypeHealthPolicyMap. Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.NodeTypeHealthPolicyMap"> <summary> Gets or sets NodeTypeHealthPolicyMap. Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type. The node type health policy map can be used during cluster health evaluation to describe special node types. They are evaluated against the percentages associated with their node type name in the map. Setting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. The node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation. For example, given a cluster with many nodes of different types, with important work hosted on node type "SpecialNodeType" that should not tolerate any nodes down. You can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type "SpecialNodeType", set the MaxPercentUnhealthyNodes to 0 by setting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. This way, as long as no nodes of type "SpecialNodeType" are in Error state, even if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. A Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. But even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. Conversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, with one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.EnableDeltaHealthEvaluation"> <summary> Gets or sets EnableDeltaHealthEvaluation. When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.MaxPercentDeltaUnhealthyNodes"> <summary> Gets or sets MaxPercentDeltaUnhealthyNodes. The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.MaxPercentUpgradeDomainDeltaUnhealthyNodes"> <summary> Gets or sets MaxPercentUpgradeDomainDeltaUnhealthyNodes. The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.ApplicationHealthPolicyMap"> <summary> Gets or sets ApplicationHealthPolicyMap. The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.InstanceCloseDelayDurationInSeconds"> <summary> Gets or sets InstanceCloseDelayDurationInSeconds. Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.ValidateClusterUpgradeCmdlet.FormatOutput(System.Object)"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewMeshApplicationCmdlet"> <summary> Creates mesh application resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshApplicationCmdlet.ApplicationResourceName"> <summary> Gets or sets Application resource name to create. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshApplicationCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the application to be created. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshApplicationCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the application to be created. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewMeshApplicationCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewMeshGatewayCmdlet"> <summary> Creates mesh gateway resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshGatewayCmdlet.GatewayResourceName"> <summary> Gets or sets Gateway resource name to create. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshGatewayCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the gateway to be created. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshGatewayCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the gateway to be created. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewMeshGatewayCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewMeshNetworkCmdlet"> <summary> Creates mesh network resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshNetworkCmdlet.NetworkResourceName"> <summary> Gets or sets Network resource name to create. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshNetworkCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the network to be created. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshNetworkCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the network to be created. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewMeshNetworkCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretCmdlet"> <summary> Creates mesh secret resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretCmdlet.SecretResourceName"> <summary> Gets or sets Secret name to create. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the secret to be created. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the secret to be created. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretValueCmdlet"> <summary> Adds the specified value as a new version of the specified secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretValueCmdlet.SecretResourceName"> <summary> Gets or sets name of the secret resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretValueCmdlet.SecretValueResourceName"> <summary> Gets or sets name of the secret value resource. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretValueCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the secret value to be added. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretValueCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the secret value to be added. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewMeshSecretValueCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewMeshVolumeCmdlet"> <summary> Creates mesh volume resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshVolumeCmdlet.VolumeResourceName"> <summary> Gets or sets volume name to create. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshVolumeCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the volume to be created. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewMeshVolumeCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the volume to be created. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewMeshVolumeCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet"> <summary> Creates or updates a Service Fabric property. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.Binary"> <summary> Gets or sets Binary flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.Int64"> <summary> Gets or sets Int64 flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.Double"> <summary> Gets or sets Double flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.String"> <summary> Gets or sets String flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.Guid"> <summary> Gets or sets Guid flag </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.NameId"> <summary> Gets or sets NameId. The Service Fabric name, without the 'fabric:' URI scheme. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.PropertyName"> <summary> Gets or sets PropertyName. The name of the Service Fabric property. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.BinaryData"> <summary> Gets or sets Data. Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.Data"> <summary> Gets or sets Data. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.CustomTypeId"> <summary> Gets or sets CustomTypeId. The property's custom type ID. Using this property, the user is able to tag the type of the value of the property. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.NewPropertyCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.Resource"> <summary> A strongly-typed resource class, for looking up localized strings, etc. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.ResourceManager"> <summary> Returns the cached ResourceManager instance used by this class. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.Culture"> <summary> Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.CommonNameIssuerThumbprintMismatch"> <summary> Looks up a localized string similar to Count of ServerCommonNames must match count of IssuerCertThumbprints if provided.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.Error_MissingImageStoreConnectionStringArgument"> <summary> Looks up a localized string similar to Error_MissingImageStoreConnectionStringArgument. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.ErrorAAD"> <summary> Looks up a localized string similar to Error while getting access token from Azure Active Directory.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.ErrorIncorrectEndpointFormat"> <summary> Looks up a localized string similar to Format of connection endpoint is incorrect.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.ErrorLoadingClientCertificate"> <summary> Looks up a localized string similar to Unable to load client certificate based on provided inforamtion.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.ErrorNoServerCommonNameIrServerCertThumbprint"> <summary> Looks up a localized string similar to Connecting with IP Address. provide value for at least one of ServerCommonName or ServerCertThumbprint... </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.ErrorNotConnected"> <summary> Looks up a localized string similar to Not connected to Service Fabric cluster, please connect using Connect-SFCluster cmdlet before invoking this cmdlet.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.Info_ClusterConnectionAlreadyExisted"> <summary> Looks up a localized string similar to Cluster connection with the same name already existed, the old connection will be deleted. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.MsgAADSignin"> <summary> Looks up a localized string similar to Azure Active Directory sign in is required to get access token required to connect to cluster.. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.MsgAddProperty"> <summary> Looks up a localized string similar to Adding property: {0} to result. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.MsgConnectSuccess"> <summary> Looks up a localized string similar to Connected Successfully!. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.MsgCountAndContinuationToken"> <summary> Looks up a localized string similar to Count of data items retrieved:{0}; Continuation Token: {1}. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.MsgObjectTypeMismatch"> <summary> Looks up a localized string similar to Object is not of type {0}, rather it is: {1}. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.MsgPartitionInfo"> <summary> Looks up a localized string similar to Partition Info: {0}. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.MsgReplicaInfo"> <summary> Looks up a localized string similar to Replica Info: {0}. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.Resource.WarningInvalidResourceType"> <summary> Looks up a localized string similar to Invalid resource type: {0} found in the yaml description, skipping it.. </summary> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet"> <summary> Starts upgrading an application in the Service Fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.ApplicationId"> <summary> Gets or sets ApplicationId. The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.TargetApplicationTypeVersion"> <summary> Gets or sets TargetApplicationTypeVersion. The target application type version (found in the application manifest) for the application upgrade. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.Parameters"> <summary> Gets or sets Parameters. List of application parameters with overridden values from their default values specified in the application manifest. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.UpgradeKind"> <summary> Gets or sets UpgradeKind. The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.RollingUpgradeMode"> <summary> Gets or sets RollingUpgradeMode. The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.UpgradeReplicaSetCheckTimeoutInSeconds"> <summary> Gets or sets UpgradeReplicaSetCheckTimeoutInSeconds. The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.ForceRestart"> <summary> Gets or sets ForceRestart. If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.FailureAction"> <summary> Gets or sets FailureAction. The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.HealthCheckWaitDurationInMilliseconds"> <summary> Gets or sets HealthCheckWaitDurationInMilliseconds. The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.HealthCheckStableDurationInMilliseconds"> <summary> Gets or sets HealthCheckStableDurationInMilliseconds. The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.HealthCheckRetryTimeoutInMilliseconds"> <summary> Gets or sets HealthCheckRetryTimeoutInMilliseconds. The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.UpgradeTimeoutInMilliseconds"> <summary> Gets or sets UpgradeTimeoutInMilliseconds. The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.UpgradeDomainTimeoutInMilliseconds"> <summary> Gets or sets UpgradeDomainTimeoutInMilliseconds. The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.ConsiderWarningAsError"> <summary> Gets or sets ConsiderWarningAsError. Indicates whether warnings are treated with the same severity as errors. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.MaxPercentUnhealthyDeployedApplications"> <summary> Gets or sets MaxPercentUnhealthyDeployedApplications. The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.MaxPercentUnhealthyPartitionsPerService"> <summary> Gets or sets MaxPercentUnhealthyPartitionsPerService. The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.MaxPercentUnhealthyReplicasPerPartition"> <summary> Gets or sets MaxPercentUnhealthyReplicasPerPartition. The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.MaxPercentUnhealthyServices"> <summary> Gets or sets MaxPercentUnhealthyServices. The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.ServiceTypeHealthPolicyMap"> <summary> Gets or sets ServiceTypeHealthPolicyMap. The map with service type health policy per service type name. The map is empty by default. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.ServerTimeout"> <summary> Gets or sets ServerTimeout. The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.StartApplicationUpgradeCmdlet.ProcessRecordInternal"> <inheritdoc/> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.TestClusterConnectionCmdlet"> <summary> Cmdlet to test connection to Service Fabric cluster. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.TestClusterConnectionCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshApplicationCmdlet"> <summary> Updates mesh application resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshApplicationCmdlet.ApplicationResourceName"> <summary> Gets or sets Application name to update. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshApplicationCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the application to be updated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshApplicationCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the application to be updated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshApplicationCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshGatewayCmdlet"> <summary> Updates mesh gateway resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshGatewayCmdlet.GatewayResourceName"> <summary> Gets or sets Gateway name to update. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshGatewayCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the gateway to be updated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshGatewayCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the gateway to be updated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshGatewayCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshNetworkCmdlet"> <summary> Updates mesh network resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshNetworkCmdlet.NetworkResourceName"> <summary> Gets or sets network name to update. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshNetworkCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the network to be updated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshNetworkCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the network to be updated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshNetworkCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshSecretCmdlet"> <summary> Updates mesh secret resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshSecretCmdlet.SecretResourceName"> <summary> Gets or sets Secret name to update. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshSecretCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the secret to be updated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshSecretCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the secret to be updated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshSecretCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> <member name="T:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshVolumeCmdlet"> <summary> Updates mesh volume resource in service fabric cluster. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshVolumeCmdlet.VolumeResourceName"> <summary> Gets or sets volume name to create. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshVolumeCmdlet.JsonDescription"> <summary> Gets or sets the json containing the description of the volume to be updated. </summary> </member> <member name="P:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshVolumeCmdlet.ResourceDescriptionFile"> <summary> Gets or sets the Json resource file containing the description of the volume to be updated. </summary> </member> <member name="M:Microsoft.ServiceFabric.Powershell.Http.UpdateMeshVolumeCmdlet.ProcessRecordInternal"> <inheritdoc /> </member> </members> </doc> |