forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Swagger specification for Service Fabric runtime version 6.4 (Azure#4591
) * Swagger specification for Service Fabric runtime version 6.4 * fix typos specificed -> specified, sucessful -> successful, resturns -> returns, commited -> committed, Double word "maximum", Double word "with" * typo: Parition to Partition * remove invalid character
- Loading branch information
1 parent
936edd5
commit cb47262
Showing
145 changed files
with
32,492 additions
and
3 deletions.
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
...rvicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-1.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
{ | ||
"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": { | ||
} | ||
} | ||
} |
19 changes: 19 additions & 0 deletions
19
...rvicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-2.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.", | ||
"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": { | ||
} | ||
} | ||
} |
20 changes: 20 additions & 0 deletions
20
...rvicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-3.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{ | ||
"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": "abcd1234" | ||
} | ||
} | ||
}, | ||
"responses": { | ||
"202": { | ||
} | ||
} | ||
} |
16 changes: 16 additions & 0 deletions
16
...icefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateApplication-1.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
{ | ||
"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": { | ||
} | ||
} | ||
} |
35 changes: 35 additions & 0 deletions
35
...cefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-1.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.", | ||
"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": { | ||
} | ||
} | ||
} |
32 changes: 32 additions & 0 deletions
32
...cefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-2.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"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": "abcd1234" | ||
}, | ||
"RetentionPolicy": { | ||
"RetentionPolicyType": "Basic", | ||
"MinimumNumberOfBackups": 20, | ||
"RetentionDuration": "P20D" | ||
} | ||
} | ||
}, | ||
"responses": { | ||
"201": { | ||
} | ||
} | ||
} |
14 changes: 14 additions & 0 deletions
14
...on/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateName-1.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"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": { | ||
} | ||
} | ||
} |
21 changes: 21 additions & 0 deletions
21
...servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-1.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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": {} | ||
} | ||
} |
23 changes: 23 additions & 0 deletions
23
...servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-2.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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": {} | ||
} | ||
} |
47 changes: 47 additions & 0 deletions
47
...servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-3.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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": {} | ||
} | ||
} |
44 changes: 44 additions & 0 deletions
44
...servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-4.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
{ | ||
"operationId": "CreateService", | ||
"description": "This example shows how to create a stateful Service Fabric service with named partitions and scaling enabled based on memory usage.", | ||
"parameters": { | ||
"applicationId": "test", | ||
"api-version": "6.0", | ||
"ServiceDescription": { | ||
"ServiceKind": "Stateful", | ||
"ApplicationName": "fabric:\/test", | ||
"ServiceName": "fabric:\/test\/test2", | ||
"ServiceTypeName": "StatefulBackendService", | ||
"InitializationData": [], | ||
"PartitionDescription": { | ||
"PartitionScheme": "NamedPartitionSchemeDescription", | ||
"Count" : 1, | ||
"Names" : ["0"] | ||
}, | ||
"TargetReplicaSetSize": 3, | ||
"MinReplicaSetSize" : 2, | ||
"HasPersistedState" : true, | ||
"ServicePackageActivationMode": "ExclusiveProcess", | ||
"ScalingPolicies": [ | ||
{ | ||
"ScalingTrigger": { | ||
"Kind": "AverageServiceLoad", | ||
"MetricName": "servicefabric:\/_MemoryInMB", | ||
"LowerLoadThreshold": 500, | ||
"UpperLoadThreshold": 900, | ||
"ScaleIntervalInSeconds": 600 | ||
}, | ||
"ScalingMechanism": { | ||
"Kind": "AddRemoveIncrementalNamedPartition", | ||
"MinPartitionCount": 1, | ||
"MaxPartitionCount": 3, | ||
"ScaleIncrement": 1 | ||
} | ||
} | ||
] | ||
} | ||
}, | ||
"responses": { | ||
"202": {} | ||
} | ||
} |
12 changes: 12 additions & 0 deletions
12
...vicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DeleteBackupPolicy.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"operationId": "DeleteBackupPolicy", | ||
"description": "This example shows how to delete an existing backup policy which is currently not associated with any backup entity.", | ||
"parameters": { | ||
"api-version": "6.4", | ||
"backupPolicyName": "SampleBackupPolicy" | ||
}, | ||
"responses": { | ||
"200": { | ||
} | ||
} | ||
} |
15 changes: 15 additions & 0 deletions
15
...bric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableApplicationBackup.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"operationId": "DisableApplicationBackup", | ||
"description": "This example shows how to disable periodic backup for a stateful application which was previously enabled.", | ||
"parameters": { | ||
"api-version": "6.4", | ||
"applicationId": "CalcApp", | ||
"DisableBackupDescription": { | ||
"CleanBackup": true | ||
} | ||
}, | ||
"responses": { | ||
"202": { | ||
} | ||
} | ||
} |
15 changes: 15 additions & 0 deletions
15
...fabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisablePartitionBackup.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"operationId": "DisablePartitionBackup", | ||
"description": "This example shows how to disable periodic backup for a stateful partition which was previously enabled.", | ||
"parameters": { | ||
"api-version": "6.4", | ||
"partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", | ||
"DisableBackupDescription": { | ||
"CleanBackup": false | ||
} | ||
}, | ||
"responses": { | ||
"202": { | ||
} | ||
} | ||
} |
15 changes: 15 additions & 0 deletions
15
...cefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableServiceBackup.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"operationId": "DisableServiceBackup", | ||
"description": "This example shows how to disable periodic backup for a stateful service which was previously enabled.", | ||
"parameters": { | ||
"api-version": "6.4", | ||
"serviceId": "CalcApp/CalcService", | ||
"DisableBackupDescription": { | ||
"CleanBackup": true | ||
} | ||
}, | ||
"responses": { | ||
"202": { | ||
} | ||
} | ||
} |
15 changes: 15 additions & 0 deletions
15
...abric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableApplicationBackup.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"operationId": "EnableApplicationBackup", | ||
"description": "This example shows how to enable periodic backup for a stateful application.", | ||
"parameters": { | ||
"api-version": "6.4", | ||
"applicationId": "CalcApp", | ||
"EnableBackupDescription": { | ||
"BackupPolicyName": "DailyAzureBackupPolicy" | ||
} | ||
}, | ||
"responses": { | ||
"202": { | ||
} | ||
} | ||
} |
Oops, something went wrong.