Skip to content

Commit

Permalink
[Service Fabrid] 8.2 spec (Azure#16498)
Browse files Browse the repository at this point in the history
* added SF 8.2 spec.

* fixed version in swagger.

* added additional examples and  fixed spelling mistakes.
  • Loading branch information
jeffj6123 authored and LeiWang3 committed Mar 31, 2022
1 parent 3b7277f commit ea34063
Show file tree
Hide file tree
Showing 153 changed files with 35,667 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"operationId": "BackupPartition",
"description": "This example shows how to trigger backup of a partition now, which is already configured for periodic backups. The newly created backup will be saved at the same location where the periodic backups are being saved.",
"parameters": {
"api-version": "6.4",
"partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"BackupPartitionDescription": {}
},
"responses": {
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"operationId": "BackupPartition",
"description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Azure blob storage account.",
"parameters": {
"api-version": "6.4",
"partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"BackupPartitionDescription": {
"BackupStorage": {
"StorageKind": "AzureBlobStore",
"ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
"ContainerName": "BackupContainer"
}
}
},
"responses": {
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"operationId": "BackupPartition",
"description": "This example shows how to trigger backup of a partition now, and save the backup to a specific file share accessible from all cluster nodes.",
"parameters": {
"api-version": "6.4",
"partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"BackupPartitionDescription": {
"BackupStorage": {
"StorageKind": "FileShare",
"Path": "\\\\myshare\\backupshare",
"PrimaryUserName": "mydomain\\backupaccount",
"PrimaryPassword": "password"
}
}
},
"responses": {
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"operationId": "BackupPartition",
"description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Dsms Azure blob storage location.",
"parameters": {
"api-version": "6.4",
"partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"BackupPartitionDescription": {
"BackupStorage": {
"StorageKind": "DsmsAzureBlobStore",
"StorageCredentialsSourceLocation": "https://sample-dsms.dsms.core.winows.net/dsms/samplecredentiallocation/storageaccounts/samplestorageac/servicefabricbackup/samplebackup",
"ContainerName": "BackupContainer"
}
}
},
"responses": {
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"operationId": "BackupPartition",
"description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Azure blob storage account using managed identity.",
"parameters": {
"api-version": "6.4",
"partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d",
"BackupPartitionDescription": {
"BackupStorage": {
"StorageKind": "ManagedIdentityAzureBlobStore",
"BlobServiceUri": "https://managedidentitytest.blob.core.windows.net/",
"ContainerName": "BackupContainer",
"ManagedIdentityType": "Cluster"
}
}
},
"responses": {
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"operationId": "CreateApplication",
"description": "This example shows how to create a Service Fabric application without overriding any application parameter values.",
"parameters": {
"api-version": "6.0",
"ApplicationDescription": {
"Name": "fabric:/samples/CalcApp",
"TypeVersion": "1.0",
"TypeName": "CalculatorApp"
}
},
"responses": {
"201": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"operationId": "CreateBackupPolicy",
"description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC which shall get deleted after 3 months, with Azure blob store as the backup location.",
"parameters": {
"api-version": "6.4",
"BackupPolicyDescription": {
"Name": "DailyAzureBackupPolicy",
"AutoRestoreOnDataLoss": false,
"MaxIncrementalBackups": 3,
"Schedule": {
"ScheduleKind": "TimeBased",
"ScheduleFrequencyType": "Daily",
"RunTimes": [
"0001-01-01T09:00:00Z",
"0001-01-01T17:00:00Z"
]
},
"Storage": {
"StorageKind": "AzureBlobStore",
"FriendlyName": "Azure_storagesample",
"ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<PutYourAccountKeyHere>",
"ContainerName": "BackupContainer"
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": 20,
"RetentionDuration": "P3M"
}
}
},
"responses": {
"201": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"operationId": "CreateBackupPolicy",
"description": "This example shows how to create a backup policy which takes backup every 10 minutes which shall get deleted after 20 days, with file share as the backup location.",
"parameters": {
"api-version": "6.4",
"BackupPolicyDescription": {
"Name": "FileShare10MinBackupPolicy",
"AutoRestoreOnDataLoss": false,
"MaxIncrementalBackups": 3,
"Schedule": {
"ScheduleKind": "FrequencyBased",
"Interval": "PT10M"
},
"Storage": {
"StorageKind": "FileShare",
"FriendlyName": "FileShare_myshare",
"Path": "\\\\myshare\\backupshare",
"PrimaryUserName": "backupaccount",
"PrimaryPassword": "password"
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": 20,
"RetentionDuration": "P20D"
}
}
},
"responses": {
"201": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"operationId": "CreateBackupPolicy",
"description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC which shall get deleted after 3 months, with Dsms Azure blob store as the backup location.",
"parameters": {
"api-version": "6.4",
"BackupPolicyDescription": {
"Name": "SampleDsmsBackupPolicy",
"AutoRestoreOnDataLoss": false,
"MaxIncrementalBackups": 3,
"Schedule": {
"ScheduleKind": "TimeBased",
"ScheduleFrequencyType": "Daily",
"RunTimes": [
"0001-01-01T09:00:00Z",
"0001-01-01T17:00:00Z"
]
},
"Storage": {
"StorageKind": "DsmsAzureBlobStore",
"FriendlyName": "DsmsAzure_storagesample",
"StorageCredentialsSourceLocation": "https://sample-dsms.dsms.core.winows.net/dsms/samplecredentiallocation/storageaccounts/samplestorageac/servicefabricbackup/samplebackup",
"ContainerName": "BackupContainer"
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": 20,
"RetentionDuration": "P3M"
}
}
},
"responses": {
"201": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"operationId": "CreateBackupPolicy",
"description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC which shall get deleted after 3 months, with Azure blob store as the backup location using managed identity.",
"parameters": {
"api-version": "6.4",
"BackupPolicyDescription": {
"Name": "DailyAzureMIBackupPolicy",
"AutoRestoreOnDataLoss": false,
"MaxIncrementalBackups": 3,
"Schedule": {
"ScheduleKind": "TimeBased",
"ScheduleFrequencyType": "Daily",
"RunTimes": [
"0001-01-01T09:00:00Z",
"0001-01-01T17:00:00Z"
]
},
"Storage": {
"StorageKind": "ManagedIdentityAzureBlobStore",
"FriendlyName": "AzureMI_storagesample",
"BlobServiceUri": "https://managedidentitytest.blob.core.windows.net/",
"ContainerName": "BackupContainer",
"ManagedIdentityType": "Cluster"
},
"RetentionPolicy": {
"RetentionPolicyType": "Basic",
"MinimumNumberOfBackups": 20,
"RetentionDuration": "P3M"
}
}
},
"responses": {
"201": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"operationId": "CreateName",
"description": "This example shows how to create a new Service Fabric name. The name can be created under an existing name that represents an appliction or a service or under a completely new name.",
"parameters": {
"api-version": "6.0",
"NameDescription": {
"Name": "fabric:/samples/CalculatorApp/CalculatorService/Name-1"
}
},
"responses": {
"201": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"operationId": "CreateService",
"description": "This example shows how to create a basic stateless Service Fabric service.",
"parameters": {
"applicationId": "test",
"api-version": "6.0",
"ServiceDescription": {
"ServiceKind": "Stateless",
"ApplicationName": "fabric:/test",
"ServiceName": "fabric:/test/test1",
"ServiceTypeName": "StatelessFrontendService",
"PartitionDescription": {
"PartitionScheme": "Singleton"
},
"InstanceCount": 4
}
},
"responses": {
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"operationId": "CreateService",
"description": "This example shows how to create a basic stateful Service Fabric service.",
"parameters": {
"applicationId": "test",
"api-version": "6.0",
"ServiceDescription": {
"ServiceKind": "Stateful",
"ApplicationName": "fabric:/test",
"ServiceName": "fabric:/test/test2",
"ServiceTypeName": "StatefulBackendService",
"PartitionDescription": {
"PartitionScheme": "Singleton"
},
"TargetReplicaSetSize": 3,
"MinReplicaSetSize": 2,
"HasPersistedState": false
}
},
"responses": {
"202": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"operationId": "CreateService",
"description": "This example shows how to create a stateless Service Fabric service with a dns name definied and auto scaling based on cpu usage.",
"parameters": {
"applicationId": "test",
"api-version": "6.0",
"ServiceDescription": {
"ServiceKind": "Stateless",
"ApplicationName": "fabric:/test",
"ServiceName": "fabric:/test/test1",
"ServiceTypeName": "StatelessFrontendService",
"InitializationData": [],
"PartitionDescription": {
"PartitionScheme": "Singleton"
},
"InstanceCount": 2,
"PlacementConstraints": "Color==Blue",
"CorrelationScheme": [],
"ServiceLoadMetrics": [],
"ServicePlacementPolicies": [],
"DefaultMoveCost": "Low",
"IsDefaultMoveCostSpecified": true,
"ServicePackageActivationMode": "ExclusiveProcess",
"ServiceDnsName": "test1.test",
"ScalingPolicies": [
{
"ScalingTrigger": {
"Kind": "AveragePartitionLoad",
"MetricName": "servicefabric:/_CpuCores",
"LowerLoadThreshold": "0.300000",
"UpperLoadThreshold": "0.800000",
"ScaleIntervalInSeconds": 600
},
"ScalingMechanism": {
"Kind": "PartitionInstanceCount",
"MinInstanceCount": 1,
"MaxInstanceCount": 6,
"ScaleIncrement": 2
}
}
]
}
},
"responses": {
"202": {}
}
}
Loading

0 comments on commit ea34063

Please sign in to comment.